REST API for Scheduler in OIG

Get the milestones of the specific execution history

get

/iam/governance/selfservice/api/v1/scheduler/jobs/{jobName}/history/{historyID}

Returns a paginated list of milestone details associated with a specific execution history.

Request

Path Parameters

historyID: integer

ID of the execution history
jobName: string

Name of the job

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(optional): integer(int32)
hasMore(optional): boolean
limit(optional): integer(int32)
milestones(optional): object Milestones
totalResult(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "totalResult":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "milestones":{
            "type":"object",
            "$ref":"#/definitions/Milestones"
        }
    }
}

Nested Schema : Milestones

Type: object

Show Source

createBy(optional): string
createTime(optional): string(date-time)

Format: yyyy-MM-dd'T'HH:mm:ss'Z'
errorLevelString(optional): string
exceptionMessage(optional): string
id(optional): integer(int32)
jobHistoryId(optional): integer(int32)
parameters(optional): array parameters

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "jobHistoryId":{
            "type":"integer",
            "format":"int32"
        },
        "errorLevelString":{
            "type":"string"
        },
        "exceptionMessage":{
            "type":"string"
        },
        "createBy":{
            "type":"string"
        },
        "createTime":{
            "type":"string",
            "format":"date-time",
            "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
        },
        "parameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "key":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

key(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        }
    }
}

400 Response

Invalid input

Examples

The following example shows how to retrieve a paginated list of milestone details associated with a specific execution history by submitting the GET request using cURL. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl -i -X GET -u username:password / 
--header 'Accept: application/json' /
--header 'Content-Type: application/json' /
'http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog Synchronization Job/history/5966/milestones'

Example of Response Body

The following example shows the JSON response for a retrieval request for a list of milestone details associated with a specific execution history:

{
    "links": [
        {
            "rel": "self",
            "href": "pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history/5966/milestones"
        },
        {
            "rel": "self",
            "href": "pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history/5966/milestones?offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history/5966/milestones?offset=1&limit=10"
        }
    ],
    "count": 0,
    "hasMore": false,
    "totalResult": -1,
    "milestones": []
}