Jump to

• Request
• Response
• Examples

Add a Given Provisioning Task in Given Provisioning Process Definition

put

/iam/governance/selfservice/api/v1/provprocesses/{processid}

Request

Supported Media Types

• application/json

Path Parameters

• processid: string
  Process ID

Body ()

Provisioning process inputs

Root Schema : ProvisioningProcessRequestInstance

Type: object

Show Source

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

{
    "properties":{
        "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

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

The following example shows how to add a given Provisioning task to a given provisioning process 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, seeUse cURL.

 curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provprocess"  -u username:password  -d '{
    "action":"addTask",
	"fields" : [
		{
			"name": "Process Definition.Tasks.Key",
			"value": "374"
		}
		]
  }'http://pseudo.com/iam/governance/selfservice/api/v1/provprocesses/18

Example of PUT Request Body

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

{
	"action":"addTask",
	"fields" : [
		{
			"name": "Process Definition.Tasks.Key",
			"value": "374"
		}
		]
}

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

Back to Top