Jump to

• Request
• Response
• Examples

Get the Details of a Particular Job for an application

get

/iam/governance/applicationmanagement/api/v1/applications/{appId}/jobs/{jobid}

Returns the job details for a given application and job name

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

Body ()

Root Schema : ApplicationJobDetails

Type: object

Show Source

• currentStatus(optional): string
• endTime(optional): number
• jobMode: string
• jobName: string
• jobScheduledType(optional): string
• lastRunEndTime(optional): number
• lastRunStartTime(optional): number
• nextFireTime(optional): number
• parameter(optional): array parameter
• receiverID(optional): string
• receiverType(optional): string
• retries(optional): integer
• runEvery(optional): number
• startTime(optional): number
• taskName: string
• taskStatus: boolean
  Default Value: true

{
    "type":"object",
    "required":[
        "jobName",
        "jobMode",
        "taskName",
        "taskStatus"
    ],
    "properties":{
        "jobName":{
            "type":"string"
        },
        "jobMode":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "jobScheduledType":{
            "type":"string"
        },
        "startTime":{
            "type":"number"
        },
        "endTime":{
            "type":"number"
        },
        "nextFireTime":{
            "type":"number"
        },
        "lastRunStartTime":{
            "type":"number"
        },
        "lastRunEndTime":{
            "type":"number"
        },
        "currentStatus":{
            "type":"string"
        },
        "retries":{
            "type":"integer"
        },
        "runEvery":{
            "type":"number"
        },
        "receiverType":{
            "type":"string"
        },
        "receiverID":{
            "type":"string"
        },
        "taskStatus":{
            "type":"boolean",
            "default":true
        },
        "parameter":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        }
    }
}

Nested Schema : parameter

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

The following example demonstrates the ability to return the job details for a given application and job name. 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/ConnectorJob

Response Body Example

{    
    "jobName": "NewConnectorJob",    
    "jobMode": "Full",    
    "taskName": "Search Recon Task",    
    "jobScheduledType": "Single",    
    "startTime": "2018-09-13T00:00:00-07:00",    
    "nextFireTime": "2018-09-13T00:00:00-07:00",    
    "retries": 5,    
    "runEvery": 1,    
    "receiverType": "User",    
    "receiverID": "",    
    "taskStatus": true,    
    "reconjobprarameters": {        
        "parameter": [            
            {                
                "name": "Object Type",                
                "value": "User",                
                "helpText": "Object Type",                
                "dataType": "String",                
                "required": true            
            },            
            {                
                "name": "Application Name",                
                "value": "db2",                
                "helpText": "Application Name",                
                "dataType": "String",                
                "required": true            
            }        
        ]    
    }
}

Back to Top