Jump to

• Request
• Response
• Examples

Update Requests

put

/iam/governance/selfservice/api/v1/requests

Updates the requests specified in the payload. The request id for each request should be specified in the payload along with attributes to update for each request. The request data can updated or the request status can be updated. Based on the type of action attribute provided the SOA or OIM action is executed. Here the action could be APPROVE, RELEASE, RESUME, REASSIGN, REJECT, ESCALATE, SUSPEND, WITHDRAW, CLAIM, SAVE, CREATESUBTASK, SKIPASSIGNMENT, CLOSE. As an option a TaskId can be provided for each request to exclusively perform the operation on the specific task. If the taskId is not provided then the first task in the list will be picked for the operation requested.

Request

Supported Media Types

• application/json

Body ()

List of update attributes for updating requests

Root Schema : BulkReqUpdateRequest

Type: object

Show Source

• requests(optional): array requests

{
    "properties":{
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReqUpdateRequestEntity"
            }
        }
    }
}

Nested Schema : requests

Type: array

Show Source

• Array of: object ReqUpdateRequestEntity

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

Nested Schema : ReqUpdateRequestEntity

Type: object

Show Source

• action(optional): string
• actionComment(optional): string
• assignees(optional): array assignees
• id(optional): string
• reqTargetEntities(optional): array reqTargetEntities
• requestId(optional): string
• taskId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "actionComment":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PendingApprovalsAssigneeNames"
            }
        },
        "reqTargetEntities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reqTargetEntityRequestPayload"
            }
        }
    }
}

Nested Schema : assignees

Type: array

Show Source

• Array of: object PendingApprovalsAssigneeNames

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

Nested Schema : reqTargetEntities

Type: array

Show Source

• Array of: object reqTargetEntityRequestPayload

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

Nested Schema : PendingApprovalsAssigneeNames

Type: object

Show Source

• name(optional): string
• type(optional): string

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

Nested Schema : reqTargetEntityRequestPayload

Type: object

Show Source

• appFormData(optional): array appFormData
• catalogId(optional): string
• entityId(optional): string
• entityName(optional): string
• entityType(optional): string
• 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":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

Nested Schema : appFormData

Type: array

Show Source

• Array of: object Fields

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

Nested Schema : Fields

Type: object

Show Source

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

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

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

Type: object

Show Source

• requests(optional): array requests

{
    "properties":{
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReqUpdateResponseEntity"
            }
        }
    }
}

Nested Schema : requests

Type: array

Show Source

• Array of: object ReqUpdateResponseEntity

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

Nested Schema : ReqUpdateResponseEntity

Type: object

Show Source

• id(optional): string
• links(optional): array links
• reason(optional): string
• requestId(optional): string
• status(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "reason":{
            "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"
        }
    }
}

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Resource not found

500 Response

Internal Server Error

Back to Top

Examples

This example demonstrates the ability to approve pending requests.

cURL Example

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/requests

Example of PUT Request Body

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

{
    "requests": [
        {
            "id": "1003",
            "actionComment": "rest sysadmin approved",
            "action": "approve"
        },
        {
            "id": "23",
            "actionComment": "rest sysadmin reject",
            "action": "reject"
        }
    ]
}

Example of PUT 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"
        }
    ],
    "requests": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1003"
                }
            ],
            "id": "1003",
            "status": "SUCCESS"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/23"
                }
            ],
            "id": "23",
            "status": "SUCCESS"
        }
    ]
}

Back to Top