Get Complete Details of a Given Provisioning Process
get
/iam/governance/selfservice/api/v1/provprocesses/{processid}
Returns the complete details of a given provisioning process.
Request
Supported Media Types
- application/json
Path Parameters
-
processid: string
Process ID
Query Parameters
-
fields(optional): string
If required, can provide the comma seperated list of return fields
-
taskInstanceKey(optional): string
Provisioning task id of any provisioning tasks within given provisioning process
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
Root Schema : SingleProvProcess
Type:
Show Source
object-
id(optional):
string
-
links(optional):
array links
-
orgId(optional):
string
-
orgName(optional):
string
-
provisionProcessTaskTOList(optional):
array provisionProcessTaskTOList
List of provisioning tasks in a given provisioning process by its ID
-
resourceId(optional):
string
-
resourceName(optional):
string
-
resourceStatus(optional):
string
-
userId(optional):
string
-
userName(optional):
string
Nested Schema : provisionProcessTaskTOList
Type:
arrayList of provisioning tasks in a given provisioning process by its ID
Show Source
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
The following example shows how to get the complete details of a given Provisioning process by its ID by submitting a GET request on the REST resource using cURL. The information shown here is against a pseudo system and serves as a prototype. For more information about cURL, see Use cURL.
curl -X GET --verbose -k -1 -H "Content-Type: application/json" -H "X-Requested-By: provprocess" -u username:password http://pseudo.com/iam/governance/selfservice/api/v1/provprocesses/22
Example of GET Response Body
The following example shows the contents of the response body in JSON format:
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/provprocesses/22"
}
},
"id": "22",
"provisionProcessTaskTOList": [
{
"id": "28",
"fields": [
{
"name": "Process Instance.Task Information.Assign Type",
"value": "Default task assignment"
},
{
"name": "Process Instance.Task Details.Type",
"value": ""
},
{
"name": "Groups.Group Name",
"value": ""
},
{
"name": "Process Instance.Task Information.Assignee First Name",
"value": "System"
},
{
"name": "Status.Category",
"value": "Pending"
},
{
"name": "Process Instance.Task Details.System level",
"value": 0
},
{
"name": "Process Instance.Task Details.Note",
"value": ""
},
{
"name": "Process Instance.Task Details.Status",
"value": "P"
},
{
"name": "Process Instance.Task Details.Updated By",
"value": 1
},
{
"name": "Process Instance.Task Information.Updated By Last Name",
"value": "Administrator"
},
{
"name": "RETRYALLOWED",
"value": "true"
},
{
"name": "Process Instance.Task Details.Projected End",
"value": "June 25, 2018 08:12:40 AM"
},
{
"name": "Process Instance.Task Details.Row Version",
"value": "AAAAAAAAAAA="
},
{
"name": "Process Definition.Tasks.Hours",
"value": 0
},
{
"name": "Process Instance.Task Details.Created By",
"value": 1
},
{
"name": "Process Instance.Task Details.Update Date",
"value": "June 25, 2018 08:12:40 AM"
},
{
"name": "Process Definition.Tasks.Responses.Description",
"value": ""
},
{
"name": "Process Instance.Task Information.Assignee Last Name",
"value": "Administrator"
},
{
"name": "Process Instance.Task Details.Data",
"value": ""
},
{
"name": "Process Definition.Tasks.Task Name",
"value": "System Validation"
},
{
"name": "Process Definition.Tasks.Disable Manual Insert",
"value": ""
},
{
"name": "Process Instance.Task Details.Actual End Date",
"value": "January 01, 1970 12:00:00 AM"
},
{
"name": "Groups.Role Display Name",
"value": ""
},
{
"name": "Process Instance.Task Information.Assignee User Key",
"value": 1
},
{
"name": "Process Definition.Name",
"value": "AD User"
},
{
"name": "Process Definition.Tasks.Responses.Key",
"value": 0
},
{
"name": "Process Instance.Task Details.Action",
"value": ""
},
{
"name": "Process Instance.Task Details.Creation Date",
"value": "June 25, 2018 08:12:40 AM"
},
{
"name": "Process Instance.Task Information.Assignee User ID",
"value": "XELSYSADM"
},
{
"name": "Process Instance.Task Information.Assigned Date",
"value": "June 25, 2018 08:12:40 AM"
},
{
"name": "Process Instance.Task Details.Key",
"value": 28
},
{
"name": "Process Definition.Tasks.Task Description",
"value": ""
},
{
"name": "Process Instance.Task Details.Task Offlined",
"value": 0
},
{
"name": "Process Definition.Tasks.Key",
"value": 202
},
{
"name": "Process Definition.Tasks.Days",
"value": 0
},
{
"name": "Process Definition.Tasks.Milestone Datalabel",
"value": ""
},
{
"name": "Process Instance.Task Information.Updated By User Key",
"value": 1
},
{
"name": "Process Instance.Task Information.Row Version",
"value": "AAAAAAAAAAA="
},
{
"name": "Process Instance.Task Details.Reason",
"value": ""
},
{
"name": "Process Definition.Tasks.Minutes",
"value": 0
},
{
"name": "Process Instance.Task Details.Projected Start",
"value": "June 25, 2018 08:12:40 AM"
},
{
"name": "Groups.Key",
"value": 0
},
{
"name": "Process Instance.Task Information.Updated By User ID",
"value": "XELSYSADM"
},
{
"name": "Process Instance.Task Details.Actual Start Date",
"value": "June 25, 2018 08:12:40 AM"
},
{
"name": "Process Instance.Task Information.Updated By First Name",
"value": "System"
},
{
"name": "TargetType",
"value": "User"
},
{
"name": "TargetName",
"value": "System Administrator [XELSYSADM]"
},
{
"name": "AssignedTo",
"value": "System Administrator [XELSYSADM]"
},
{
"name": "Status",
"value": "Pending"
},
{
"name": "Response",
"value": ""
},
{
"name": "ResponseDescription",
"value": ""
}
]
}
],
"resourceId": "13",
"resourceName": "AD User",
"userId": "9",
"userName": "USR 11JI LS",
"resourceStatus": "Provisioning"
}