Jump to

• Request
• Response
• Examples

Get Provisioning Task Responses Based on Task ID

get

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

Returns the provisioning task responses 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 : SingleProvTaskResponse

Type: object

Show Source

• links(optional): array links
• provTaskResponseList(optional): array provTaskResponseList
  List of responses can be chosen for a given provisioning task by its ID

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "provTaskResponseList":{
            "description":"List of responses can be chosen for 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 : provTaskResponseList

Type: array

List of responses can be chosen for a given provisioning task by its ID

Show Source

• Array of: object ProvTask

{
    "description":"List of responses can be chosen for 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 responses 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,seeUse 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/28/responses

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/28/responses"
        },
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/28/responses?offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/28/responses?offset=1&limit=10"
        }
    ],
    "count": 1,
    "hasMore": false,
    "totalResult": -1,
    "provTaskResponseList": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/28/responses/28"
                }
            ],
            "fields": [
                {
                    "name": "Process Definition.Tasks.Key",
                    "value": 202
                },
                {
                    "name": "Event Handler Manager.Key",
                    "value": 0
                },
                {
                    "name": "Process Definition.Tasks.Responses.Update Date",
                    "value": "June 25, 2018 07:22:55 AM"
                },
                {
                    "name": "Process Definition.Tasks.Responses.System Level",
                    "value": 0
                },
                {
                    "name": "Process Definition.Tasks.Responses.Row Version",
                    "value": "AAAAAAAAAAE="
                },
                {
                    "name": "Process Definition.Tasks.Responses.Key",
                    "value": 1080
                },
                {
                    "name": "Process Definition.Tasks.Responses.Created By",
                    "value": 1
                },
                {
                    "name": "Process Definition.Tasks.Responses.Description",
                    "value": "Custom Data Validation failed"
                },
                {
                    "name": "Process Definition.Tasks.Responses.Creation Date",
                    "value": "June 25, 2018 07:21:02 AM"
                },
                {
                    "name": "Status.Key",
                    "value": 1
                },
                {
                    "name": "Process Definition.Tasks.Responses.Response",
                    "value": "VALIDATION_FAILED"
                },
                {
                    "name": "Process Definition.Tasks.Responses.Updated By",
                    "value": 1
                }
            ]
        }
    ]
}

Back to Top