REST API for Oracle Identity Governance Self Service

Update Certification Task

put

/iam/governance/selfservice/api/v1/certifications/{certid}/tasks/{taskid}

Updates the certification task specified by the task ID. The updates which can be done to the task are, reassigning the task, completing task, expire task, create proxy for task and reset a task.

Request

Supported Media Types

application/json

Path Parameters

certid(required): string

Certification ID
taskid(required): string

Task ID

Root Schema : PutCertificationsTasksByTaskIdRequest

Type: object

Show Source

action: string
fields: array fields

{
    "properties":{
        "action":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PutCertificationsTasksByTaskIdRequestField"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

Array of: object PutCertificationsTasksByTaskIdRequestField

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

Nested Schema : PutCertificationsTasksByTaskIdRequestField

Type: object

Show Source

field: string

{
    "properties":{
        "field":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : PutCertificationsTasksByTaskIdResponse

Type: object

Show Source

action: string
fields: array fields
id: string
links: array links
status: string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PutCertificationsTasksByTaskIdResponseField"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

Array of: object PutCertificationsTasksByTaskIdResponseField

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

Nested Schema : links

Type: array

Show Source

Array of: object LinkDataInstances

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

Nested Schema : PutCertificationsTasksByTaskIdResponseField

Type: object

Show Source

field: string

{
    "properties":{
        "field":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

href: string
rel: string

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Examples

The following example updates a certification task. The information shown here is against a pseudo system and serves as a prototype.

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/certifications/21/tasks/e1d5e5dd-5f9e-4747
-bd5f-e00dc0b99d58

Example of PUT Request Body

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

{
   "action" : "suspend"
}

Example of the Response Body

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58/"
        }
    ],
    "id": "e1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58",
    "action": "suspend",
    "status": "SUCCESS",
    "fields": [
        {
            "name": "state",
            "value": "SUSPENDED"
        },
        {
            "name": "assignees",
            "value": [
                "Ajay Arora"
            ]
        }
    ]
}