Jump to

• Request
• Response

Get All Provisioning Tasks

get

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

Returns all the provisioning tasks which are assigned to the logged in user. The provisioning tasks can be filtered based on the Application Instance name, the target user i.e. the beneficiary and/or on the status of the task. For example to get all provisioning tasks assigned to the logged in user for application instance Payroll and with status Rejected the URL is /provtasks?q=Objects.Name+eq+Payroll AND Status.Category+eq+Rejected. The return attributes cannot be filtered based on the fields query parameter.

Request

Supported Media Types

• application/json

Query Parameters

• q(optional): string
  Search filter to get the records. SCIM filter is accepted. There should not be any spaces for attribute value. If you want to pass space in between attribute values then replace it with "::". The result can be filtered based on the status of the provisioning tasks. For example to get all provisioning tasks which are rejected the filter parameter will be /provtasks?q=Process::Instance.Task::Details.Status eq Rejected. To find the provisioning tasks associated with an application instance /provtasks?q=Objects.Name eq Plan::View

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

Type: object

Show Source

• count(optional): number
• hasMore(optional): boolean
• links(optional): array links
• tasks(optional): array tasks
• totalResult(optional): number

{
    "properties":{
        "count":{
            "type":"number"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"number"
        },
        "tasks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProvTask"
            }
        },
        "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 : tasks

Type: array

Show Source

• Array of: object ProvTask

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

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : ProvTask

Type: object

Show Source

• fields(optional): array fields
• links(optional): array links

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "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 : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top