Jump to

• Request
• Response
• Examples

Update provisioning tasks

put

/iam/governance/selfservice/api/v1/provtasks

Updates all provisioning tasks as part of payload list.

Request

Supported Media Types

• application/json

Body ()

Provisioning task inputs

Root Schema : BulkProvisioningTaskRequest

Type: object

Show Source

• tasks(optional): array tasks

{
    "properties":{
        "tasks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskRequest"
            }
        }
    }
}

Nested Schema : tasks

Type: array

Show Source

• [0]: object TaskRequest

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

Nested Schema : TaskRequest

Type: object

Show Source

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

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

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

Type: object

Show Source

• tasks(optional): array tasks

{
    "properties":{
        "tasks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BulkProvisioningTaskResponseInstance"
            }
        }
    }
}

Nested Schema : tasks

Type: array

Show Source

• [0]: object BulkProvisioningTaskResponseInstance

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

Nested Schema : BulkProvisioningTaskResponseInstance

Type: object

Show Source

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

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

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

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This demonstrates the ability to update multiple provisioning tasks in a single request. 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

Example of PUT Request Body

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

{
  "tasks": [
    {
      "id": "8062",
      "requestId": "10001",
      "fields": [
        {
          "name": "Process Instance.Task Details.Note",
          "value": "Updated value of Note-Sonia4"
        },
        {
          "name": "Process Instance.Task Details.Projected End",
          "value": "2016-05-21"
        }
      ]
    },
    {
      "id": "8059",
      "requestId": "8059",
      "fields": [
        {
          "name": "Process Instance.Task Details.Note",
          "value": "Updated value of Note-Sonia4"
        },
        {
          "name": "Process Instance.Task Details.Projected End",
          "value": "2016-05-21"
        },
        {
          "name": "Process Instance.Task Details.Projected Start",
          "value": "2016-05-22"
        }
      ]
    }
  ]
}

Example of PUT Response Body

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

{
  "tasks": [
    {
      "id": "8062",
      "requestId": "10001",
      "fields": [
        {
          "name": "Process Instance.Task Details.Note",
          "value": "Updated value of Note-Sonia4"
        },
        {
          "name": "Process Instance.Task Details.Projected End",
          "value": "2016-05-21"
        }
      ]
    },
    {
      "id": "8059",
      "requestId": "8059",
      "fields": [
        {
          "name": "Process Instance.Task Details.Note",
          "value": "Updated value of Note-Sonia4"
        },
        {
          "name": "Process Instance.Task Details.Projected End",
          "value": "2016-05-21"
        },{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks"
    }
  ],
  "tasks": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/8062"
        }
      ],
      "id": "8062",
      "status": " SUCCESS",
      "requestId": "10001"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/provtasks/8059"
        }
      ],
      "id": "8059",
      "status": " FAIL",
      "requestId": "8059",
      "reason": "oracle.iam.rest.commons.exceptions.InvalidInputException: Start Date is greater then End Date"
    }
  ]
}

        {
          "name": "Process Instance.Task Details.Projected Start",
          "value": "2016-05-22"
        }
      ]
    }
  ]
}

Back to Top