Jump to

• Request
• Response
• Examples

Adds a New Job

post

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

Adds a new job to an existing Application.

Request

Supported Media Types

• application/json

Path Parameters

• appId: string
  Name of the application

Body ()

Job details of the new job which have to be added to the application.

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

Response

Default Response

Successful operation

Back to Top

Examples

cURL Example

This example demonstrates the ability to add a new job to an existing application. The information shown here is against a pseudo system and serves as a prototype.

curl -X POST http://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/db2/jobs -H 'content-type: application/json'  -d @jobBody.json

Request Body Example

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

Response Body Example

Job NewConnectorJob saved successfully for task Search Recon Task.

Back to Top