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.

post/listBatchJobs

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": {
        "symx-user-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "Success",
  "BatchFileList": {
    "BatchFileName": [
      "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.

JobNamestringRequired

Name of the batch job to execute.

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Status message of the batch job.

TokenIdstringOptional

Token ID of the batch job.

post/executeBatchJob

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    }
  },
  "Async": true,
  "JobName": "text",
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "TokenId": "text"
}

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.

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Status message of the batch job.

TokenIdobjectOptional

Token ID of the batch job.

post/getBatchJobStatus

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    }
  },
  "TokenId": "text",
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "TokenId": {}
}