Jump to

• Request
• Response
• Examples

Gets All the Execution History Details of a Job

get

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

Returns the complete job history of a given job.

Request

Path Parameters

• appid: string
  Name of the application
• 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 ApplicationJobHistory

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

Nested Schema : ApplicationJobHistory

Type: object

Show Source

• customParams(optional): array customParams
• customStatus(optional): string
• errorData(optional): array errorData
• exceptionObject(optional): object exceptionObject
• id: number
• infotype: string
• jobEndTime(optional): number
• jobName: string
• jobRunParams(optional): array jobRunParams
• jobStartTime: number
• status: string

{
    "type":"object",
    "required":[
        "id",
        "jobName",
        "infotype",
        "jobStartTime",
        "status"
    ],
    "properties":{
        "id":{
            "type":"number"
        },
        "jobName":{
            "type":"string"
        },
        "infotype":{
            "type":"string"
        },
        "jobStartTime":{
            "type":"number"
        },
        "jobEndTime":{
            "type":"number"
        },
        "status":{
            "type":"string"
        },
        "errorData":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "exceptionObject":{
            "type":"object"
        },
        "customStatus":{
            "type":"string"
        },
        "jobRunParams":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        },
        "customParams":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        }
    }
}

Nested Schema : customParams

Type: array

Show Source

• Array of: object ReconJobParameter

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

Nested Schema : errorData

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : exceptionObject

Type: object

Nested Schema : jobRunParams

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 the complete execution history details 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

Response Body Example

    [     
      {        
         "id":944,      
         "jobName":"db2 Target Recon Job",      
         "infotype":"S",      
         "jobStartTime":"2018-09-12T23:55:27.104-07:00",      
         "jobEndTime":"2018-09-12T23:55:27.188-07:00",      
         "status":"2",      
         "jobRunParams":[           
            {              
               "name":"Filter",            
               "value":"",            
               "helpText":"Filter",            
               "dataType":"String"         
            },         
            {  
               "name":"Object Type",            
               "value":"User",            
               "helpText":"Object Type",            
               "dataType":"String"         
            },         
            {              
               "name":"Application Name",            
               "value":"db2",            
               "helpText":"Application Name",            
               "dataType":"String"        
            }      
         ],      
         "customParams":[           
            {              
               "name":"Attributes List",            
               "value":"[EMPLOYEE_ID, EXPENSE_ROLES, COMMON_NAME, USR_INITIALS, DEPARTMENT, __UID__, LAST_NAME, FIRST_NAME, GROUPID, JOB_CODE, PASSWORD, __NAME__, USR_TITLE, ROLEID]"         
            }      
         ]   
      },   
      {        
         "id":941,      
         "jobName":"db2 Target Recon Job",      
         "infotype":"S",      
         "jobStartTime":"2018-09-12T23:48:30.94-07:00",      
         "jobEndTime":"2018-09-12T23:48:31.513-07:00",      
         "status":"2",      
         "jobRunParams":[           
            {              
               "name":"Filter",            
               "value":"",            
               "helpText":"Filter",            
               "dataType":"String"         
            },         
            {              
               "name":"Object Type",            
               "value":"User",            
               "helpText":"Object Type",            
               "dataType":"String"         
            },         
            {              
               "name":"Application Name",            
               "value":"db2",            
               "helpText":"Application Name",            
               "dataType":"String"         
            }      
         ],      
         "customParams":[           
            {              
               "name":"Attributes List",            
               "value":"[EMPLOYEE_ID, EXPENSE_ROLES, COMMON_NAME, USR_INITIALS, DEPARTMENT, __UID__, LAST_NAME, FIRST_NAME, GROUPID, JOB_CODE, PASSWORD, __NAME__, USR_TITLE, ROLEID]"                     }      
         ]   
     }
  ]

Back to Top