Jump to

• Request
• Response
• Examples

Updates the Job of an Application

put

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

Updates a particular job of a given application.

Request

Supported Media Types

• application/json

Path Parameters

• appId: string
  Name of the application
• jobid: string
  Name of the job

Query Parameters

• operation(optional): string
  operations : enable/disable/run/stop/update supported on the job

Body ()

Details of the updated job.

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

Back to Top

Examples

cURL Example

The following example shows how to perform an enable, disable, run, stop, or an update operation on the job of a given application. The information shown here is against a pseudo system and serves as a prototype.

curl -X PUT 'http://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/db2/jobs/db2%20Target%20Recon%20Job?operation=update' -d @jobUpdate.json

Request Body Example

{  
   "jobName":"db2 Target Recon Job",
   "jobMode":"Full",
   "taskName":"Search Recon Task",
   "jobScheduledType":"None",
   "nextFireTime":"",
   "retries":5,
   "receiverType":"User",
   "taskStatus":true,
   "reconjobprarameters":{  
      "parameter":[  
         {  
            "name":"Application Name",
            "value":"db",
            "helpText":"Application Name",
            "dataType":"String"
         },
         {  
            "name":"Filter",
            "value":"",
            "helpText":"Filter",
            "dataType":"String"
         },
         {  
            "name":"Object Type",
            "value":"DBUser",
            "helpText":"Object Type",
            "dataType":"String"
         }
      ]
   }
}

Response Body Example

db2 Target Recon Job update is successful.

Back to Top