Jump to

• Request
• Response
• Examples

Get Specified Certification Task Line Items

get

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

Returns the specified certification task line items.

Request

Supported Media Types

• application/json

Path Parameters

• certid: string
  Certification ID
• taskid: string
  Certification Tasks ID

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

Type: object

Show Source

• certLineItemList(optional): array certLineItemList
• count(optional): integer
• hasMore(optional): boolean
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "certLineItemList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/lineItemsInfo"
            }
        }
    }
}

Nested Schema : certLineItemList

Type: array

Show Source

• Array of: object lineItemsInfo

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

Nested Schema : lineItemsInfo

Type: object

Show Source

• accounts(optional): integer
• action(optional): integer
• certifiedBy(optional): string
• comments(optional): string
• dateCertified(optional): string
• entitlements(optional): integer
• itemRisk(optional): integer
• lineItem(optional): object lineItemLink
• links(optional): object LinkDataInstances
• percentComplete(optional): integer
• roles(optional): 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(optional): string
• links(optional): object LinkDataInstances

{
    "properties":{
        "lineItemId":{
            "type":"string"
        },
        "links":{
            "$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

Back to Top

Examples

This example retrieves the line items for a given certification and task. 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/lineitems

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/lineitems?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/lineitems?offset=1&limit=10"
        }
    ],
    "count": 1,
    "hasMore": false,
    "totalResult": -1,
    "certLineItemList": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce/lineitems/1"
                }
            ],
            "action": "1",
            "percentComplete": 100,
            "status": "CERTIFIED",
            "entityId": 3,
            "id": 1,
            "createUser": "XELSYSADM",
            "updateDate": "2019-03-29T20:35:59Z",
            "updateUser": "XELSYSADM",
            "userLogin": "BKIDDO",
            "firstName": "Beatrix",
            "lastName": "Kiddo",
            "roles": 1,
            "accounts": 0,
            "entitlements": 0,
            "employeeType": "Full-Time Employee",
            "identityStatus": "Active",
            "manager": "AARORA",
            "organization": "Vision",
            "accStatus": "false",
            "email": "[e-mail]",
            "iamUserId": 23,
            "fullName": "Kiddo, Beatrix"
        }
    ]
}

Back to Top