Jump to

• Request
• Response
• Examples

Get Provisioning Task History Based on Task ID

get

/iam/governance/selfservice/api/v1/provtasks/{taskid}/history

Returns the provisioning task history for the specified task id.

Request

Supported Media Types

• application/json

Path Parameters

• taskid: string
  Task ID

Query Parameters

• fields(optional): string
  If required, can provide the comma seperated list of return fields

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : SingleProvTaskHistory

Type: object

Show Source

• links(optional): array links
• provTaskHistoryList(optional): array provTaskHistoryList
  List of assignment history of a given provisioning task by its ID

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "provTaskHistoryList":{
            "description":"List of assignment history of a given provisioning task by its ID",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProvTask"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : provTaskHistoryList

Type: array

List of assignment history of a given provisioning task by its ID

Show Source

• Array of: object ProvTask

{
    "description":"List of assignment history of a given provisioning task by its ID",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProvTask"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : ProvTask

Type: object

Show Source

• fields(optional): array fields
• links(optional): array links

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

• Array of: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

The following example shows how to get the history of a provisioning task 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: provtasks"  -u username:password http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6/history

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/provtasks/6/history"
        },
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6/history?offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6/history?offset=1&limit=10"
        }
    ],
    "count": 1,
    "hasMore": false,
    "totalResult": -1,
    "provTaskHistoryList": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6/history/6"
                }
            ],
            "fields": [
                {
                    "name": "Status",
                    "value": "Pending"
                },
                {
                    "name": "ASSIGNER_USER_KEY",
                    "value": 0
                },
                {
                    "name": "Process Instance.Task History.Assign Type",
                    "value": "Default task assignment"
                },
                {
                    "name": "Process Instance.Task Information.Assignee User Key",
                    "value": 1
                },
                {
                    "name": "Users.Manager Login",
                    "value": ""
                },
                {
                    "name": "Groups.Group Name",
                    "value": ""
                },
                {
                    "name": "Status.Status",
                    "value": "P"
                },
                {
                    "name": "Process Instance.Task History.Action",
                    "value": "Engine"
                },
                {
                    "name": "Process Instance.Task History.Assign Date",
                    "value": "June 25, 2018 07:23:40 AM"
                },
                {
                    "name": "Process Instance.Task Information.Assignee First Name",
                    "value": "System"
                },
                {
                    "name": "AssignedToUser",
                    "value": "System Administrator  [XELSYSADM]"
                },
                {
                    "name": "ASSIGNER_USER_LOGIN",
                    "value": ""
                },
                {
                    "name": "Process Instance.Task Information.Assignee User ID",
                    "value": "XELSYSADM"
                },
                {
                    "name": "Users.Manager First Name",
                    "value": ""
                },
                {
                    "name": "ASSIGNER_FIRST_NAME",
                    "value": ""
                },
                {
                    "name": "Process Instance.Task History.Assigned To User",
                    "value": 1
                },
                {
                    "name": "ASSIGNER_LAST_NAME",
                    "value": ""
                },
                {
                    "name": "Users.Manager Key",
                    "value": 0
                },
                {
                    "name": "Process Instance.Task History.Assigned By User",
                    "value": 0
                },
                {
                    "name": "Process Instance.Task History.Assigned To Group",
                    "value": 0
                },
                {
                    "name": "Process Instance.Task Information.Assignee Last Name",
                    "value": "Administrator"
                },
                {
                    "name": "Users.Manager Last Name",
                    "value": ""
                }
            ]
        }
    ]
}

Back to Top