Jump to

• Request
• Response
• Examples

Get Certification History

get

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

Returns the certification history.

Request

Supported Media Types

• application/json

Path Parameters

• certid: string
  Certification ID
• taskid: string
  Task UID

Query Parameters

• fields(optional): string
  Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for supported attributes is "name, comment, certifier and so on."
• q(optional): string
  Certification configuration

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

Type: object

Show Source

• certId(optional): integer
• certificationType(optional): string
• count(optional): integer
• hasMore(optional): boolean
• lineItems(optional): array lineItems
• taskUid(optional): string
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "certId":{
            "type":"integer"
        },
        "taskUid":{
            "type":"string"
        },
        "certificationType":{
            "type":"string"
        },
        "lineItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/lineItemsForTask"
            }
        }
    }
}

Nested Schema : lineItems

Type: array

Show Source

• Array of: object lineItemsForTask

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

Nested Schema : lineItemsForTask

Type: object

Show Source

• actionHistoryList(optional): array actionHistoryList
• lineItemDetails(optional): array lineItemDetails
• lineItemDetailsForPolicy(optional): array lineItemDetailsForPolicy
• lineItemId(optional): integer
• links(optional): array links

{
    "properties":{
        "lineItemId":{
            "type":"integer"
        },
        "actionHistoryList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/actionHistoryList"
            }
        },
        "lineItemDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/lineItemDetailsForTask"
            }
        },
        "lineItemDetailsForPolicy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/lineItemDetailsForTask"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : actionHistoryList

Type: array

Show Source

• Array of: object actionHistoryList

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

Nested Schema : lineItemDetails

Type: array

Show Source

• Array of: object lineItemDetailsForTask

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

Nested Schema : lineItemDetailsForPolicy

Type: array

Show Source

• Array of: object lineItemDetailsForTask

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : actionHistoryList

Type: object

Show Source

• action(optional): integer
• actorDisplayName(optional): string
• actorId(optional): integer
• actorTaskUID(optional): string
• certState(optional): integer
• comments(optional): string
• eventId(optional): integer
• eventTimestamp(optional): string
• recipientDisplayName(optional): string
• recipientId(optional): integer
• recipientTaskUID(optional): string
• relatedCertId(optional): integer

{
    "properties":{
        "action":{
            "type":"integer"
        },
        "actorDisplayName":{
            "type":"string"
        },
        "actorId":{
            "type":"integer"
        },
        "actorTaskUID":{
            "type":"string"
        },
        "certState":{
            "type":"integer"
        },
        "comments":{
            "type":"string"
        },
        "eventId":{
            "type":"integer"
        },
        "eventTimestamp":{
            "type":"string"
        },
        "recipientDisplayName":{
            "type":"string"
        },
        "recipientId":{
            "type":"integer"
        },
        "recipientTaskUID":{
            "type":"string"
        },
        "relatedCertId":{
            "type":"integer"
        }
    }
}

Nested Schema : lineItemDetailsForTask

Type: object

Show Source

• actionHistoryList(optional): array actionHistoryList
• certificationHistoryList(optional): array certificationHistoryList
• lineItemDetailId(optional): integer

{
    "properties":{
        "lineItemDetailId":{
            "type":"integer"
        },
        "actionHistoryList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/actionHistoryList"
            }
        },
        "certificationHistoryList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/certificationHistoryList"
            }
        }
    }
}

Nested Schema : actionHistoryList

Type: array

Show Source

• Array of: object actionHistoryList

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

Nested Schema : certificationHistoryList

Type: array

Show Source

• Array of: object certificationHistoryList

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

Nested Schema : certificationHistoryList

Type: object

Show Source

• certificationComments(optional): string
• certificationDate(optional): string
• certificationName(optional): string
• certificationStatus(optional): integer
• certificationType(optional): integer
• certifiedBy(optional): string
• id(optional): integer

{
    "properties":{
        "certificationStatus":{
            "type":"integer"
        },
        "certificationComments":{
            "type":"string"
        },
        "certificationName":{
            "type":"string"
        },
        "certifiedBy":{
            "type":"string"
        },
        "certificationDate":{
            "type":"string"
        },
        "certificationType":{
            "type":"integer"
        },
        "id":{
            "type":"integer"
        }
    }
}

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

This example retrieves the history 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/history

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/history?offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce/history?offset=1&limit=10"
        },
        {
            "rel": "last",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce/history?offset=0&limit=10"
        }
    ],
    "count": 1,
    "hasMore": false,
    "totalResult": 1,
    "certId": 3,
    "taskUid": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce",
    "certificationType": "User",
    "lineItems": [
        {
            "lineItemId": 1,
            "actionHistoryList": [
                {
                    "action": 2,
                    "actorDisplayName": "System",
                    "actorId": -2,
                    "certState": 11,
                    "eventId": 13,
                    "eventTimestamp": "2019-04-01T20:09:52Z",
                    "recipientDisplayName": "Ajay Arora",
                    "recipientId": 16,
                    "recipientTaskUID": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce",
                    "relatedCertId": 2
                },
                {
                    "action": 15,
                    "actorDisplayName": "System",
                    "actorId": -2,
                    "certState": 11,
                    "eventId": 15,
                    "eventTimestamp": "2019-04-01T20:09:52Z",
                    "recipientDisplayName": "Ajay Arora",
                    "recipientId": 16,
                    "recipientTaskUID": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce"
                },
                {
                    "action": 3,
                    "actorDisplayName": "System",
                    "actorId": -2,
                    "certState": 11,
                    "eventId": 17,
                    "eventTimestamp": "2019-04-01T20:09:53Z"
                }
            ],
            "lineItemDetails": [
                {
                    "lineItemDetailId": 2,
                    "actionHistoryList": [
                        {
                            "action": 2,
                            "actorDisplayName": "System",
                            "actorId": -2,
                            "certState": 11,
                            "eventId": 13,
                            "eventTimestamp": "2019-04-01T20:09:52Z",
                            "recipientDisplayName": "Ajay Arora",
                            "recipientId": 16,
                            "recipientTaskUID": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce",
                            "relatedCertId": 2
                        },
                        {
                            "action": 15,
                            "actorDisplayName": "System",
                            "actorId": -2,
                            "certState": 11,
                            "eventId": 15,
                            "eventTimestamp": "2019-04-01T20:09:52Z",
                            "recipientDisplayName": "Ajay Arora",
                            "recipientId": 16,
                            "recipientTaskUID": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce"
                        }
                    ],
                    "certificationHistoryList": [
                        {
                            "certificationStatus": 3,
                            "certificationName": "usercert [ Bud Spencer ] ",
                            "certificationDate": "2019-04-01T20:09:52Z",
                            "certificationType": 3,
                            "id": 1
                        },
                        {
                            "certificationStatus": 1,
                            "certificationName": "usercert [ Bud Spencer ] ",
                            "certifiedBy": "aarora",
                            "certificationDate": "2019-04-01T20:16:53Z",
                            "certificationType": 3,
                            "id": 2
                        }
                    ]
                }
            ]
        }
    ]
}

Back to Top