REST API for Oracle Identity Governance Self Service

Update provisioning task

put

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

Updates provisioning task based on the task id.

Request

Supported Media Types

application/json

Path Parameters

taskid: string

Task ID

Provisioning task inputs

Root Schema : ProvisioningTaskRequestInstance

Type: object

Show Source

fields(optional): array fields
requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

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

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : ProvisioningTaskResponseInstance

Type: object

Show Source

assignee(optional): string
id(optional): string
links(optional): array links
status(optional): string

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

Nested Schema : links

Type: array

Show Source

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

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Examples

This demonstrates the ability to update a provisioning task. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/5126

Example of PUT Request Body

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

{
  "id": "5126",
  "requestId": "10001",
  "fields": [
    {
      "name": "Process Instance.Task Details.Note",
      "value": "Updated value of Note-Sonia4"
    },
    {
      "name": "Process Instance.Task Details.Projected End",
      "value": "2016-02-21"
    }
  ]
}

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/provtasks/5126"
    }
  ],
  "id": "5126",
  "status": "OK",
  "assignee": "System Administrator"
}