Jump to

• Request
• Response
• Examples

Get Request Based on Request ID

get

/iam/governance/selfservice/api/v1/requests/{reqid}

Returns the request details of the specified request id. The attributes that are to be returned can be specified as part of the query parameter named "fields". For example: The URI to get the request type and status attributes only for a particular request is /requests/{reqid}?fields=reqType, reqStatus. The attributes are to be spcified in a Comma-separated list.

Request

Supported Media Types

• application/json

Path Parameters

• reqid: string
  Request ID

Query Parameters

• fields(optional): string
  Attributes to be returned in the result. RequestId attribute is mandatory in the return list. Comma-separated attributes are accepted.

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

Type: object

Show Source

• requests(optional): object UserRequest

{
    "properties":{
        "requests":{
            "$ref":"#/definitions/UserRequest"
        }
    }
}

Nested Schema : UserRequest

Type: object

Show Source

• childRequests(optional): array childRequests
• id(optional): string
• links(optional): array links
• reqBeneficiaryList(optional): array reqBeneficiaryList
• reqCreatedOn(optional): string
• reqExpireOn(optional): string
• reqJustification(optional): string
• reqModifiedOnDate(optional): string
• reqStatus(optional): string
• reqTargetEntities(optional): array reqTargetEntities
• reqType(optional): string
• requester(optional): object Requester
• requestTaskDetails(optional): array requestTaskDetails

{
    "properties":{
        "id":{
            "type":"string"
        },
        "reqStatus":{
            "type":"string"
        },
        "reqType":{
            "type":"string"
        },
        "requester":{
            "$ref":"#/definitions/Requester"
        },
        "reqJustification":{
            "type":"string"
        },
        "reqBeneficiaryList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RequestBeneficiary"
            }
        },
        "reqCreatedOn":{
            "type":"string"
        },
        "reqExpireOn":{
            "type":"string"
        },
        "reqTargetEntities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reqTargetEntity"
            }
        },
        "childRequests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childRequests"
            }
        },
        "reqModifiedOnDate":{
            "type":"string"
        },
        "requestTaskDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/requestTaskDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : childRequests

Type: array

Show Source

• Array of: object childRequests

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : reqBeneficiaryList

Type: array

Show Source

• Array of: object RequestBeneficiary

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

Nested Schema : reqTargetEntities

Type: array

Show Source

• Array of: object reqTargetEntity

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

Nested Schema : Requester

Type: object

Show Source

• id(optional): string
• links(optional): array links

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

Nested Schema : requestTaskDetails

Type: array

Show Source

• Array of: object requestTaskDetails

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

Nested Schema : childRequests

Type: object

Show Source

• links(optional): array links
• reqId(optional): string

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : LinkDataInstances

Type: object

Show Source

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

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

Nested Schema : RequestBeneficiary

Type: object

Show Source

• displayName(optional): string
• links(optional): array links
• userLogin(optional): string

{
    "properties":{
        "userLogin":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : reqTargetEntity

Type: object

Show Source

• appFormData(optional): object AppFormData
• catalogId(optional): string
• entityId(optional): string
• entityName(optional): string
• entityType(optional): string
• links(optional): array links
• parentAccountId(optional): integer
• parentAccountName(optional): string

{
    "properties":{
        "entityName":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "catalogId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "parentAccountId":{
            "type":"integer"
        },
        "parentAccountName":{
            "type":"string"
        },
        "appFormData":{
            "$ref":"#/definitions/AppFormData"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : AppFormData

Type: object

Show Source

• links(optional): array links

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : requestTaskDetails

Type: object

Show Source

• history(optional): object history
• title(optional): string

{
    "properties":{
        "title":{
            "type":"string"
        },
        "history":{
            "$ref":"#/definitions/history"
        }
    }
}

Nested Schema : history

Type: object

Show Source

• currentApprovers(optional): array currentApprovers
• futureApprovers(optional): array futureApprovers
• previousApprovers(optional): array previousApprovers

{
    "properties":{
        "previousApprovers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Approvers"
            }
        },
        "currentApprovers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Approvers"
            }
        },
        "futureApprovers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Approvers"
            }
        }
    }
}

Nested Schema : currentApprovers

Type: array

Show Source

• Array of: object Approvers

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

Nested Schema : futureApprovers

Type: array

Show Source

• Array of: object Approvers

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

Nested Schema : previousApprovers

Type: array

Show Source

• Array of: object Approvers

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

Nested Schema : Approvers

Type: object

Show Source

• acquiredBy(optional): string
• approvers(optional): string
• stage(optional): string
• stageIndex(optional): string
• status(optional): string
• updatedDate(optional): string

{
    "properties":{
        "stage":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "approvers":{
            "type":"string"
        },
        "acquiredBy":{
            "type":"string"
        },
        "stageIndex":{
            "type":"string"
        },
        "updatedDate":{
            "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 all the information for a given request 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/requests/12

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/requests/12"
        }
    ],
    "id": "12",
    "reqStatus": "Request Completed",
    "requester": {
        "name": "requesterId",
        "value": "17",
        "link": {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
        }
    },
    "reqCreatedOn": "2019-03-14T18:35:19Z",
    "reqExpireOn": "2019-03-14T18:54:57Z",
    "reqType": "Modify User Profile",
    "reqBeneficiaryList": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            ],
            "id": "17"
        }
    ],
    "reqTargetEntities": [],
    "reqModifiedOnDate": "2019-03-14T18:54:57Z",
    "requestTaskDetails": [
        {
            "title": "Default operational level approval for Request ID 12",
            "history": {
                "previousApprovers": [
                    {
                        "stage": "defaultOperationalApproval.approvalTask.assignee",
                        "status": "APPROVE",
                        "approvers": "SYSTEM ADMINISTRATORS",
                        "acquiredBy": "sysadmin",
                        "stageIndex": "3",
                        "updatedDate": "2019-03-14T18:54:56Z"
                    }
                ],
                "currentApprovers": [
                    {
                        "stage": "defaultOperationalApproval.approvalTask.assignee",
                        "status": "COMPLETED",
                        "approvers": ""
                    }
                ],
                "futureApprovers": []
            }
        }
    ],
    "childRequests": []
}

Back to Top