Update provisioning tasks

put

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

Updates all provisioning tasks as part of payload list.

Request

Supported Media Types
Body ()
Provisioning task inputs
Root Schema : BulkProvisioningTaskRequest
Type: object
Show Source
Nested Schema : tasks
Type: array
Show Source
Nested Schema : TaskRequest
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : Fields
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : BulkProvisioningTaskResponse
Type: object
Show Source
Nested Schema : tasks
Type: array
Show Source
Nested Schema : BulkProvisioningTaskResponseInstance
Type: object
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source

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