vRealize Orchestrator Server API Data Structures
AffectedField
JSON Example
{
"id": "string"
}string
id
Optional
id
AttributeType
JSON Example
{
"externalUrl": "string",
"readonly": "boolean",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}string
externalUrl
Optional
externalUrl
boolean
readonly
Optional
readonly
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
type
Optional
type
BaseConstraint
This data structure has no properties.
BaseDecorator
JSON Example
{
"kind": "string"
}string
kind
Optional
kind
BaseType
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
Bind
JSON Example
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}string
export-name
Optional
export-name
string
name
Optional
name
string
description
Optional
description
string
type
Optional
type
CertificateInfo
JSON Example
{
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
}string As date-time As date-time
notValidBefore
Optional
notValidBefore
boolean
identityCertificateExists
Optional
identityCertificateExists
string
issuerName
Optional
issuerName
string As date-time As date-time
notValidAfter
Optional
notValidAfter
string
thumbprint
Optional
thumbprint
string
principalName
Optional
principalName
Condition
JSON Example
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}string
comparator
Optional
comparator
string
name
Optional
name
string
label
Optional
label
string
type
Optional
type
string
value
Optional
value
Conditions
JSON Example
{
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
CreatePackageDetails
JSON Example
{
"description": "string",
"items": {
"configurations": [
"string"
],
"resources": [
"string"
],
"workflows": [
"string"
],
"policy-templates": [
"string"
],
"actions": [
"string"
]
}
}string
description
Optional
description
EnumType
JSON Example
{
"externalUrl": "string",
"values": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
ErrorHandler
JSON Example
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}string
name
Optional
name
string
throw-bind-name
Optional
throw-bind-name
EventType
JSON Example
{
"externalUrl": "string",
"minValue": "string",
"unit": "string",
"numberFormat": "string",
"maxValue": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"props": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}string
externalUrl
Optional
externalUrl
string
minValue
Optional
minValue
string
unit
Optional
unit
string
numberFormat
Optional
numberFormat
string
maxValue
Optional
maxValue
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
type
Optional
type
Field
JSON Example
{
"hidden": "boolean",
"decorators": [
{
"kind": "string"
}
],
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"affected-fields": [
{
"id": "string"
}
],
"id": "string",
"type": "string",
"constraints": [
{}
]
}boolean
hidden
Optional
hidden
string
display-name
Optional
display-name
string
description
Optional
description
string
id
Optional
id
string
type
Optional
type
ImportElementDetail
JSON Example
{
"serverObjectVersion": "string",
"fileObjectVersion": "string",
"hasTenantConflict": "boolean",
"importIt": "boolean",
"versionComparison": "string",
"fileCategory": "string",
"fileObjectName": "string",
"serverCategory": "string",
"id": "string",
"type": "string",
"serverObjectName": "string"
}string
serverObjectVersion
Optional
serverObjectVersion
string
fileObjectVersion
Optional
fileObjectVersion
boolean
hasTenantConflict
Optional
hasTenantConflict
boolean
importIt
Optional
importIt
string
versionComparison
Optional
versionComparison
string
fileCategory
Optional
fileCategory
string
fileObjectName
Optional
fileObjectName
string
serverCategory
Optional
serverCategory
string
id
Optional
id
string
type
Optional
type
string
serverObjectName
Optional
serverObjectName
ImportPackageDetails
JSON Example
{
"certificateTrusted": "boolean",
"packageAlreadyExists": "boolean",
"certificateValid": "boolean",
"certificateUnknown": "boolean",
"contentVerified": "boolean",
"packageName": "string",
"certificateInfo": {
"commonName": "string",
"country": "string",
"serialNumber": "string",
"fingerprintSHA1": "string",
"publicKeyAlgorithm": "string",
"organization": "string",
"validFromDate": "string",
"validUntilDate": "string",
"organizationalUnit": "string"
},
"importElementDetails": [
{
"serverObjectVersion": "string",
"fileObjectVersion": "string",
"hasTenantConflict": "boolean",
"importIt": "boolean",
"versionComparison": "string",
"fileCategory": "string",
"fileObjectName": "string",
"serverCategory": "string",
"id": "string",
"type": "string",
"serverObjectName": "string"
}
]
}boolean
certificateTrusted
Optional
certificateTrusted
boolean
packageAlreadyExists
Optional
packageAlreadyExists
boolean
certificateValid
Optional
certificateValid
boolean
certificateUnknown
Optional
certificateUnknown
boolean
contentVerified
Optional
contentVerified
string
packageName
Optional
packageName
InBinding
JSON Example
{
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
}
Input
JSON Example
{
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
}
IterationCatchBlock
JSON Example
{
"script": {
"value": "string",
"encoded": "boolean"
}
}
Link
JSON Example
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}string
rel
Optional
rel
string
href
Optional
href
string
type
Optional
type
MemberType
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
type
Optional
type
MethodType
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
type
Optional
type
ObjectType
JSON Example
{
"externalUrl": "string",
"constructors": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"isNamespace": "boolean",
"methods": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"members": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"attributes": [
{
"externalUrl": "string",
"readonly": "boolean",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"state": "string",
"events": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
]
}string
externalUrl
Optional
externalUrl
boolean
isNamespace
Optional
isNamespace
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
OutBinding
JSON Example
{
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
}
Output
JSON Example
{
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
}
PGroup
JSON Example
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
PParam
JSON Example
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
PQual
JSON Example
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}string
kind
Optional
kind
string
name
Optional
name
string
type
Optional
type
string
value
Optional
value
PStep
JSON Example
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
PackageCertificateInfo
JSON Example
{
"commonName": "string",
"country": "string",
"serialNumber": "string",
"fingerprintSHA1": "string",
"publicKeyAlgorithm": "string",
"organization": "string",
"validFromDate": "string",
"validUntilDate": "string",
"organizationalUnit": "string"
}string
commonName
Optional
commonName
string
country
Optional
country
string
serialNumber
Optional
serialNumber
string
fingerprintSHA1
Optional
fingerprintSHA1
string
publicKeyAlgorithm
Optional
publicKeyAlgorithm
string
organization
Optional
organization
string As date-time As date-time
validFromDate
Optional
validFromDate
string As date-time As date-time
validUntilDate
Optional
validUntilDate
string
organizationalUnit
Optional
organizationalUnit
PackageItemDetails
JSON Example
{
"configurations": [
"string"
],
"resources": [
"string"
],
"workflows": [
"string"
],
"policy-templates": [
"string"
],
"actions": [
"string"
]
}array of string
configurations
Optional
configurations
array of string
resources
Optional
resources
array of string
workflows
Optional
workflows
array of string
policy-templates
Optional
policy-templates
array of string
actions
Optional
actions
Parameter
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"position": "integer",
"type": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
integer As int32 As int32
position
Optional
position
string
type
Optional
type
PluginBundleMetadata
JSON Example
{
"infoText": "string",
"hasInstallActions": "boolean",
"displayName": "string",
"moduleName": "string",
"hasValidation": "boolean",
"version": "string",
"buildNumber": "integer",
"url": "string",
"enabled": "boolean",
"configurable": "boolean"
}string
infoText
Optional
infoText
boolean
hasInstallActions
Optional
hasInstallActions
string
displayName
Optional
displayName
string
moduleName
Optional
moduleName
boolean
hasValidation
Optional
hasValidation
string
version
Optional
version
integer As int64 As int64
buildNumber
Optional
buildNumber
string
url
Optional
url
boolean
enabled
Optional
enabled
boolean
configurable
Optional
configurable
Position
JSON Example
{
"x": "number",
"y": "number"
}number As double As double
x
Optional
x
number As double As double
y
Optional
y
Presentation
JSON Example
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
PresentationElement
JSON Example
{
"hidden": "boolean",
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"id": "string"
}boolean
hidden
Optional
hidden
string
display-name
Optional
display-name
string
description
Optional
description
string
id
Optional
id
PresentationMessageInfo
JSON Example
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}string
severity
Optional
severity
string
Details
Optional
Details
string
code
Optional
code
string
Summary
Required
Summary
PrimaryField
JSON Example
{
"hidden": "boolean",
"decorators": [
{
"kind": "string"
}
],
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"affected-fields": [
{
"id": "string"
}
],
"id": "string",
"fields": [
{
"hidden": "boolean",
"decorators": [
{
"kind": "string"
}
],
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"affected-fields": [
{
"id": "string"
}
],
"id": "string",
"type": "string",
"constraints": [
{}
]
}
],
"type": "string",
"value": {
"objectType": "string"
},
"constraints": [
{}
]
}boolean
hidden
Optional
hidden
string
display-name
Optional
display-name
string
description
Optional
description
string
id
Optional
id
string
type
Optional
type
Reference
JSON Example
{
"id": "string",
"type": "string"
}string
id
Optional
id
string
type
Optional
type
Relations
JSON Example
{
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
Script
JSON Example
{
"value": "string",
"encoded": "boolean"
}string
value
Optional
value
boolean
encoded
Optional
encoded
ScriptModuleCategory
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"actionsCount": "integer",
"detailsLink": "string",
"state": "string",
"id": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
integer As int32 As int32
actionsCount
Optional
actionsCount
string
detailsLink
Optional
detailsLink
string
state
Optional
state
string
id
Optional
id
ScriptModuleType
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"id": "string",
"resultType": "string",
"version": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"position": "integer",
"type": "string"
}
],
"categoryId": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
id
Optional
id
string
resultType
Optional
resultType
string
version
Optional
version
string
categoryId
Optional
categoryId
SdkModuleType
JSON Example
{
"externalUrl": "string",
"build": "integer",
"icon": "string",
"name": "string",
"description": "string",
"detailsLink": "string",
"state": "string",
"version": "string"
}string
externalUrl
Optional
externalUrl
integer As int64 As int64
build
Optional
build
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
detailsLink
Optional
detailsLink
string
state
Optional
state
string
version
Optional
version
SdkType
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"scriptObject": "string",
"state": "string",
"events": [
{
"externalUrl": "string",
"minValue": "string",
"unit": "string",
"numberFormat": "string",
"maxValue": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"props": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"props": [
"string"
]
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
scriptObject
Optional
scriptObject
string
state
Optional
state
array of string
props
Optional
props
ServiceRegistryStatus
JSON Example
{
"serviceInitializationStatus": "string",
"defaultServiceEndpointType": "string",
"startedTime": "string",
"solutionUser": "string",
"sslCertificateInfo": {
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
},
"errorMessage": "string",
"initialized": "boolean",
"serviceName": "string",
"identityCertificateInfo": {
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
},
"serviceRegistrationId": "string"
}string
serviceInitializationStatus
Optional
serviceInitializationStatus
string
defaultServiceEndpointType
Optional
defaultServiceEndpointType
string As date-time As date-time
startedTime
Optional
startedTime
string
solutionUser
Optional
solutionUser
string
errorMessage
Optional
errorMessage
boolean
initialized
Optional
initialized
string
serviceName
Optional
serviceName
string
serviceRegistrationId
Optional
serviceRegistrationId
StepInfo
JSON Example
{
"hidden": "boolean",
"display-name": "string",
"elements": [
{
"hidden": "boolean",
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"id": "string"
}
],
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"readOnly": "boolean",
"id": "string"
}boolean
hidden
Optional
hidden
string
display-name
Optional
display-name
string
description
Optional
description
boolean
readOnly
Optional
readOnly
string
id
Optional
id
SystemTypes
JSON Example
{
"externalUrl": "string",
"enums": [
{
"externalUrl": "string",
"values": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"types": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"scriptObject": "string",
"state": "string",
"events": [
{
"externalUrl": "string",
"minValue": "string",
"unit": "string",
"numberFormat": "string",
"maxValue": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"props": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"props": [
"string"
]
}
],
"plugins": [
{
"externalUrl": "string",
"build": "integer",
"icon": "string",
"name": "string",
"description": "string",
"detailsLink": "string",
"state": "string",
"version": "string"
}
],
"objects": [
{
"externalUrl": "string",
"constructors": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"isNamespace": "boolean",
"methods": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"members": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"attributes": [
{
"externalUrl": "string",
"readonly": "boolean",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"state": "string",
"events": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
]
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
UpdatePackageDetails
JSON Example
{
"name": "string",
"description": "string",
"items": {
"configurations": [
"string"
],
"resources": [
"string"
],
"workflows": [
"string"
],
"policy-templates": [
"string"
],
"actions": [
"string"
]
},
"add-items": {
"configurations": [
"string"
],
"resources": [
"string"
],
"workflows": [
"string"
],
"policy-templates": [
"string"
],
"actions": [
"string"
]
},
"delete-items": {
"configurations": [
"string"
],
"resources": [
"string"
],
"workflows": [
"string"
],
"policy-templates": [
"string"
],
"actions": [
"string"
]
}
}string
name
Optional
name
string
description
Optional
description
UsedPlugin
JSON Example
{
"name": "string",
"server-version": "string",
"version": "string"
}string
name
Optional
name
string
server-version
Optional
server-version
string
version
Optional
version
Value
JSON Example
{
"objectType": "string"
}string
objectType
Optional
objectType
WorkflowItem
JSON Example
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}string
end-mode
Optional
end-mode
string
color
Optional
color
string
description
Optional
description
string
type
Optional
type
string
out-name
Optional
out-name
string
prototype-id
Optional
prototype-id
string
catch-name
Optional
catch-name
string
alt-out-name
Optional
alt-out-name
string
throw-bind-name
Optional
throw-bind-name
string
business-status
Optional
business-status
string
launched-workflow-id
Optional
launched-workflow-id
string
content-mode
Optional
content-mode
string
script-module
Optional
script-module
string
linked-workflow-id
Optional
linked-workflow-id
integer As int32 As int32
comparator
Optional
comparator
string
display-name
Optional
display-name
string
name
Optional
name
string
interaction
Optional
interaction
WorkflowNote
JSON Example
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}string
color
Optional
color
number As double As double
w
Optional
w
number As double As double
x
Optional
x
number As double As double
h
Optional
h
string
description
Optional
description
number As double As double
y
Optional
y
WorkflowSubelement
JSON Example
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}string
display-name
Optional
display-name
string
name
Optional
name
string
linked-workflow-id
Optional
linked-workflow-id
WorkflowSubelementsList
JSON Example
{
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
}
WsAttribute
JSON Example
{
"displayValue": "string",
"name": "string",
"value": "string"
}string
displayValue
Optional
displayValue
string
name
Optional
name
string
value
Optional
value
WsAttributeMetadata
JSON Example
{
"display-name": "string",
"name": "string",
"description": "string",
"possible-result-type": "string"
}string
display-name
Optional
display-name
string
name
Optional
name
string
description
Optional
description
string
possible-result-type
Optional
possible-result-type
WsAuthorizedEntity
JSON Example
{
"role": "string",
"domain": "string",
"name": "string",
"id": "string",
"type": "string"
}string
role
Optional
role
string
domain
Optional
domain
string
name
Optional
name
string
id
Optional
id
string
type
Optional
type
WsDetails
JSON Example
{
"value": "integer",
"key": "string"
}integer As int64 As int64
value
Optional
value
string
key
Optional
key
WsLog
JSON Example
{
"time-stamp": "string",
"severity": "string",
"long-description": "string",
"short-description": "string",
"user": "string"
}string As date-time As date-time
time-stamp
Optional
time-stamp
string
severity
Optional
severity
string
long-description
Optional
long-description
string
short-description
Optional
short-description
string
user
Optional
user
WsPolicyEventSource
This data structure has no properties.
WsProfilerOptions
JSON Example
{
"debuggerEnabled": "boolean",
"enabled": "boolean"
}boolean
debuggerEnabled
Optional
debuggerEnabled
boolean
enabled
Optional
enabled
WsRelationMetadata
JSON Example
{
"display-name": "string",
"name": "string",
"type": "string"
}string
display-name
Optional
display-name
string
name
Optional
name
string
type
Optional
type
WsSysLog
JSON Example
{
"time-stamp": "string",
"time-stamp-val": "integer",
"severity": "string",
"origin": "string",
"long-description": "string",
"short-description": "string",
"user": "string"
}string As date-time As date-time
time-stamp
Optional
time-stamp
integer As int64 As int64
time-stamp-val
Optional
time-stamp-val
string
severity
Optional
severity
string
origin
Optional
origin
string
long-description
Optional
long-description
string
short-description
Optional
short-description
string
user
Optional
user
WsTypeMetadata
JSON Example
{
"icon-href": "string",
"name": "string",
"attribute": [
{
"display-name": "string",
"name": "string",
"description": "string",
"possible-result-type": "string"
}
],
"relation": [
{
"display-name": "string",
"name": "string",
"type": "string"
}
]
}string
icon-href
Optional
icon-href
string
name
Optional
name
WsValidationMessage
JSON Example
{
"owner": "string",
"severity": "string",
"text": "string",
"title": "string"
}string
owner
Optional
owner
string
severity
Optional
severity
string
text
Optional
text
string
title
Optional
title
WsWorkflowExecutionStackItem
JSON Example
{
"displayName": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"name": "string",
"workflowDisplayName": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}
about-info
JSON Example
{
"api-version": "string",
"build-date": "string",
"build-number": "string",
"feature": [
{
"name": "string"
}
],
"version": "string"
}string
api-version
Optional
api-version
string
build-date
Optional
build-date
string
build-number
Optional
build-number
string
version
Optional
version
action
JSON Example
{
"fqn": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"module": "string",
"name": "string",
"description": "string",
"output-type": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"version": "string",
"script": "string"
}string
fqn
Optional
fqn
string As ^[\p{L}_]+(\.[\p{L}0-9_]+)*$
module
Required
module
string As ^[\p{L}_$][\p{L}0-9_$]*$
name
Required
name
string
description
Optional
description
string
output-type
Optional
output-type
string
href
Optional
href
string
id
Optional
id
string
version
Optional
version
string
script
Optional
script
actions
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
activity-statistics
JSON Example
{
"total-time": "integer",
"number-of-executions": "integer",
"max-time": "integer",
"activities": [
"activity-statistics Object"
],
"number-of-transitions": "integer",
"id": "string"
}integer As int64 As int64
total-time
Optional
total-time
integer As int64 As int64
number-of-executions
Optional
number-of-executions
integer As int64 As int64
max-time
Optional
max-time
integer As int64 As int64
number-of-transitions
Optional
number-of-transitions
string
id
Optional
id
api-types
JSON Example
{
"system": {
"externalUrl": "string",
"enums": [
{
"externalUrl": "string",
"values": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"types": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"scriptObject": "string",
"state": "string",
"events": [
{
"externalUrl": "string",
"minValue": "string",
"unit": "string",
"numberFormat": "string",
"maxValue": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"props": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"props": [
"string"
]
}
],
"plugins": [
{
"externalUrl": "string",
"build": "integer",
"icon": "string",
"name": "string",
"description": "string",
"detailsLink": "string",
"state": "string",
"version": "string"
}
],
"objects": [
{
"externalUrl": "string",
"constructors": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"isNamespace": "boolean",
"methods": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"members": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"attributes": [
{
"externalUrl": "string",
"readonly": "boolean",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"state": "string",
"events": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
]
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
},
"scriptCategories": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"actionsCount": "integer",
"detailsLink": "string",
"state": "string",
"id": "string"
}
],
"plugins": [
{
"externalUrl": "string",
"build": "integer",
"icon": "string",
"name": "string",
"description": "string",
"detailsLink": "string",
"state": "string",
"version": "string"
}
]
}
authorization-group
JSON Example
{
"protectedResources": [
{
"id": "string",
"type": "string"
}
],
"authorizedEntities": [
{
"role": "string",
"domain": "string",
"name": "string",
"id": "string",
"type": "string"
}
],
"description": "string",
"id": "string",
"label": "string"
}string
description
Optional
description
string
id
Optional
id
string
label
Optional
label
Parameter To
breakpoint
JSON Example
{
"active": "boolean",
"lineNumber": "integer",
"workflowId": "string",
"elementName": "string"
}boolean
active
Required
active
integer As int32 As int32
lineNumber
Required
lineNumber
string
workflowId
Required
workflowId
string
elementName
Required
elementName
breakpoints
JSON Example
{
"breakpoints": [
{
"active": "boolean",
"lineNumber": "integer",
"workflowId": "string",
"elementName": "string"
}
]
}
categories
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
category
JSON Example
{
"path": "string",
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"type": "string"
}string
path
Optional
path
string
name
Optional
name
string
description
Optional
description
string
href
Optional
href
string
id
Optional
id
string
type
Optional
type
category-context
JSON Example
{
"name": "string",
"description": "string",
"type": "string"
}string
name
Optional
name
string
description
Optional
description
string
type
Optional
type
category-details
JSON Example
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"id": "string",
"actions": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"id": "string",
"resultType": "string",
"version": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"position": "integer",
"type": "string"
}
],
"categoryId": "string"
}
]
}string
externalUrl
Optional
externalUrl
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
id
Optional
id
config-entries
JSON Example
{
"config-entry": [
{
"plugin": "boolean",
"data": "string",
"displayName": "string",
"name": "string",
"tooltip": "string",
"description": "string",
"remote": "boolean",
"title": "string",
"enabled": "boolean",
"dependencies": "string"
}
]
}
configEntry
JSON Example
{
"plugin": "boolean",
"data": "string",
"displayName": "string",
"name": "string",
"tooltip": "string",
"description": "string",
"remote": "boolean",
"title": "string",
"enabled": "boolean",
"dependencies": "string"
}boolean
plugin
Optional
plugin
string
data
Optional
data
string
displayName
Optional
displayName
string
name
Optional
name
string
tooltip
Optional
tooltip
string
description
Optional
description
boolean
remote
Optional
remote
string
title
Optional
title
boolean
enabled
Optional
enabled
string
dependencies
Optional
dependencies
configuration
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"href": "string",
"attribute": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"version": "string"
}
configurations
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
debug-location
JSON Example
{
"workflowTokenId": "string",
"lineNumber": "integer",
"dunesObjectType": "string",
"suspended": "boolean",
"dunesObjectId": "string",
"elementName": "string"
}string
workflowTokenId
Required
workflowTokenId
integer As int32 As int32
lineNumber
Required
lineNumber
string
dunesObjectType
Required
dunesObjectType
boolean
suspended
Required
suspended
string
dunesObjectId
Required
dunesObjectId
string
elementName
Required
elementName
descriptor
JSON Example
{
"description": "string",
"href": "string"
}string
description
Optional
description
string
href
Optional
href
evaluate
JSON Example
{
"scripts": [
"string"
]
}array of string
scripts
Optional
scripts
event-handler
JSON Example
{
"eventId": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}string
eventId
Optional
eventId
number As double As double
min-value
Optional
min-value
string
description
Optional
description
string
type
Optional
type
string
script
Optional
script
number As double As double
max-value
Optional
max-value
execution
JSON Example
{
"valid": "boolean",
"name": "string",
"description": "string",
"start-date": "string",
"href": "string",
"id": "string",
"started-by": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"object-id": "string",
"steps": [
{
"hidden": "boolean",
"display-name": "string",
"elements": [
{
"hidden": "boolean",
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"id": "string"
}
],
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"readOnly": "boolean",
"id": "string"
}
],
"parameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
}boolean
valid
Optional
valid
string
name
Optional
name
string
description
Optional
description
string As date-time As date-time
start-date
Optional
start-date
string
href
Optional
href
string
id
Optional
id
string
started-by
Optional
started-by
string
object-id
Optional
object-id
execution-context
JSON Example
{
"executionId": "string",
"profilerOptions": {
"debuggerEnabled": "boolean",
"enabled": "boolean"
},
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
}string
executionId
Optional
executionId
executions
JSON Example
{
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}string
href
Optional
href
feature
JSON Example
{
"name": "string"
}string
name
Optional
name
health-status
JSON Example
{
"description": "string",
"state": "string",
"time": "integer",
"childs": [
{
"name": "string",
"description": "string",
"isCritical": "boolean",
"state": "string",
"message": "string"
}
]
}string
description
Optional
description
string
state
Optional
state
integer As int64 As int64
time
Optional
time
health-status-provider
JSON Example
{
"name": "string",
"description": "string",
"isCritical": "boolean",
"state": "string",
"message": "string"
}string
name
Optional
name
string
description
Optional
description
boolean
isCritical
Optional
isCritical
string
state
Optional
state
string
message
Optional
message
interactions
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
inventory-item
JSON Example
{
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}string
href
Optional
href
inventory-items
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
logs
JSON Example
{
"logs": [
{
"time-stamp": "string",
"severity": "string",
"long-description": "string",
"short-description": "string",
"user": "string"
}
]
}
module-metadata
JSON Example
{
"namespace": "string",
"type": [
{
"icon-href": "string",
"name": "string",
"attribute": [
{
"display-name": "string",
"name": "string",
"description": "string",
"possible-result-type": "string"
}
],
"relation": [
{
"display-name": "string",
"name": "string",
"type": "string"
}
]
}
]
}string
namespace
Optional
namespace
node-status
JSON Example
{
"health-status": {
"description": "string",
"state": "string",
"time": "integer",
"childs": [
{
"name": "string",
"description": "string",
"isCritical": "boolean",
"state": "string",
"message": "string"
}
]
},
"instance-id": "string",
"state": "string"
}string
instance-id
Optional
instance-id
string
state
Optional
state
o11n-types
JSON Example
{
"o11n-type": [
{
"ret": "boolean",
"in": "boolean",
"name": "string",
"attr": "boolean",
"out": "boolean"
}
]
}
o11nType
JSON Example
{
"ret": "boolean",
"in": "boolean",
"name": "string",
"attr": "boolean",
"out": "boolean"
}boolean
ret
Optional
ret
boolean
in
Optional
in
string
name
Optional
name
boolean
attr
Optional
attr
boolean
out
Optional
out
owners
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
package-details
JSON Example
{
"policyTemplates": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"usedPlugins": [
{
"name": "string",
"server-version": "string",
"version": "string"
}
],
"configurations": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"name": "string",
"resources": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"description": "string",
"workflows": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"id": "string",
"href": "string",
"actions": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
string
href
Optional
href
packages
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
parameter
JSON Example
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}string
scope
Optional
scope
string As ^[\p{L}_$][\p{L}0-9_$]*$
name
Required
name
boolean
encrypt-value
Optional
encrypt-value
string
description
Optional
description
string
type
Optional
type
boolean
updated
Optional
updated
permission
JSON Example
{
"principal": "string",
"rights": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}string
principal
Optional
principal
string
rights
Optional
rights
string
href
Optional
href
permissions
JSON Example
{
"permissions": [
{
"principal": "string",
"rights": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}
]
}
Parameter To
plugin-details
JSON Example
{
"externalUrl": "string",
"enums": [
{
"externalUrl": "string",
"values": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
],
"types": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"scriptObject": "string",
"state": "string",
"events": [
{
"externalUrl": "string",
"minValue": "string",
"unit": "string",
"numberFormat": "string",
"maxValue": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"props": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"props": [
"string"
]
}
],
"build": "integer",
"objects": [
{
"externalUrl": "string",
"constructors": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"isNamespace": "boolean",
"methods": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string",
"parameters": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
]
}
],
"members": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"icon": "string",
"name": "string",
"description": "string",
"attributes": [
{
"externalUrl": "string",
"readonly": "boolean",
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"type": "string"
}
],
"state": "string",
"events": [
{
"externalUrl": "string",
"icon": "string",
"name": "string",
"description": "string",
"state": "string"
}
]
}
],
"icon": "string",
"name": "string",
"description": "string",
"state": "string",
"version": "string"
}string
externalUrl
Optional
externalUrl
integer As int64 As int64
build
Optional
build
string
icon
Optional
icon
string
name
Optional
name
string
description
Optional
description
string
state
Optional
state
string
version
Optional
version
plugin-statistics
JSON Example
{
"total-time": "integer",
"number-of-executions": "integer",
"details": [
{
"value": "integer",
"key": "string"
}
],
"plugin-name": "string"
}integer As int64 As int64
total-time
Optional
total-time
integer As int64 As int64
number-of-executions
Optional
number-of-executions
string
plugin-name
Optional
plugin-name
plugins
JSON Example
{
"total": "integer",
"plugin": [
{
"infoText": "string",
"hasInstallActions": "boolean",
"displayName": "string",
"moduleName": "string",
"hasValidation": "boolean",
"version": "string",
"buildNumber": "integer",
"url": "string",
"enabled": "boolean",
"configurable": "boolean"
}
]
}integer As int32 As int32
total
Optional
total
policy
JSON Example
{
"policy-item": [
{
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
]
}
],
"startup": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
],
"href": "string",
"state": "string",
"id": "string",
"started-by": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"priority": "string"
}string
startup
Optional
startup
string
name
Required
name
string
description
Optional
description
string
href
Optional
href
string
state
Optional
state
string
id
Optional
id
string
started-by
Optional
started-by
string
priority
Optional
priority
policy-item
JSON Example
{
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
]
}string
name
Optional
name
string
description
Optional
description
policy-list
JSON Example
{
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}string
href
Optional
href
policy-template
JSON Example
{
"policy-item": [
{
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
]
}
],
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
],
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"version": "string"
}string
name
Required
name
string
description
Optional
description
string
href
Optional
href
string
id
Optional
id
string
version
Optional
version
policy-templates
JSON Example
{
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
presentation
JSON Example
{
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"steps": [
{
"hidden": "boolean",
"display-name": "string",
"elements": [
{
"hidden": "boolean",
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"id": "string"
}
],
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"readOnly": "boolean",
"id": "string"
}
],
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
}string
name
Optional
name
string
description
Optional
description
string
href
Optional
href
string
id
Optional
id
resource-ref
JSON Example
{
"id": "string",
"type": "string"
}string
id
Optional
id
string
type
Optional
type
resources
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
schema-workflow
JSON Example
{
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
}string
api-version
Optional
api-version
string
icon-id
Optional
icon-id
string
object-name
Optional
object-name
string
schemaLocation
Optional
schemaLocation
string
description
Required
description
string
version
Optional
version
string
ref-types
Required
ref-types
string
allowed-operations
Optional
allowed-operations
integer As int32 As int32
restartMode
Optional
restartMode
integer As int32 As int32
resumeFromFailedMode
Optional
resumeFromFailedMode
string
display-name
Required
display-name
string
root-name
Optional
root-name
string
id
Optional
id
server-authentication
JSON Example
{
"mode": "string",
"url": "string"
}string
mode
Optional
mode
string
url
Optional
url
server-object
JSON Example
{
"sslCertificate": {
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
},
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}string
href
Optional
href
service-descriptors
JSON Example
{
"service": [
{
"description": "string",
"href": "string"
}
]
}
state
JSON Example
{
"value": "string"
}string
value
Optional
value
state-context
JSON Example
{
"enabled": "boolean"
}boolean
enabled
Optional
enabled
supported-versions
JSON Example
{
"version": [
{
"value": "string",
"latest": "boolean"
}
]
}
sys-logs
JSON Example
{
"logs": [
{
"time-stamp": "string",
"time-stamp-val": "integer",
"severity": "string",
"origin": "string",
"long-description": "string",
"short-description": "string",
"user": "string"
}
]
}
tag-instance
JSON Example
{
"owner": "string",
"name": "string",
"global": "boolean",
"href": "string",
"objectHref": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"value": "string"
}string
owner
Optional
owner
string
name
Required
name
boolean
global
Optional
global
string
href
Optional
href
string
objectHref
Optional
objectHref
string
value
Optional
value
tag-instances
JSON Example
{
"tag": [
{
"owner": "string",
"name": "string",
"global": "boolean",
"href": "string",
"objectHref": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"value": "string"
}
]
}
tags
JSON Example
{
"total": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": "integer"
}integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
task
JSON Example
{
"recurrence-pattern": "string",
"workflow": {
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
},
"description": "string",
"recurrence-cycle": "string",
"recurrence-start-date": "string",
"recurrence-end-date": "string",
"start-mode": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"name": "string",
"href": "string",
"id": "string",
"state": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"user": "string"
}string
recurrence-pattern
Optional
recurrence-pattern
string
description
Optional
description
string
recurrence-cycle
Optional
recurrence-cycle
string As date-time As date-time
recurrence-start-date
Required
recurrence-start-date
string As date-time As date-time
recurrence-end-date
Optional
recurrence-end-date
string
start-mode
Optional
start-mode
string
name
Optional
name
string
href
Optional
href
string
id
Optional
id
string
state
Optional
state
string
user
Optional
user
task-data
JSON Example
{
"recurrence-start-date": "string",
"recurrence-end-date": "string",
"recurrence-pattern": "string",
"start-mode": "string",
"name": "string",
"description": "string",
"recurrence-cycle": "string",
"id": "string",
"state": "string"
}string As date-time As date-time
recurrence-start-date
Optional
recurrence-start-date
string As date-time As date-time
recurrence-end-date
Optional
recurrence-end-date
string
recurrence-pattern
Optional
recurrence-pattern
string
start-mode
Optional
start-mode
string
name
Optional
name
string
description
Optional
description
string
recurrence-cycle
Optional
recurrence-cycle
string
id
Optional
id
string
state
Optional
state
tasks
JSON Example
{
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}string
href
Optional
href
user
JSON Example
{
"admin-rights": "boolean",
"solution-user": "string",
"user-group": [
{
"display-name": "string",
"dn": "string",
"cn": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"email": "string",
"info": "string",
"sid": "string"
}
],
"solution-user-domain": "string"
}boolean
admin-rights
Optional
admin-rights
string
solution-user
Optional
solution-user
string
solution-user-domain
Optional
solution-user-domain
user-group
JSON Example
{
"display-name": "string",
"dn": "string",
"cn": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"email": "string",
"info": "string",
"sid": "string"
}string
display-name
Optional
display-name
string
dn
Optional
dn
string
cn
Optional
cn
string
href
Optional
href
string
email
Optional
string
info
Optional
info
string
sid
Optional
sid
user-groups
JSON Example
{
"partial-result": "boolean",
"groups": [
{
"display-name": "string",
"dn": "string",
"cn": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"email": "string",
"info": "string",
"sid": "string"
}
]
}boolean
partial-result
Optional
partial-result
user-interaction
JSON Example
{
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"name": "string",
"href": "string",
"assignee": [
"string"
],
"state": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}
validation-messages
JSON Example
{
"messages": [
{
"owner": "string",
"severity": "string",
"text": "string",
"title": "string"
}
]
}
variables
JSON Example
{
"variables": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
}
version
JSON Example
{
"value": "string",
"latest": "boolean"
}string
value
Optional
value
boolean
latest
Optional
latest
workflow
JSON Example
{
"customized-icon": "boolean",
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": "boolean"
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": "boolean"
},
"linked-workflow-id": "string",
"comparator": "integer",
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": "integer",
"resumeFromFailedMode": "integer",
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
}boolean
customized-icon
Optional
customized-icon
string
name
Optional
name
string
description
Optional
description
string
href
Optional
href
string
id
Optional
id
string
version
Optional
version
workflow-execution
JSON Example
{
"statistic": {
"total-time": "integer",
"token-blocked": "integer",
"token-system": "integer",
"token-user": "integer",
"token-wait": "integer",
"activities": [
{
"total-time": "integer",
"number-of-executions": "integer",
"max-time": "integer",
"activities": [
"activity-statistics Object"
],
"number-of-transitions": "integer",
"id": "string"
}
],
"plugins": [
{
"total-time": "integer",
"number-of-executions": "integer",
"details": [
{
"value": "integer",
"key": "string"
}
],
"plugin-name": "string"
}
],
"number-of-transitions": "integer",
"total-number-of-transitions": "integer",
"id": "string",
"token-size": "integer"
},
"start-date": "string",
"workflow-item": [
{
"displayName": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"name": "string",
"workflowDisplayName": "string",
"href": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}
],
"started-by": "string",
"content-exception": "string",
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"workflowAttributes": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
],
"current-item-display-name": "string",
"end-date": "string",
"name": "string",
"href": "string",
"id": "string",
"state": "string",
"relations": {
"total": "integer",
"start": "integer",
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"current-item-for-display": "string",
"business-state": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": "boolean",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": "boolean"
}
]
}string As date-time As date-time
start-date
Optional
start-date
string
started-by
Optional
started-by
string
content-exception
Optional
content-exception
string
current-item-display-name
Optional
current-item-display-name
string As date-time As date-time
end-date
Optional
end-date
string
name
Optional
name
string
href
Optional
href
string
id
Optional
id
string
state
Optional
state
string
current-item-for-display
Optional
current-item-for-display
string
business-state
Optional
business-state
workflow-execution-statistics
JSON Example
{
"total-time": "integer",
"token-blocked": "integer",
"token-system": "integer",
"token-user": "integer",
"token-wait": "integer",
"activities": [
{
"total-time": "integer",
"number-of-executions": "integer",
"max-time": "integer",
"activities": [
"activity-statistics Object"
],
"number-of-transitions": "integer",
"id": "string"
}
],
"plugins": [
{
"total-time": "integer",
"number-of-executions": "integer",
"details": [
{
"value": "integer",
"key": "string"
}
],
"plugin-name": "string"
}
],
"number-of-transitions": "integer",
"total-number-of-transitions": "integer",
"id": "string",
"token-size": "integer"
}integer As int64 As int64
total-time
Optional
total-time
integer As int64 As int64
token-blocked
Optional
token-blocked
integer As int64 As int64
token-system
Optional
token-system
integer As int64 As int64
token-user
Optional
token-user
integer As int64 As int64
token-wait
Optional
token-wait
integer As int64 As int64
number-of-transitions
Optional
number-of-transitions
integer As int64 As int64
total-number-of-transitions
Optional
total-number-of-transitions
string
id
Optional
id
integer As int64 As int64
token-size
Optional
token-size
Node: apidepo-liferay-dxp-v1-be-w-0:8080: