Jump to

• Request
• Response
• Examples

Get the Details of a Specific Job Run

get

/iam/governance/applicationmanagement/api/v1/applications/{appid}/jobs/{jobid}/history/{historyId}

Returns a specific job run status of a given job.

Request

Path Parameters

• appid: string
  Name of the application
• historyId: string
  historyId of the job
• jobid: string
  Name of the Job

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ApplicationJobResult

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

Nested Schema : ApplicationJobResult

Type: object

Show Source

• createBy(optional): string
• createTime(optional): string(date-time)
• errorLevelString(optional): string
• exceptionMessage(optional): string
• exceptionObject(optional): object exceptionObject
• id: number
• jobHistoryId: number
• params(optional): array params

{
    "type":"object",
    "required":[
        "id",
        "jobHistoryId"
    ],
    "properties":{
        "id":{
            "type":"number"
        },
        "jobHistoryId":{
            "type":"number"
        },
        "errorLevelString":{
            "type":"string"
        },
        "exceptionMessage":{
            "type":"string"
        },
        "exceptionObject":{
            "type":"object"
        },
        "createBy":{
            "type":"string"
        },
        "createTime":{
            "type":"string",
            "format":"date-time"
        },
        "params":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        }
    }
}

Nested Schema : exceptionObject

Type: object

Nested Schema : params

Type: array

Show Source

• Array of: object ReconJobParameter

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

Nested Schema : ReconJobParameter

Type: object

Show Source

• dataType(optional): string
  Allowed Values: [ "String", "Number", "Boolean", "ITResource" ]
• encrypted(optional): boolean
  Default Value: false
• helpText(optional): string
• name(optional): string
• required(optional): boolean
  Default Value: false
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "value":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "helpText":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "dataType":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "String",
                "Number",
                "Boolean",
                "ITResource"
            ]
        },
        "required":{
            "type":"boolean",
            "xml":{
                "attribute":true
            },
            "default":false
        },
        "encrypted":{
            "type":"boolean",
            "xml":{
                "attribute":true
            },
            "default":false
        }
    }
}

Back to Top

Examples

cURL Example

This example demonstrates the ability to return a specific job run status of a given job. The information shown here is against a pseudo system and serves as a prototype.

curl -X GET http://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/db2/jobs/db2%20Target%20Recon%20Job/history/941

Response Body Example

[]

Back to Top