BatchJobsService

Perform Symitar batch operations.

Symitar eDocs References: SymXchange BatchJobs Service, BatchJobs Service Troubleshooting

Operations

listBatchJobs

post

Lists all available batch jobs.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Status message of the batch job.

Example: Success

post

/listBatchJobs

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/batchjobs/listBatchJobs HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

executeBatchJob

post

Executes a batch job.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AsyncbooleanOptional

Whether to run the batch job asynchronously.

Example: true

JobNamestringRequired

Name of the batch job to execute.

Example: NX.MOCK.BATCH.JOB

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Status message of the batch job.

Example: Success

TokenIdstringOptional

Token ID of the batch job.

Example: GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww==

post

/executeBatchJob

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/batchjobs/executeBatchJob HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "Async": true,
  "JobName": "NX.MOCK.BATCH.JOB",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

getBatchJobStatus

post

Retrieves the status of a batch job.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

TokenIdstringRequired

Token ID of the batch job.

Example: GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww==

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Status message of the batch job.

Example: Success

TokenIdobjectOptional

Token ID of the batch job.

Example: GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww==

post

/getBatchJobStatus

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/batchjobs/getBatchJobStatus HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "TokenId": "GdGDhjqkChGFfcdxj93HbMMWZAzdzyfuSVKL0trxTpYr2+VwmbNqvN3IM3SDbsd7q2OLoKZYMnisp13hSU+qww==",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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