Jump to

• Request
• Response
• Examples

Get Task Information for a Certification

get

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

Returns all the task(s) within the certification ID. The tasks of the certification for which the logged in user is the primary reviewer will be returned. The functionality maps to the Dashboard view of certification tasks in Identity Console.

Request

Supported Media Types

• application/json

Path Parameters

• certid: string
  Certification ID

Query Parameters

• fields(optional): string
  Attributes to be returned in the result.Comma-separated attributes are accepted. Sample value for attributes is "name, status, type and so on."
• q(optional): string
  Search filter to get return subset of task information.

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

Type: object

Show Source

• certifications(optional): array certifications
• count(optional): integer
• links(optional): array links
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "totalResult":{
            "type":"integer"
        },
        "certifications":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CertTasks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : certifications

Type: array

Show Source

• Array of: object CertTasks

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : CertTasks

Type: object

Show Source

• certificationInstance(optional): object CertificationInstance
• certificationState(optional): string
• links(optional): array links
• reviewer(optional): object Reviewer
• startDate(optional): string
• status(optional): string
• taskId(optional): string
• taskName(optional): string

{
    "properties":{
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "reviewer":{
            "$ref":"#/definitions/Reviewer"
        },
        "status":{
            "type":"string"
        },
        "certificationInstance":{
            "$ref":"#/definitions/CertificationInstance"
        },
        "startDate":{
            "type":"string"
        },
        "certificationState":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : CertificationInstance

Type: object

Show Source

• id(optional): string
• links(optional): array links

{
    "properties":{
        "id":{
            "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 : Reviewer

Type: object

Show Source

• id(optional): string
• links(optional): array links

{
    "properties":{
        "id":{
            "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(optional): string
• rel(optional): string

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

401 Response

Unauthorized

404 Response

Entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example retrieves all tasks 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/21/tasks

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/21/tasks"
        }
    ],
    "count": 1,
    "certifications": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58"
                }
            ],
            "state": "ASSIGNED",
            "name": "usercert [ Ajay Arora ]",
            "type": "User",
            "id": "21",
            "asignee": "aarora",
            "createdDate": "2019-04-08T16:33:18Z",
            "soaTaskId": "6899dc3d-645c-42b1-8d9d-39eb9719261f",
            "taskId": "e1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58"
        }
    ]
}

Back to Top