jobs

Get a list of the recently queued jobs.

get/{storeName}/jobs

Request

Base URL
/brightstar (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/brightstardb/apis/brightstardb-rest-api/docs/:storeName/jobs/get.ts
A function with typed inputs. Its response is checked against the schema.

storeNamestring required

The name of the store

skipinteger

Specifies the starting offset of the list when paging results.

takeinteger

Specifies the number of items to return when paging results.

Successful response

jobIdstring GUID required

The unique identifier of the job

labelstring

A user-friendly label for the job specified when the job was queued.

jobStatus'Pending' | 'Started' | 'CompletedOk' | 'TransactionError' | 'Unknown'

The current processing state of the job.

statusMessagestring

The last progress message recorded by the server for the processing of this job.

storeNamestring

The name of the store that the job is queued on

queuedTimestring date-time

The date/time when the job was queued on the server.

startTimestring date-time

The date/time when the job started processing.

This value will not be available when the jobStatus is "Pending".

endTimestring date-time

The date/time when the job completed processing.

This value will not be available when the jobStatus is "Pending" or "Started".

May 26, 2015694b44600c48 Revision changes
- info
  api operation id listJobs was added
- info
  api tag jobs added
May 26, 201537652d797bdc Revision changes
- info
  endpoint added