Jump to

• Request
• Response
• Examples

Update request based on request id

put

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

Updates the specified request. The Oracle Identity Manager request id should be specified in the path parameter. The update details to update the request should be provided in the payload. The request data can be 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's could be APPROVE,RELEASE, RESUME, REASSIGN, REJECT, ESCALATE, SUSPEND, WITHDRAW, CLAIM, SAVE, CREATESUBTASK, SKIPASSIGNMENT . Addition to these we have one additions operation of CLOSE, which can be performed on the Requests. An Additional TaskId can be provided with the request to exclusively perform 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 on the requestId.

Request

Supported Media Types

• application/json

Path Parameters

• reqid: string
  Request ID

Body ()

List of attributes of request to be updated

Root Schema : ReqUpdateRequest

Type: object

Show Source

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

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "actionComment":{
            "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 : 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 a pending request.

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/1235

Example of PUT Request Body

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

{
  "requestId": "coder-1001",
  "taskId": "2c91aeca-9169-47fd-847f-466763af278a",
  "action": "approve"
}

Example of PUT Response Body

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

{
  "links": [
    {
      "rel": "self",
      "href": "https://pseudo.com/iam/governance/selfservice/api/v1/requests/1235"
    }
  ],
  "id": "1235",
  "requestId": "coder-1001",
  "status": "SUCCESS"
}

Back to Top