BatchJobsService

Perform Symitar batch operations.

Symitar eDocs References: SymXchange BatchJobs Service, BatchJobs Service Troubleshooting

Operations

listBatchJobs

Lists all available batch jobs.

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/batchjobs/listBatchJobs

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

StatusMessagestring

Status message of the batch job.

Example: "Success"

BatchFileListobject

Object containing the list of batch files.

Request

JavaScriptCurlPython

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/batchjobs/listBatchJobs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "UserNumberCredentials": {
          "UserNumber": 1995,
          "Password": "2dfKQYR!TeXJwe"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "StatusMessage": "Success",
  "BatchFileList": {
    "BatchFileName": [
      "NX.MOCK.BATCH.JOB",
      "NX.MOCK.BATCH.JOB"
    ]
  }
}

executeBatchJob

Executes a batch job.

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/batchjobs/executeBatchJob

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

Asyncboolean

Whether to run the batch job asynchronously.

Example: true

JobName*string

Name of the batch job to execute.

Example: "NX.MOCK.BATCH.JOB"

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

StatusMessagestring

Status message of the batch job.

Example: "Success"

TokenIdstring

Token ID of the batch job.

Example: "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww=="

Request

JavaScriptCurlPython

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/batchjobs/executeBatchJob', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "JobName": "NX.MOCK.BATCH.JOB",
      "Credentials": {
        "UserNumberCredentials": {
          "UserNumber": 1995,
          "Password": "2dfKQYR!TeXJwe"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "StatusMessage": "Success",
  "TokenId": "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww=="
}

getBatchJobStatus

Retrieves the status of a batch job.

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/batchjobs/getBatchJobStatus

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

TokenId*string

Token ID of the batch job.

Example: "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww=="

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

StatusMessagestring

Status message of the batch job.

Example: "Success"

TokenIdobject

Token ID of the batch job.

Example: "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww=="

Request

JavaScriptCurlPython

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/batchjobs/getBatchJobStatus', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "TokenId": "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww==",
      "Credentials": {
        "UserNumberCredentials": {
          "UserNumber": 1995,
          "Password": "2dfKQYR!TeXJwe"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "StatusMessage": "Success",
  "TokenId": "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww=="
}