REST API for Oracle Identity Governance Self Service

Get Certification Task Details Based on Certification ID

get

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

Returns the specified certification task details.

Request

Supported Media Types

application/json

Path Parameters

certid(required): string

Certification ID
taskid(required): string

Certification Tasks ID

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : SingleCertTaskDetails

Type: object

Show Source

certificationDate: string
certificationInstance: object CertificationInstance
certLineitems: array certLineitems
comment: string
percentComplete: string
reviewer: object TaskReviewer
startDate: string
status: string
taskId: string
taskName: string

{
    "properties":{
        "certificationInstance":{
            "$ref":"#/definitions/CertificationInstance"
        },
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "reviewer":{
            "$ref":"#/definitions/TaskReviewer"
        },
        "certificationDate":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "certLineitems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/lineItemsInfo"
            }
        },
        "percentComplete":{
            "type":"string"
        }
    }
}

Nested Schema : CertificationInstance

Type: object

Show Source

id: string
links: array links

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

Nested Schema : certLineitems

Type: array

Show Source

Array of: object lineItemsInfo

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

Nested Schema : TaskReviewer

Type: object

Show Source

links: array links
reviewerId: string

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

Type: object

Show Source

href: string
rel: string

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

Nested Schema : lineItemsInfo

Type: object

Show Source

accounts: integer
action: integer
certifiedBy: string
comments: string
dateCertified: string
entitlements: integer
itemRisk: integer
lineItem: object lineItemLink
links: object LinkDataInstances
percentComplete: integer
roles: integer

{
    "properties":{
        "lineItem":{
            "$ref":"#/definitions/lineItemLink"
        },
        "action":{
            "type":"integer"
        },
        "certifiedBy":{
            "type":"string"
        },
        "percentComplete":{
            "type":"integer"
        },
        "itemRisk":{
            "type":"integer"
        },
        "dateCertified":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "accounts":{
            "type":"integer"
        },
        "entitlements":{
            "type":"integer"
        },
        "roles":{
            "type":"integer"
        },
        "links":{
            "$ref":"#/definitions/LinkDataInstances"
        }
    }
}

Nested Schema : lineItemLink

Type: object

Show Source

lineItemId: string
links: object LinkDataInstances

{
    "properties":{
        "lineItemId":{
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/LinkDataInstances"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object LinkDataInstances

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Examples

This example retrieves the information for a given task for a given certification. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  
https://pseudo.com/iam/governance/selfservice/api/v1/certifications/3/tasks/bea5a9e0-8e4c-455f-
a34b-33ca190f0bce

Example of GET 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/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce"
        }
    ],
    "taskId": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce",
    "taskName": "usercert  [ Bud Spencer ] Reassigned [ Ajay Arora ]",
    "reviewer": {
        "links": [
            {
                "rel": "reviewer",
                "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/16"
            }
        ],
        "id": "16",
        "displayName": "Ajay Arora"
    },
    "status": 1,
    "certificationInstance": {
        "id": "3"
    },
    "startDate": "2019-04-01T20:09:53Z",
    "certificationState": "11",
    "certLineitems": {
        "links": [
            {
                "rel": "self",
                "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce/lineitems"
            }
        ],
        "certLineItemList": [
            {
                "links": [
                    {
                        "rel": "self",
                        "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce/lineitems/3"
                    }
                ],
                "entityId": 3
            }
        ]
    },
    "percentComplete": 0
}