Skip to content
NexumAPI Docs

BatchJobsService⁠

Operations⁠

listBatchJobs⁠

POST

Lists all available batch jobs.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalStatus message of the batch job.
POST/nexum/{sym}/2022.01/batchjobs/listBatchJobs
POST /nexum/627/2022.01/batchjobs/listBatchJobs HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "thiswillwerkOP00!"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

executeBatchJob⁠

POST

Executes a batch job.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AsyncbooleanoptionalWhether to run the batch job asynchronously.
JobNamestringrequiredName of the batch job to execute.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalStatus message of the batch job.
TokenIdstringoptionalToken ID of the batch job.
POST/nexum/{sym}/2022.01/batchjobs/executeBatchJob
POST /nexum/627/2022.01/batchjobs/executeBatchJob HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "thiswillwerkOP00!"
    }
  },
  "Async": true,
  "JobName": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

getBatchJobStatus⁠

POST

Retrieves the status of a batch job.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
TokenIdstringrequiredToken ID of the batch job.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalStatus message of the batch job.
TokenIdobjectoptionalToken ID of the batch job.
POST/nexum/{sym}/2022.01/batchjobs/getBatchJobStatus
POST /nexum/627/2022.01/batchjobs/getBatchJobStatus HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "thiswillwerkOP00!"
    }
  },
  "TokenId": "string",
  "nxAttributes": {
    "customFields": {}
  }
}