Get asynchronous job request (GET /v1/jobs/name/{name}/objectType/{objectType})

Get asynchronous job request

curl --request GET \
  --url https://{apiHost}/api/v1/jobs/name/{name}/objectType/{objectType} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{apiHost}/api/v1/jobs/name/{name}/objectType/{objectType}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/jobs/name/{name}/objectType/{objectType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "id": "<string>",
  "operationType": "BULK_SERVICE_UNSPECIFIED",
  "status": "JOB_STATUS_UNSPECIFIED",
  "objectList": [
    "<string>"
  ],
  "startTime": "2023-11-07T05:31:56Z",
  "finishTime": "2023-11-07T05:31:56Z",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "individualOpStatus": {},
  "selectionCriteria": {
    "projectId": "<string>",
    "bundleId": "<string>",
    "deviceIdList": [
      "<string>"
    ]
  },
  "errorDetailOfJob": "<string>",
  "title": "<string>",
  "description": "<string>",
  "projectId": "<string>"
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

name

string

required

User defined name of the job request, unique across the enterprise. Once object is created, name can’t be changed

objectType

enum<string>

required

object type for which job has been created

Available options:

OBJECT_TYPE_UNSPECIFIED,

OBJECT_TYPE_USER,

OBJECT_TYPE_EDGE_NODE,

OBJECT_TYPE_EDGE_APP,

OBJECT_TYPE_IMAGE,

OBJECT_TYPE_EDGE_APP_INSTANCE,

OBJECT_TYPE_PROJECT,

OBJECT_TYPE_NETWORK,

OBJECT_TYPE_DATASTORE,

OBJECT_TYPE_SERVICE,

OBJECT_TYPE_SERVICE_INSTANCE,

OBJECT_TYPE_ENTERPRISE,

OBJECT_TYPE_ROLE,

OBJECT_TYPE_CREDENTIAL,

OBJECT_TYPE_NETWORK_INSTANCE,

OBJECT_TYPE_VOLUME_INSTANCE,

OBJECT_TYPE_REALM,

OBJECT_TYPE_AUTHPROFILE,

OBJECT_TYPE_POLICY,

OBJECT_TYPE_APP_POLICY,

OBJECT_TYPE_CLUSTER_INSTANCE,

OBJECT_TYPE_PLUGIN,

OBJECT_TYPE_DOC_POLICY,

OBJECT_TYPE_ORCHESTRATOR_CLUSTER,

OBJECT_TYPE_TAGS,

OBJECT_TYPE_EDGE_NODE_INTERFACE,

OBJECT_TYPE_DEPLOYMENT,

OBJECT_TYPE_ENTITLEMENTS,

OBJECT_TYPE_DATA_STREAM,

OBJECT_TYPE_API_USAGE,

OBJECT_TYPE_APP_INSTANCE_SNAPSHOT,

OBJECT_TYPE_PATCH_ENVELOPE,

OBJECT_TYPE_RESOURCE_USAGE_TRACK,

OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE,

OBJECT_TYPE_DEV_PASSTHROUGH,

OBJECT_TYPE_EDGE_NODE_CLUSTER,

OBJECT_TYPE_ASSET_GROUP,

OBJECT_TYPE_APP_PROFILE,

OBJECT_TYPE_PROFILE_DEPLOYMENT,

OBJECT_TYPE_ZKS_INSTANCE,

OBJECT_TYPE_CLUSTER_GROUP

Response

A successful response.

config required for job ops

name

string

required

User defined name of the job request, unique across the enterprise. Once object is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

objectType

enum<string>

default:OBJECT_TYPE_UNSPECIFIED

required

object type for which job has been created

Available options:

OBJECT_TYPE_UNSPECIFIED,

OBJECT_TYPE_USER,

OBJECT_TYPE_EDGE_NODE,

OBJECT_TYPE_EDGE_APP,

OBJECT_TYPE_IMAGE,

OBJECT_TYPE_EDGE_APP_INSTANCE,

OBJECT_TYPE_PROJECT,

OBJECT_TYPE_NETWORK,

OBJECT_TYPE_DATASTORE,

OBJECT_TYPE_SERVICE,

OBJECT_TYPE_SERVICE_INSTANCE,

OBJECT_TYPE_ENTERPRISE,

OBJECT_TYPE_ROLE,

OBJECT_TYPE_CREDENTIAL,

OBJECT_TYPE_NETWORK_INSTANCE,

OBJECT_TYPE_VOLUME_INSTANCE,

OBJECT_TYPE_REALM,

OBJECT_TYPE_AUTHPROFILE,

