GET /rest/bpm/bfm/v1/activity/{aiid}None
None
The default content-type is application/json.
{ "description": "Activity",
"type": "object",
"properties":
{ "activationTime": {"type": "string", "format": "date-time",
"description": "Activation time of the activity instance."
},
"activityTemplateID": {"type": "string",
"description": "Object ID of the process template that contains the activity definition."
},
"adminTaskID": {"type": "string",
"description": "ID of the associated administration task."
},
"aiid": {"type": "string",
"description": "Activity instance object ID."
},
"applicationName": {"type": "string",
"description": "Name of the enterprise application the activity belongs to."
},
"availableActions": {"type": ["string"]},
"description": "Actions that can be called in the current activity instance execution state."
,
"completionTime": {"type": "string", "format": "date-time",
"description": "Completion time of the activity instance."
},
"customProperties" : {"type": "object", "additionalProperties": {"type": "string"},
"description": "Values of custom properties associated with the activity."
},
"description": {"type": "string",
"description": "Description of the activity instance."
},
"displayName": {"type": "string",
"description": "Display name of the activity instance."
},
"enclosingForEachID": {"type": "string",
"description": "ID of the enclosing for-each activity if the activity is part of an for-each construct."
},
"eventHandlerInstanceID": {"type": "string",
"description": "ID of the associated event handler instance if the activity is part of an event handler."
},
"executionState": {"type": "string",
"description": "Execution state of the activity instance.",
"enum":
[
"STATE_CLAIMED",
"STATE_EXPIRED",
"STATE_FAILED",
"STATE_FAILING",
"STATE_FINISHED",
"STATE_INACTIVE",
"STATE_PROCESSING_UNDO",
"STATE_READY",
"STATE_RUNNING",
"STATE_SKIPPED",
"STATE_STOPPED",
"STATE_TERMINATED",
"STATE_TERMINATING",
"STATE_WAITING"
]
},
"expirationTime": {"type": "string", "format": "date-time",
"description": "Time when the activity instance will expire or expired."
},
"faults": {"type":
[
{ "faultName": {"type": "string",
"description": "Name of the fault. The value has the format {namespace}localname."
},
"faultType": {"type": "string",
"description": "Name of the fault message type. The value has the format {namespace}localname."
}
}
],
"description": "Faults associated with the activity instance."
},
"inputType": {"type": "string",
"description": "Name of the input message type. The value has the format {namespace}localname."
},
"invokedInstanceID": {"type": "string",
"description": "For an invoke activity, this is the ID of an invoked task or process."
},
"invokedInstanceType": {"type": "string",
"description": "For an invoke activity, this is the type of an invoked task or process.",
"enum":
[
"INVOKED_INSTANCE_TYPE_NOT_SET",
"INVOKED_INSTANCE_TYPE_INLINE_TASK",
"INVOKED_INSTANCE_TYPE_CHILD_TASK",
"INVOKED_INSTANCE_TYPE_CHILD_PROCESS"
]
},
"isBusinessRelevant": {"type": "boolean",
"description": "States whether the activity instance is a business relevant or an 'auxiliary' step."
},
"isContinueOnError": {"type": "boolean",
"description": "States whether the activity instance stops navigation of the process in case of an unhandled error."
},
"isSkipRequested": {"type": "boolean",
"description": "States whether the activity instance is to be skipped when reached during navigation."
},
"kind": {"type": "string",
"description": "Kind of the activity, for example, whether the activity is a pick or receive activity.",
"enum":
[
"KIND_ASSIGN",
"KIND_COMPENSATE",
"KIND_COMPENSATE_SCOPE",
"KIND_CUSTOM",
"KIND_EMPTY",
"KIND_FLOW",
"KIND_FLOW_END",
"KIND_FOR_EACH_PARALLEL",
"KIND_FOR_EACH_PARALLEL_END",
"KIND_FOR_EACH_SERIAL",
"KIND_FOR_EACH_SERIAL_END",
"KIND_INVOKE",
"KIND_INVOKE_END",
"KIND_PICK",
"KIND_PICK_END",
"KIND_RECEIVE",
"KIND_REPEAT_UNTIL",
"KIND_REPEAT_UNTIL_END",
"KIND_REPLY",
"KIND_RETHROW",
"KIND_SCOPE",
"KIND_SCOPE_END",
"KIND_SCRIPT",
"KIND_SEQUENCE",
"KIND_SEQUENCE_END",
"KIND_STAFF",
"KIND_SWITCH",
"KIND_SWITCH_END",
"KIND_TERMINATE",
"KIND_THROW",
"KIND_WAIT",
"KIND_WHILE",
"KIND_WHILE_END"
]
},
"lastModificationTime": {"type": "string", "format": "date-time",
"description": "Last time a property of the activity instance changed."
},
"lastStateChangeTime": {"type": "string", "format": "date-time",
"description": "Last time the execution state of the activity instance changed."
},
"name": {"type": "string",
"description": "Name of the activity instance."
},
"outputType": {"type": "string",
"description": "Name of the output message type. The value has the format {namespace}localname"
},
"owner": {"type": "string",
"description": "Owner of the activity instance."
},
"previousExpirationTime": {"type": "string", "format": "date-time",
"description": "Time the activity instance expired for the first time."
},
"processAdminTaskID": {"type": "string",
"description": "ID of the administration task associated to the containing process instance."
},
"processInstanceID": {"type": "string",
"description": "ID of the containing process instance."
},
"processInstanceName": {"type": "string",
"description": "Name of the process instance the activity belongs to."
},
"processTemplateID": {"type": "string",
"description": "ID of the process template that contains the activity definition."
},
"processTemplateName": {"type": "string",
"description": "Name of the first process template in the hierarchy that contains the activity definition."
},
"scopeID": {"type": "string",
"description": "ID of the associated scope."
},
"scopeTemplateID": {"type": "string",
"description": "ID of the scope template that is associated to the scope the activity is part of."
},
"startTime": {"type": "string", "format": "date-time",
"description": "Start time of the activity instance."
},
"stopReason": {"type": "string",
"description": "Reason why the activity is in the Stopped execution state.",
"enum":
[
"STOP_REASON_ACTIVATION_FAILED",
"STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED",
"STOP_REASON_IMPLEMENTATION_FAILED",
"STOP_REASON_UNSPECIFIED"
]
},
"subState": {"type": "string",
"description": "The sub state of the activity instance.",
"enum":
[
"SUB_STATE_NONE",
"SUB_STATE_EXPIRING",
"SUB_STATE_SKIPPING",
"SUB_STATE_RESTARTING",
"SUB_STATE_FINISHING",
"SUB_STATE_FAILING"
]
},
"taskID": {"type": "string",
"description": "For a human task activity, this is the ID of the associated inline to-do task."
}
}
}
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 activity instance 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.0 | The returned activity instance objects contain new properties:
|
6.2
Parent topic: Activity Instance Resource