GET /rest/bpm/bfm/v1/processTemplate/{ptid}None
None
The default content-type is application/json.
{ "description": "Process Template",
"type": "object",
"properties":
{ "applicationName": {"type": "string",
"description": "Name of the application the process template is part of."
},
"autoDeletionMode": {"type": "string",
"description": "Specifies whether an instance of the process template is automatically or conditionally deleted when it reaches an end execution state.",
"enum":
[
"AUTO_DELETE_YES",
"AUTO_DELETE_NO",
"AUTO_DELETE_ON_SUCCESSFUL_COMPLETION"
]
},
"autonomy": {"type": "string",
"description": "Specifies whether an instance of the process template runs dependently of a potential parent or not.",
"enum":
[
"AUTONOMY_PEER",
"AUTONOMY_CHILD",
"AUTONOMY_NOT_APPLICABLE"
]
},
"creationTime": {"type": "string", "format": "date-time",
"description": "Creation time of the process template."
},
"customProperties" : {"type": "object", "additionalProperties": {"type": "string"},
"description": "List of custom property names and values."
},
"customText1": {"type": "string",
"description": "Inline custom property 1."
},
"customText2": {"type": "string",
"description": "Inline custom property 2."
},
"customText3": {"type": "string",
"description": "Inline custom property 3."
},
"customText4": {"type": "string",
"description": "Inline custom property 4."
},
"customText5": {"type": "string",
"description": "Inline custom property 5."
},
"customText6": {"type": "string",
"description": "Inline custom property 6."
},
"customText7": {"type": "string",
"description": "Inline custom property 7."
},
"customText8": {"type": "string",
"description": "Inline custom property 8."
},
"description": {"type": "string",
"description": "Description of the process template."
},
"displayName": {"type": "string",
"description": "Display name of the process template."
},
"executionMode": {"type": "string",
"description": "States whether the process template can be executed as a microflow or as a macroflow.",
"enum":
[
"EXECUTION_MODE_LONG_RUNNING",
"EXECUTION_MODE_MICROFLOW"
]
},
"inputType": {"type": "string",
"description": "Name of the input message type. The value has the format {namespace}localname."
},
"isBusinessRelevant": {"type": "boolean",
"description": "States whether a process instance derived from this template is a business relevant or an 'auxiliary' step."
},
"isCompensationDefined": {"type": "boolean",
"description": "States whether an instance of the process template can be compensated."
},
"isContinueOnError": {"type": "boolean",
"description": "States whether process instances derived from this template stop in case of an unhandled error or not."
},
"isTip": {"type": "boolean", "optional": true,
"description": "States whether the process template is part of a tip."
},
"lastModificationTime": {"type": "string", "format": "date-time",
"description": "Last time a property of the process template changed."
},
"name": {"type": "string",
"description": "Name of the process template."
},
"processAppAcronym": {"type": "string",
"description": "Process application acronym."
},
"processAppName": {"type": "string",
"description": "Process application name."
},
"ptid": {"type": "string",
"description": "ID of the process template."
},
"schemaVersion": {"type": "string",
"description": "Version of the XML schema that describes the process template."
},
"snapshotID": {"type": "string",
"description": "Snapshot ID of the process application or top-level toolkit."
},
"snapshotName": {"type": "string",
"description": "Snapshot name of the process application or top-level toolkit."
},
"state": {"type": "string",
"description": "States whether the process template is started or stopped.",
"enum":
[
"STATE_STARTED",
"STATE_STOPPED"
]
},
"targetNamespace": {"type": "string",
"description": "XML Schema target namespace of the process template."
},
"toolkitAcronym": {"type": "string",
"description": "Toolkit acronym."
},
"toolkitName": {"type": "string",
"description": "Toolkit name."
},
"toolkitSnapshotID": {"type": "string",
"description": "Toolkit snapshot ID."
},
"toolkitSnapshotName": {"type": "string",
"description": "Toolkit snapshot name."
},
"topLevelToolkitAcronym": {"type": "string",
"description": "Top-level toolkit acronym."
},
"topLevelToolkitName": {"type": "string",
"description": "Top-level toolkit name."
},
"trackName": {"type": "string",
"description": "Track name."
},
"validFromTime": {"type": "string", "format": "date-time",
"description": "Time the process template became or becomes valid."
},
"version": {"type": "string",
"description": "User-specified version of the process template."
}
}
}
The default content-type is application/json.
{ "description": "Error Response",
"type": "object",
"properties":
{ "errorNumber": {"type": "string",
"description":"Message ID of the exception."
},
"errorMessage": {"type": "string",
"description":"Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description":"Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description":"Additional, exception details, for example, a stack trace."
}
}
}
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | The process template does not exist.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred. Programmer's details are provided. |
| Release | Description |
|---|---|
| 7.5 | The returned process template object contains new properties:
|
| 7.5.1 | The returned process template object contains new properties:
|
6.2
Parent topic: Process template Resource