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

• Array of: 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

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

Type: object

Show Source

• tasks(optional): array tasks

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

Nested Schema : tasks

Type: array

Show Source

• Array of: 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

• 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

Default Response

Unexpected error

Back to Top

Examples

Example to Show How to Update Multiple Provisioning Tasks

The following example shows how to update multiple provisioning tasks in a single request by submitting a PUT request on the REST resource using cURL. The information shown here is against a pseudo system and serves as a prototype. For more information about cURL, see Use cURL.

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

Example of PUT Request Body

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

{
 "tasks":[
     {
	   "id" : "3016",
	   "requestId" : "10001",
           "action": "reassign",
	   "fields": [
		  {
			"name": "assignee",
			"value": "23"
		  },
		  {
			"name": "type",
			"value": "user"
		  }
	    ]
     },
     {
     	  "id" : "3018",
     	  "requestId" : "10002",
   	  "action": "reassign",
	  "fields": [
		  {
			"name": "assignee",
			"value": "23"
		  },
		  {
			"name": "type",
			"value": "user"
		  }
	    ]
     }
  ]
}

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/provtasks"
        }
    ],
    "tasks": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": 
"https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/3018"
                }
            ],
            "id": "3018",
            "status": "SUCCESS",
            "requestId": "10002",
            "action": "reassign"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": 
"https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/3016"
                }
            ],
            "id": "3016",
            "status": "SUCCESS",
            "requestId": "10001",
            "action": "reassign"
        }
    ]
}

Example to Show How to Bulk Retry the Provisioning Tasks

The following example shows how to bulk retry the provisioning tasks by submitting a PUT request on the REST resource using cURL. The information shown here is against a pseudo system and serves as a prototype.

 curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provtask"  -u username:password  -d '{
		"tasks": [
			{
				"id":"<Prov-Task_ID>",		
				"action":"retry",
				"taskId":"<Prov-Task_ID>" 
	     },
         { 
		      "id":"<Prov-Task_ID>", 
			  "action":"retry", 
			  "taskId":"<Prov-Task_ID>" 
	      }
        ]
  }'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":"<Prov-Task_ID>", 
			 "action":"retry", 
			 "taskId":"<Prov-Task_ID>" 
	      },
          { 
		      "id":"<Prov-Task_ID>", 
			  "action":"retry", 
			  "taskId":"<Prov-Task_ID>" 
	      }
        ]
}

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/provtasks"
        }
    ],
    "tasks": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/30"
                }
            ],
            "id": "30",
            "status": "FAIL",
            "action": "retry",
            "reason": "This task is not automated. If task is completed, set status to UC."
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/31"
                }
            ],
            "id": "31",
            "status": "FAIL",
            "action": "retry",
            "reason": "This task is not automated. If task is completed, set status to UC."
        }
    ]
}

Back to Top