Endpoint
/api/v2/tenants{tenantId}/jobs/{jobId}

Partners and service providers have permission to delete a client job.

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

jobId
string

Job unique identifier

Responses

OK

Endpoint
/api/v2/tenants{tenantId}/jobs/{jobId}
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

jobId
string

Job unique identifier

Responses

OK

entities
array

entities.resource
id
string

jobQueued
boolean

name
string

schedule
object

schedule.pattern
schedule.startDate
script
object

script.approvalType
Approval for the job type App Install
script.configParams
Parameters to configure for the job type Network Backup Configuration
script.customScript
Script ID for the job type Custom Script
script.jobType
Job type. To view job types that OpsRamp supports, see Get Job Types API.
script.parameters
script.userType
(Optional) The user type. 1- system user, 2- Other user
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "aliasName": "",
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60",
          "resourceName": "abc",
          "resourceType": "Desktop"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "aliasName": "",
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130",
          "resourceName": "abcd",
          "resourceType": "Desktop"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    }
  ],
  "id": "4902d87c-b5df-4797-9f45-e807cd871ac9",
  "jobQueued": true,
  "name": "Ad Check List",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "jobType": "adCheckList"
  }
}
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    }
  ],
  "id": "cc242a8d-b0b4-430e-a89f-7081bc5e79b0",
  "jobQueued": true,
  "name": "Network Config Backup",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "configParams": {
      "backUpTrigger": true,
      "runTimeConfigFilesBackUp": true,
      "runtimeConfigAlert": true,
      "startUpConfigFilesBackUp": true,
      "startupConfigAlert": true,
      "versionsSaved": "ALL_VERSIONS"
    },
    "jobType": "networkconfigbackup"
  }
}
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    }
  ],
  "id": "ce1088d5-81cc-4262-b515-a75230f0d8e4",
  "jobQueued": true,
  "name": "Job - test script",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "customScript": {
      "description": "test script",
      "id": 7,
      "name": "test script",
      "platforms": [
        "WINDOWS"
      ]
    },
    "parameters": [
      {
        "name": "String",
        "paramId": 2,
        "value": "150"
      }
    ],
    "userType": 2
  }
}
Endpoint
/api/v2/tenants{tenantId}/jobs/{jobId}
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

jobId
string

Job unique identifier

entities
array

entities.resource
id
string

jobQueued
boolean

name
string

schedule
object

schedule.pattern
schedule.startDate
script
object

script.approvalType
Approval for the job type App Install
script.configParams
Parameters to configure for the job type Network Backup Configuration
script.customScript
Script ID for the job type Custom Script
script.jobType
Job type. To view job types that OpsRamp supports, see Get Job Types API.
script.parameters
script.userType
(Optional) The user type. 1- system user, 2- Other user
{
  "entities": [
    {
      "resource": {
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "4902d87c-b5df-4797-9f45-e807cd871ac9",
  "jobQueued": "true",
  "name": "Ad Check List",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": "2",
      "repeatType": "Days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:10+0000"
  },
  "script": {
    "jobType": "adCheckList"
  }
}
{
  "entities": [
    {
      "resource": {
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "8a87f644-0bdc-4d5a-9e41-0ca333b71acd",
  "jobQueued": "true",
  "name": "test",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": "2",
      "repeatType": "Days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:10+0000"
  },
  "script": {
    "approvalType": {
      "alertRequired": "true",
      "approvalReason": "for testing",
      "approvalType": "1"
    },
    "jobType": "appinstall"
  }
}
{
  "entities": [
    {
      "resource": {
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "ce1088d5-81cc-4262-b515-a75230f0d8e4",
  "jobQueued": "true",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": "2",
      "repeatType": "Days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:10+0000"
  },
  "script": {
    "customScript": {
      "id": "7"
    },
    "jobType": "custom",
    "parameters": [
      {
        "paramId": "2",
        "value": "150"
      }
    ],
    "userType": "2"
  }
}
{
  "entities": [
    {
      "resource": {
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "cc242a8d-b0b4-430e-a89f-7081bc5e79b0",
  "jobQueued": "true",
  "name": "Network Config Backup",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": "2",
      "repeatType": "Days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:10+0000"
  },
  "script": {
    "configParams": {
      "backUpTrigger": "true",
      "runTimeConfigFilesBackUp": "true",
      "runtimeConfigAlert": "true",
      "startUpConfigFilesBackUp": "true",
      "startupConfigAlert": "true",
      "versionsSaved": "ALL_VERSIONS"
    },
    "jobType": "networkconfigbackup"
  }
}

Responses

OK

entities
array

entities.resource
id
string

jobQueued
boolean

name
string

schedule
object

schedule.pattern
schedule.startDate
script
object

script.approvalType
Approval for the job type App Install
script.configParams
Parameters to configure for the job type Network Backup Configuration
script.customScript
Script ID for the job type Custom Script
script.jobType
Job type. To view job types that OpsRamp supports, see Get Job Types API.
script.parameters
script.userType
(Optional) The user type. 1- system user, 2- Other user
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "4902d87c-b5df-4797-9f45-e807cd871ac9",
  "jobQueued": true,
  "name": "Ad Check List",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "jobType": "adCheckList"
  }
}
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "8a87f644-0bdc-4d5a-9e41-0ca333b71acd",
  "jobQueued": true,
  "name": "test",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "approvalType": {
      "alertRequired": true,
      "approvalReason": "for testing",
      "approvalType": 1
    },
    "jobType": "appinstall"
  }
}
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "ce1088d5-81cc-4262-b515-a75230f0d8e4",
  "jobQueued": true,
  "name": "Job - test script",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "customScript": {
      "description": "test script",
      "id": 7,
      "name": "test script",
      "platforms": [
        "WINDOWS"
      ]
    },
    "parameters": [
      {
        "name": "String",
        "paramId": 2,
        "value": "150"
      }
    ],
    "userType": 2
  }
}
{
  "entities": [
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "10.233.19.130",
          "ipAddresses": "10.233.19.130"
        },
        "id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
        "type": "DEVICE"
      }
    },
    {
      "resource": {
        "clientUniqueId": "client_13",
        "generalInfo": {
          "hostName": "172.30.1.60",
          "ipAddresses": "172.30.1.60"
        },
        "id": "4e96d5bc-763c-4c00-beab-928d653a0422",
        "type": "DEVICE"
      }
    }
  ],
  "id": "cc242a8d-b0b4-430e-a89f-7081bc5e79b0",
  "jobQueued": true,
  "name": "Network Config Backup",
  "schedule": {
    "pattern": {
      "frequency": "recurrence",
      "repeatFrequency": 2,
      "repeatType": "days",
      "type": "daily"
    },
    "startDate": "2016-04-14T10:10:00+0000"
  },
  "script": {
    "configParams": {
      "backUpTrigger": true,
      "runTimeConfigFilesBackUp": true,
      "runtimeConfigAlert": true,
      "startUpConfigFilesBackUp": true,
      "startupConfigAlert": true,
      "versionsSaved": "ALL_VERSIONS"
    },
    "jobType": "networkconfigbackup"
  }
}