Jump to

• Request
• Response
• Examples

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

Body ()

Provisioning task inputs

Root Schema : ProvisioningTaskRequestInstance

Type: object

Show Source

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

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

• 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

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

Example to Show How to Update a Provisioning Task

The following example shows how to update a provisioning task 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/3009

Example of PUT Request Body

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

{
	"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/3009"
        }
    ],
    "id": "3009",
    "status": "SUCCESS"
}

Example to Show How to Update a Note in a Given Provisioning Task

The following example shows how to update a note in a given Provisioning task by its ID 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 '{
       "action": "setNote",  
       "fields" : [
           {
                "name": "Process Instance.Task Details.Note",
                "value": "Updated value of Note-NB"
           }
        ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

Example of PUT Request Body

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

{
    "action": "setNote",  
       "fields" : [
           {
                "name": "Process Instance.Task Details.Note",
                "value": "Updated value of Note-NB"
           }
        ]
}

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/6"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

Example to Show How to Update a Response in a Given Provisioning Task

The following example shows how to update a response in given provisioning task by its ID 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 '{
       "action": "setResponse",  
       "fields" : [
           {
                "name": "Process Definition.Tasks.Responses.Response",     
				"value": "VALIDATION_FAILED"
           }
         ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

Example of PUT Request Body

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

{
     "action": "setResponse",  
       "fields" : [
           {
                "name": "Process Definition.Tasks.Responses.Response",     
				"value": "VALIDATION_FAILED"
           }
         ]
}

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/6"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

Example to Show How to Reassign a Given Provisioning Task

The following example shows how to reassign a given Provisioning task by its ID 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 '{
       "action": "reassign", 
       "fields" : [
         {
           "name": "type",
           "value": "user"
         },
         {
           "name": "assignee",
           "value": "1001"
         }
        ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

Example of PUT Request Body

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

{
     "action": "reassign", 
       "fields" : [
         {
           "name": "type",
           "value": "user"
         },
         {
           "name": "assignee",
           "value": "1"
         }
        ]
}

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/6"
        },
        {
            "rel": "assignee",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1//users/1"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

Example to Show How to Retry a Given Provisioning Task

The following example shows how to retry a given provisioning task by its ID 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 '{
       "action": "retry"
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

Example of PUT Request Body

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

{
     "action": "retry"
}

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/6"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

Back to Top