Jump to

• Request
• Response
• Examples

Get provisioning task based on the task id.

get

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

Returns the provisioning task for the specified task id.

Request

Supported Media Types

• application/json

Path Parameters

• taskid: string
  Task ID

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 : SingleProvTask

Type: object

Show Source

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

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

Nested Schema : fields

Type: array

Show Source

• [0]: object Fields

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

Nested Schema : formFields

Type: array

Show Source

• [0]: object Fields

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

Nested Schema : links

Type: array

Show Source

• [0]: 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"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

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

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example retrieves the information for a given taskid. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/unauthservice/provtasks/5124

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
  "id": "5124",
  "fields": [
    {
      "name": "Process Definition.Tasks.Key",
      "value": 39
    },
    {
      "name": "Process Instance.Task Information.Updated By User ID",
      "value": "XELSYSADM"
    },
    {
      "name": "Process Instance.Task Details.Data",
      "value": "Rejected"
    },
    {
      "name": "Process Instance.Task Details.Created By",
      "value": 1
    },
    {
      "name": "Process Definition.Tasks.Task Name",
      "value": "ManualRevokeStart"
    },
    {
      "name": "Process Instance.Task Information.Assignee First Name",
      "value": "System"
    },
    {
      "name": "SCH_REASON",
      "value": ""
    },
    {
      "name": "Process Instance.Task Details.System level",
      "value": 0
    },
    {
      "name": "Process Instance.Task Information.Assign Type",
      "value": "User"
    },
    {
      "name": "Process Definition.Tasks.Milestone Datalabel",
      "value": ""
    },
    {
      "name": "Process Instance.Task Information.Assignee User Key",
      "value": 1
    },
    {
      "name": "Process Instance.Task Details.Status",
      "value": "X"
    },
    {
      "name": "Organizations.Key",
      "value": 1
    },
    {
      "name": "Process Definition.Tasks.Days",
      "value": 0
    }
  ]
}

Back to Top