Returns all LaunchedWorkflow resources.
GET/LaunchedWorkflows
This endpoint returns all LaunchedWorkflow resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to LaunchedWorkflow is:
- urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow
Request
Query Parameters
Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.
Allows sorting the results by a resource's attributes.
Default value: ascending
Determines what order to sort results in.
Default value: 1
Determines the starting index of the result set.
Default value: 1000
Specifies the number of results per page.
A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.
A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.
Responses
- 200
Returned all SCIM resources for this endpoint.
LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Number of resources returned for this endpoint
The starting index of the resource set list. Can be specified with startIndex query parameter.
SCIM Schema used for response.
Resources
undefined[]
Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).
The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
Type of the TaskResult. (From the TaskResult used to launch the Workflow).
The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).
Name of the Workflow to launch.
Id representing the identity request.
Id representing the workflow case (a running instance of a workflow).
Id representing the workflow monitoring process log.
The number of retries performed during the execution of provisioning activities.
XML representation of approvals.
XML representation of the workflow summary.
input
object
A list of input attributes of the Launched Workflow.
The attribute key.
The attribute value.
The attribute type.
output
object
A list of output attributes of the Launched Workflow.
The attribute key.
The attribute value.
The attribute type.
Target Class of the TaskResult. (From the TaskResult used to launch the Workflow).
Name of the TaskResult. (From the TaskResult used to launch the Workflow).
List of messages of the TaskResult. (From the TaskResult used to launch the Workflow).
attributes
undefined[]
A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow).
The attribute key.
The attribute value.
Unique identifier of the TaskResult. (From the TaskResult used to launch the Workflow).
Possible values: [Success
, Warning
, Error
, Terminated
, TempError
]
Completion Status of the TaskResult. (From the TaskResult used to launch the Workflow).
Name of the TaskDefinition of the TaskResult. (From the TaskResult used to launch the Workflow).
Flag to indicate this TaskResult is terminated. (From the TaskResult used to launch the Workflow).
Launcher of the TaskResult. (From the TaskResult used to launch the Workflow).
meta
object
DateTime when the TaskResult was created. (From the TaskResult used to launch the Workflow).
URL to the TaskResult. (From the TaskResult used to launch the Workflow).
DateTime of TaskResult last modification. (From the TaskResult used to launch the Workflow).
TaskResult version. (From the TaskResult used to launch the Workflow).
Resource type of the metadata subject. (From the TaskResult used to launch the Workflow).
{
"totalResults": "1,",
"startIndex": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"partitioned": true,
"completed": "2022-04-14T10:45:26.098-05:00",
"type": "Workflow",
"launched": "2022-04-14T10:45:26.114-05:00",
"pendingSignOffs": 2,
"workflowName": "Update Identity Adam.Kennedy AccessRequest",
"identityRequestId": "0000000001",
"workflowCaseId": "c0a8019c808b1baa81808bde2c2201b3",
"workflowProcessId": "7f000001806719888180675c8f8a225g",
"retries": 1,
"approvalSet": "example: <ApprovalSet><ApprovalItem application=\"SAP\" approver=\"John.Coleman\" assignmentId=\"25701d226e9d4f98a8e42fcebb61980f\" displayName=\"IT Role\" displayValue=\"SAP Admin\" id=\"7e314fb9b307481682b42f8e714b382d\" name=\"assignedRoles\" operation=\"Add\" state=\"Finished\" value=\"SAP Admin\"><Attributes> <Map><entry key=\"attachmentConfigList\"/><entry key=\"attachments\"/><entry key=\"flow\" value=\"AccessRequest\"/><entry key=\"id\" value=\"7f00000180281df7818028bfb3561254\"/><entry key=\"interface\" value=\"LCM\"/><entry key=\"operation\" value=\"RoleAdd\"/></Map></Attributes></ApprovalItem></ApprovalSet>",
"workflowSummary": "example: \"<WorkflowSummary step=\"end\"><Interactions><ApprovalSummary completer=\"James Smith\" endDate=\"1651001587664\" owner=\"James.Smith\" request=\"Approve modification of entitlement ADDirectDemodata group: CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\" startDate=\"1651001561152\" state=\"Finished\" workItemId=\"7f000001806719888180675c9006016b\" workItemType=\"Approval\"/></Interactions></WorkflowSummary>\"",
"input": {
"key": "_workflowRef",
"value": "UpdateIdentityWorkflow",
"type": "string"
},
"output": {
"key": "workflowSummary",
"value": "<WorkflowSummary step=\"end\">\\n <Interactions>\\n <ApprovalSummary completer=\"James Smith\" endDate=\"1651001587664\" owner=\"James.Smith\" request=\"Approve modification of entitlement ADDirectDemodata group: CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\" startDate=\"1651001561152\" state=\"Finished\" workItemId=\"7f000001806719888180675c9006016b\" workItemType=\"Approval\"/>\\n </Interactions>\\n</WorkflowSummary>\\n",
"type": "application/xml"
},
"targetClass": "Permission",
"name": "Update Account Group a2a",
"messages": [
[
"Task executed successfully."
]
],
"attributes": [
{
"key": "Workflow Summary",
"value": "<WorkflowSummary step=\"end\">\\n <Interactions>\\n <ApprovalSummary completer=\"James Smith\" endDate=\"1651001587664\" owner=\"James.Smith\" request=\"Approve modification of entitlement ADDirectDemodata group: CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\" startDate=\"1651001561152\" state=\"Finished\" workItemId=\"7f000001806719888180675c9006016b\" workItemType=\"Approval\"/>\\n </Interactions>\\n</WorkflowSummary>\\n"
}
],
"id": "7f00000180281df7818028c03252085c",
"completionStatus": "Success",
"taskDefinition": "Workflow Launcher",
"terminated": true,
"launcher": "spadmin",
"meta": {
"created": "2022-04-14T10:44:54.834-05:00",
"location": "http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c",
"lastModified": "2022-04-05T15:52:30.119-05:00",
"version": "\"W\"1649951094834\"",
"resourceType": "TaskResult"
}
}
]
}
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Number of LaunchedWorkflow resources returned.
The starting index of the resource set list. Can be specified with startIndex query parameter.
SCIM Schema used for response.
Resources
undefined[]
The SCIM resources returned for this endpoint.
Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).
The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
Type of the TaskResult. (From the TaskResult used to launch the Workflow).
The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).
Name of the Workflow to launch.
Id representing the identity request.
Id representing the workflow case (a running instance of a workflow).
Id representing the workflow monitoring process log.
The number of retries performed during the execution of provisioning activities.
XML representation of approvals.
XML representation of the workflow summary.
input
object
A list of input attributes of the Launched Workflow.
The attribute key.
The attribute value.
The attribute type.
output
object
A list of output attributes of the Launched Workflow.
The attribute key.
The attribute value.
The attribute type.
Target Class of the TaskResult. (From the TaskResult used to launch the Workflow).
Name of the TaskResult. (From the TaskResult used to launch the Workflow).
List of messages of the TaskResult. (From the TaskResult used to launch the Workflow).
attributes
undefined[]
A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow).
The attribute key.
The attribute value.
Unique identifier of the TaskResult. (From the TaskResult used to launch the Workflow).
Possible values: [Success
, Warning
, Error
, Terminated
, TempError
]
Completion Status of the TaskResult. (From the TaskResult used to launch the Workflow).
Name of the TaskDefinition of the TaskResult. (From the TaskResult used to launch the Workflow).
Flag to indicate this TaskResult is terminated. (From the TaskResult used to launch the Workflow).
Launcher of the TaskResult. (From the TaskResult used to launch the Workflow).
meta
object
DateTime when the TaskResult was created. (From the TaskResult used to launch the Workflow).
URL to the TaskResult. (From the TaskResult used to launch the Workflow).
DateTime of TaskResult last modification. (From the TaskResult used to launch the Workflow).
TaskResult version. (From the TaskResult used to launch the Workflow).
Resource type of the metadata subject. (From the TaskResult used to launch the Workflow).
{
"totalResults": "1500,",
"startIndex": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"partitioned": true,
"completed": "2022-04-14T10:45:26.098-05:00",
"type": "Workflow",
"launched": "2022-04-14T10:45:26.114-05:00",
"pendingSignOffs": 2,
"workflowName": "Update Identity Adam.Kennedy AccessRequest",
"identityRequestId": "0000000001",
"workflowCaseId": "c0a8019c808b1baa81808bde2c2201b3",
"workflowProcessId": "7f000001806719888180675c8f8a225g",
"retries": 1,
"approvalSet": "example: <ApprovalSet><ApprovalItem application=\"SAP\" approver=\"John.Coleman\" assignmentId=\"25701d226e9d4f98a8e42fcebb61980f\" displayName=\"IT Role\" displayValue=\"SAP Admin\" id=\"7e314fb9b307481682b42f8e714b382d\" name=\"assignedRoles\" operation=\"Add\" state=\"Finished\" value=\"SAP Admin\"><Attributes> <Map><entry key=\"attachmentConfigList\"/><entry key=\"attachments\"/><entry key=\"flow\" value=\"AccessRequest\"/><entry key=\"id\" value=\"7f00000180281df7818028bfb3561254\"/><entry key=\"interface\" value=\"LCM\"/><entry key=\"operation\" value=\"RoleAdd\"/></Map></Attributes></ApprovalItem></ApprovalSet>",
"workflowSummary": "example: \"<WorkflowSummary step=\"end\"><Interactions><ApprovalSummary completer=\"James Smith\" endDate=\"1651001587664\" owner=\"James.Smith\" request=\"Approve modification of entitlement ADDirectDemodata group: CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\" startDate=\"1651001561152\" state=\"Finished\" workItemId=\"7f000001806719888180675c9006016b\" workItemType=\"Approval\"/></Interactions></WorkflowSummary>\"",
"input": {
"key": "_workflowRef",
"value": "UpdateIdentityWorkflow",
"type": "string"
},
"output": {
"key": "workflowSummary",
"value": "<WorkflowSummary step=\"end\">\\n <Interactions>\\n <ApprovalSummary completer=\"James Smith\" endDate=\"1651001587664\" owner=\"James.Smith\" request=\"Approve modification of entitlement ADDirectDemodata group: CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\" startDate=\"1651001561152\" state=\"Finished\" workItemId=\"7f000001806719888180675c9006016b\" workItemType=\"Approval\"/>\\n </Interactions>\\n</WorkflowSummary>\\n",
"type": "application/xml"
},
"targetClass": "Permission",
"name": "Update Account Group a2a",
"messages": [
[
"Task executed successfully."
]
],
"attributes": [
{
"key": "Workflow Summary",
"value": "<WorkflowSummary step=\"end\">\\n <Interactions>\\n <ApprovalSummary completer=\"James Smith\" endDate=\"1651001587664\" owner=\"James.Smith\" request=\"Approve modification of entitlement ADDirectDemodata group: CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\" startDate=\"1651001561152\" state=\"Finished\" workItemId=\"7f000001806719888180675c9006016b\" workItemType=\"Approval\"/>\\n </Interactions>\\n</WorkflowSummary>\\n"
}
],
"id": "7f00000180281df7818028c03252085c",
"completionStatus": "Success",
"taskDefinition": "Workflow Launcher",
"terminated": true,
"launcher": "spadmin",
"meta": {
"created": "2022-04-14T10:44:54.834-05:00",
"location": "http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c",
"lastModified": "2022-04-05T15:52:30.119-05:00",
"version": "\"W\"1649951094834\"",
"resourceType": "TaskResult"
}
}
]
}