OBJECT_TYPE_POLICY,

OBJECT_TYPE_APP_POLICY,

OBJECT_TYPE_CLUSTER_INSTANCE,

OBJECT_TYPE_PLUGIN,

OBJECT_TYPE_DOC_POLICY,

OBJECT_TYPE_ORCHESTRATOR_CLUSTER,

OBJECT_TYPE_TAGS,

OBJECT_TYPE_EDGE_NODE_INTERFACE,

OBJECT_TYPE_DEPLOYMENT,

OBJECT_TYPE_ENTITLEMENTS,

OBJECT_TYPE_DATA_STREAM,

OBJECT_TYPE_API_USAGE,

OBJECT_TYPE_APP_INSTANCE_SNAPSHOT,

OBJECT_TYPE_PATCH_ENVELOPE,

OBJECT_TYPE_RESOURCE_USAGE_TRACK,

OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE,

OBJECT_TYPE_DEV_PASSTHROUGH,

OBJECT_TYPE_EDGE_NODE_CLUSTER,

OBJECT_TYPE_ASSET_GROUP,

OBJECT_TYPE_APP_PROFILE,

OBJECT_TYPE_PROFILE_DEPLOYMENT,

OBJECT_TYPE_ZKS_INSTANCE,

OBJECT_TYPE_CLUSTER_GROUP

string

read-only

System defined universally unique Id of the job request

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

operationType

enum<string>

default:BULK_SERVICE_UNSPECIFIED

Available options:

BULK_SERVICE_UNSPECIFIED,

BULK_SERVICE_BASEOS_UPDATE,

BULK_SERVICE_APPINSTANCE_DEPLOY,

BULK_SERVICE_APPINSTANCE_REFRESH,

BULK_SERVICE_APPINSTANCE_PURGE,

BULK_SERVICE_MODEL_IMPORT,

BULK_SERVICE_BUNDLE_IMPORT,

BULK_SERVICE_APPINSTANCE_CERT_UPDATE,

BULK_SERVICE_APPINSTANCE_DELETE,

BULK_SERVICE_BASEOS_UPDATE_RETRY,

BULK_SERVICE_APPINSTANCE_UPDATE,

BULK_SERVICE_DEVICE_TAG_UPDATE,

BULK_SERVICE_DEVICE_TAG_DEPLOYMENT_UPDATE,

BULK_SERVICE_DEVICE_PROJECT_AND_TARGET_UPDATE,

BULK_SERVICE_DEPLOYMENT_CREATE,

BULK_SERVICE_APPLY_PATCH_ENVELOPE

status

enum<string>

default:JOB_STATUS_UNSPECIFIED

status of the job

Available options:

JOB_STATUS_UNSPECIFIED,

JOB_STATUS_INITIALIZED,

JOB_STATUS_READY,

JOB_STATUS_INPROGRESS,

JOB_STATUS_COMPLETED,

JOB_STATUS_FAILED,

JOB_STATUS_ABORTED

objectList

string[]

startTime

string<date-time>

read-only

start time of the job

finishTime

string<date-time>

read-only

finish time of the job

revision

ObjectRevision is used to store the user information. · object

system defined info

Show child attributes

individualOpStatus

object

read-only

status of individual field of the given object

Show child attributes

selectionCriteria

object

selection criteria for the job

Show child attributes

errorDetailOfJob

string

read-only

detailed error with which job/task has failed

title

string

user or system specified title

description

string

user or system specified description

projectId

string

project Id in which job is getting created

⌘I

Get asynchronous job request

curl --request GET \
  --url https://{apiHost}/api/v1/jobs/name/{name}/objectType/{objectType} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{apiHost}/api/v1/jobs/name/{name}/objectType/{objectType}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/jobs/name/{name}/objectType/{objectType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "id": "<string>",
  "operationType": "BULK_SERVICE_UNSPECIFIED",
  "status": "JOB_STATUS_UNSPECIFIED",
  "objectList": [
    "<string>"
  ],
  "startTime": "2023-11-07T05:31:56Z",
  "finishTime": "2023-11-07T05:31:56Z",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "individualOpStatus": {},
  "selectionCriteria": {
    "projectId": "<string>",
    "bundleId": "<string>",
    "deviceIdList": [
      "<string>"
    ]
  },
  "errorDetailOfJob": "<string>",
  "title": "<string>",
  "description": "<string>",
  "projectId": "<string>"
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Get asynchronous job request (GET /v1/jobs/name/{name}/objectType/{objectType})

Authorizations

Headers

Path Parameters

Response