api-docs v5.116.0

API Docs

Table of contents

Queue_Item

Queue Item - Delete

Back to top

Delete a specific queue item

DELETE /queue-items/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/queue-items/<queue-item-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
queue string

queue id
queueType string

inherited from queue
organization string

inherited from queue
order number

queue index. if null, non-active (in queue trails)
subject string

entity that is being queued. medical-patient/account id/uid
subjectType string Allowed values: medical-patient,account
number number
numberingSource string Allowed values: queue,organization
tags string[]
meta object
meta.appointment string
meta.fromKiosk boolean
meta.progressNote object
meta.testOrders object[]

DiagnosticOrderItem object
meta.testPackage string
meta.patient string
meta.patientPicURL object
meta.patientName object
meta.patientName.prefix string
meta.patientName.firstName string
meta.patientName.middleName string
meta.patientName.lastName string
meta.patientName.generationalSuffix string

Jr., Sr., III, etc
meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
meta.patientName.suffix string
meta.patientSex string Allowed values: male,female
meta.patientBloodType string
meta.patientAddress object
meta.patientAddress.street1 string
meta.patientAddress.street2 string
meta.patientAddress.city string
meta.patientAddress.municipality string
meta.patientAddress.province string
meta.patientAddress.country string

three letter country code
meta.patientAddress.lat number
meta.patientAddress.lng number
meta.patientDateOfBirth number
meta.patientMobileNo string
meta.patientInsuranceCards object

InsuranceCard object
meta.patientOSCASeniorCitizenId string
meta.patientPWDId string

chat app
meta.assignmentTO number
meta.reassignedAt number
meta.reassignedBy string
meta.acceptedAt number
meta.acceptedBy string
meta.peService string
meta.peTemplate string
meta.trail string

trail id. auto generated for trails
meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
weight number

for autobalancing trails
queues string[]

alternative queues for trails
services object[]

unconfirmed services to perform
services.id string
services.service string

service id
services.metadata object

e.g. lab test order, etc...
servicesToPerform object[]

services to perform
servicesToPerform.id string Default value: auto-generated-id
servicesToPerform.group string
servicesToPerform.service string
servicesToPerform.provider string
servicesToPerform.createdAt number Default value: currentTime
bookkeeping object[]

timestamps for analysis
bookkeeping.id string
bookkeeping.referenceService string

reference document's service/collection
bookkeeping.reference string

reference id
bookkeeping.referenceType string

reference's type
bookkeeping.referenceSubtype string

reference's subtype
bookkeeping.text string
bookkeeping.timestamp number
bookkeeping.metadata object
accommodatingCounter string
startedAt number
startedBy string
finishedAt number
finishedBy string
finishReason string
rejectedAt number
rejectedBy string
rejectReason string
requeuedAt number

for requeue ops
requeuedBy string
requeueReason string

for requeue ops
deferredAt number

for defer ops
deferredBy string
deferReason string

for defer ops
requeueDeferredAt number

for defer ops
requeueDeferredBy string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Queue Item - Find

Back to top

Get list of queue items

GET /queue-items

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/queue-items" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
queueItems object[]

array of queueItem
queueItems.id string
queueItems.createdAt number
queueItems.createdBy string
queueItems.queue string

queue id
queueItems.queueType string

inherited from queue
queueItems.organization string

inherited from queue
queueItems.order number

queue index. if null, non-active (in queue trails)
queueItems.subject string

entity that is being queued. medical-patient/account id/uid
queueItems.subjectType string Allowed values: medical-patient,account
queueItems.number number
queueItems.numberingSource string Allowed values: queue,organization
queueItems.tags string[]
queueItems.meta object
queueItems.meta.appointment string
queueItems.meta.fromKiosk boolean
queueItems.meta.progressNote object
queueItems.meta.testOrders object[]

DiagnosticOrderItem object
queueItems.meta.testPackage string
queueItems.meta.patient string
queueItems.meta.patientPicURL string
queueItems.meta.patientName object
queueItems.meta.patientName.prefix string
queueItems.meta.patientName.firstName string
queueItems.meta.patientName.middleName string
queueItems.meta.patientName.lastName string
queueItems.meta.patientName.generationalSuffix string

Jr., Sr., III, etc
queueItems.meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
queueItems.meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
queueItems.meta.patientName.suffix string
queueItems.meta.patientSex string Allowed values: male,female
queueItems.meta.patientBloodType string
queueItems.meta.patientAddress object
queueItems.meta.patientAddress.street1 string
queueItems.meta.patientAddress.street2 string
queueItems.meta.patientAddress.city string
queueItems.meta.patientAddress.municipality string
queueItems.meta.patientAddress.province string
queueItems.meta.patientAddress.country string

three letter country code
queueItems.meta.patientAddress.lat number
queueItems.meta.patientAddress.lng number
queueItems.meta.patientDateOfBirth number
queueItems.meta.patientMobileNo string
queueItems.meta.patientInsuranceCards object

InsuranceCard object
queueItems.meta.patientOSCASeniorCitizenId string
queueItems.meta.patientPWDId string

chat app
queueItems.meta.assignmentTO number
queueItems.meta.reassignedAt number
queueItems.meta.reassignedBy string
queueItems.meta.acceptedAt number
queueItems.meta.acceptedBy string
queueItems.meta.peService string
queueItems.meta.peTemplate string
queueItems.meta.trail string

trail id. auto generated for trails
queueItems.meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
queueItems.weight number

for autobalancing trails
queueItems.queues string[]

alternative queues for trails
queueItems.services object[]

unconfirmed services to perform
queueItems.services.id string
queueItems.services.service string

service id
queueItems.services.metadata object

e.g. lab test order, etc...
queueItems.servicesToPerform object[]

services to perform
queueItems.servicesToPerform.id string Default value: auto-generated-id
queueItems.servicesToPerform.group string
queueItems.servicesToPerform.service string
queueItems.servicesToPerform.provider string
queueItems.servicesToPerform.createdAt number Default value: currentTime
queueItems.bookkeeping object[]

timestamps for analysis
queueItems.bookkeeping.id string
queueItems.bookkeeping.referenceService string

reference document's service/collection
queueItems.bookkeeping.reference string

reference id
queueItems.bookkeeping.referenceType string

reference's type
queueItems.bookkeeping.referenceSubtype string

reference's subtype
queueItems.bookkeeping.text string
queueItems.bookkeeping.timestamp number
queueItems.bookkeeping.metadata object
queueItems.accommodatingCounter string
queueItems.startedAt number
queueItems.startedBy string
queueItems.finishedAt number
queueItems.finishedBy string
queueItems.finishReason string
queueItems.rejectedAt number
queueItems.rejectedBy string
queueItems.rejectReason string
queueItems.requeuedAt number

for requeue ops
queueItems.requeuedBy string
queueItems.requeueReason string

for requeue ops
queueItems.deferredAt number

for defer ops
queueItems.deferredBy string
queueItems.deferReason string

for defer ops
queueItems.requeueDeferredAt number

for defer ops
queueItems.requeueDeferredBy string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Queue Item - Get

Back to top

Get a specific queue item

GET /queue-items/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/queue-items/<queue-item-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
queue string

queue id
queueType string

inherited from queue
organization string

inherited from queue
order number

queue index. if null, non-active (in queue trails)
subject string

entity that is being queued. medical-patient/account id/uid
subjectType string Allowed values: medical-patient,account
number number
numberingSource string Allowed values: queue,organization
tags string[]
meta object
meta.appointment string
meta.fromKiosk boolean
meta.progressNote object
meta.testOrders object[]

DiagnosticOrderItem object
meta.testPackage string
meta.patient string
meta.patientPicURL object
meta.patientName object
meta.patientName.prefix string
meta.patientName.firstName string
meta.patientName.middleName string
meta.patientName.lastName string
meta.patientName.generationalSuffix string

Jr., Sr., III, etc
meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
meta.patientName.suffix string
meta.patientSex string Allowed values: male,female
meta.patientBloodType string
meta.patientAddress object
meta.patientAddress.street1 string
meta.patientAddress.street2 string
meta.patientAddress.city string
meta.patientAddress.municipality string
meta.patientAddress.province string
meta.patientAddress.country string

three letter country code
meta.patientAddress.lat number
meta.patientAddress.lng number
meta.patientDateOfBirth number
meta.patientMobileNo string
meta.patientInsuranceCards object

InsuranceCard object
meta.patientOSCASeniorCitizenId string
meta.patientPWDId string

chat app
meta.assignmentTO number
meta.reassignedAt number
meta.reassignedBy string
meta.acceptedAt number
meta.acceptedBy string
meta.peService string
meta.peTemplate string
meta.trail string

trail id. auto generated for trails
meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
weight number

for autobalancing trails
queues string[]

alternative queues for trails
services object[]

unconfirmed services to perform
services.id string
services.service string

service id
services.metadata object

e.g. lab test order, etc...
servicesToPerform object[]

services to perform
servicesToPerform.id string Default value: auto-generated-id
servicesToPerform.group string
servicesToPerform.service string
servicesToPerform.provider string
servicesToPerform.createdAt number Default value: currentTime
bookkeeping object[]

timestamps for analysis
bookkeeping.id string
bookkeeping.referenceService string

reference document's service/collection
bookkeeping.reference string

reference id
bookkeeping.referenceType string

reference's type
bookkeeping.referenceSubtype string

reference's subtype
bookkeeping.text string
bookkeeping.timestamp number
bookkeeping.metadata object
accommodatingCounter string
startedAt number
startedBy string
finishedAt number
finishedBy string
finishReason string
rejectedAt number
rejectedBy string
rejectReason string
requeuedAt number

for requeue ops
requeuedBy string
requeueReason string

for requeue ops
deferredAt number

for defer ops
deferredBy string
deferReason string

for defer ops
requeueDeferredAt number

for defer ops
requeueDeferredBy string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Queue Item - Patch

Back to top

Update queue item

PATCH /queue-items/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional Default value: currentTime
queue string

queue id
subject string optional

entity that is being queued. medical-patient/account id/uid
subjectType string optional Allowed values: medical-patient,account
number number optional
numberingSource string optional Allowed values: queue,organization
tags string[] optional
meta object optional
meta.appointment string
meta.fromKiosk boolean
meta.progressNote object
meta.testOrders object[]

DiagnosticOrderItem object
meta.testPackage string
meta.patient string
meta.patientPicURL object
meta.patientName object
meta.patientName.prefix string
meta.patientName.firstName string
meta.patientName.middleName string
meta.patientName.lastName string
meta.patientName.generationalSuffix string

Jr., Sr., III, etc
meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
meta.patientName.suffix string
meta.patientSex string Allowed values: male,female
meta.patientBloodType string
meta.patientAddress object
meta.patientAddress.street1 string
meta.patientAddress.street2 string
meta.patientAddress.city string
meta.patientAddress.municipality string
meta.patientAddress.province string
meta.patientAddress.country string

three letter country code
meta.patientAddress.lat number
meta.patientAddress.lng number
meta.patientDateOfBirth number
meta.patientMobileNo string
meta.patientInsuranceCards object

InsuranceCard object
meta.patientOSCASeniorCitizenId string
meta.patientPWDId string

chat app
meta.assignmentTO number
meta.reassignedAt number
meta.reassignedBy string
meta.acceptedAt number
meta.acceptedBy string
meta.peService string
meta.peTemplate string
meta.trail string

trail id. auto generated for trails
meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
weight number optional

for autobalancing trails
queues string[] optional

alternative queues for trails
services object[] optional

unconfirmed services to perform
services.id string
services.service string

service id
services.metadata object

e.g. lab test order, etc...
servicesToPerform object[] optional

services to perform
servicesToPerform.id string Default value: auto-generated-id
servicesToPerform.group string
servicesToPerform.service string
servicesToPerform.provider string
servicesToPerform.createdAt number Default value: currentTime
bookkeeping object[] optional

timestamps for analysis
bookkeeping.id string
bookkeeping.referenceService string

reference document's service/collection
bookkeeping.reference string

reference id
bookkeeping.referenceType string

reference's type
bookkeeping.referenceSubtype string

reference's subtype
bookkeeping.text string
bookkeeping.timestamp number
bookkeeping.metadata object
accommodatingCounter string optional
finishReason string optional
rejectReason string optional
requeueReason string optional

for requeue ops
deferReason string optional

for defer ops
start boolean optional

operators
finish boolean/string optional

operators
reject boolean/string optional

$reject operators
requeue boolean/string optional

operators
defer boolean/string optional

operators
reassign boolean optional

operators
moveTo object optional

operators
moveTo.refItem boolean
moveTo.direction string optional Default value: above
Allowed values: above,below

Examples

Example usage:

curl "https://yourdomain.com/queue-items/<queue-item-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "$reject": true
  }'

Parameters examples

json - Request-Example

{
  "$reject": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
queue string

queue id
queueType string

inherited from queue
organization string

inherited from queue
order number

queue index. if null, non-active (in queue trails)
subject string

entity that is being queued. medical-patient/account id/uid
subjectType string Allowed values: medical-patient,account
number number
numberingSource string Allowed values: queue,organization
tags string[]
meta object
meta.appointment string
meta.fromKiosk boolean
meta.progressNote object
meta.testOrders object[]

DiagnosticOrderItem object
meta.testPackage string
meta.patient string
meta.patientPicURL object
meta.patientName object
meta.patientName.prefix string
meta.patientName.firstName string
meta.patientName.middleName string
meta.patientName.lastName string
meta.patientName.generationalSuffix string

Jr., Sr., III, etc
meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
meta.patientName.suffix string
meta.patientSex string Allowed values: male,female
meta.patientBloodType string
meta.patientAddress object
meta.patientAddress.street1 string
meta.patientAddress.street2 string
meta.patientAddress.city string
meta.patientAddress.municipality string
meta.patientAddress.province string
meta.patientAddress.country string

three letter country code
meta.patientAddress.lat number
meta.patientAddress.lng number
meta.patientDateOfBirth number
meta.patientMobileNo string
meta.patientInsuranceCards object

InsuranceCard object
meta.patientOSCASeniorCitizenId string
meta.patientPWDId string

chat app
meta.assignmentTO number
meta.reassignedAt number
meta.reassignedBy string
meta.acceptedAt number
meta.acceptedBy string
meta.peService string
meta.peTemplate string
meta.trail string

trail id. auto generated for trails
meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
weight number

for autobalancing trails
queues string[]

alternative queues for trails
services object[]

unconfirmed services to perform
services.id string
services.service string

service id
services.metadata object

e.g. lab test order, etc...
servicesToPerform object[]

services to perform
servicesToPerform.id string Default value: auto-generated-id
servicesToPerform.group string
servicesToPerform.service string
servicesToPerform.provider string
servicesToPerform.createdAt number Default value: currentTime
bookkeeping object[]

timestamps for analysis
bookkeeping.id string
bookkeeping.referenceService string

reference document's service/collection
bookkeeping.reference string

reference id
bookkeeping.referenceType string

reference's type
bookkeeping.referenceSubtype string

reference's subtype
bookkeeping.text string
bookkeeping.timestamp number
bookkeeping.metadata object
accommodatingCounter string
startedAt number
startedBy string
finishedAt number
finishedBy string
finishReason string
rejectedAt number
rejectedBy string
rejectReason string
requeuedAt number

for requeue ops
requeuedBy string
requeueReason string

for requeue ops
deferredAt number

for defer ops
deferredBy string
deferReason string

for defer ops
requeueDeferredAt number

for defer ops
requeueDeferredBy string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Queue Item - Post

Back to top

Create queue item

POST /queue-items

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional Default value: currentTime
queue string

queue id
subject string optional

entity that is being queued. medical-patient/account id/uid
subjectType string optional Allowed values: medical-patient,account
number number optional
numberingSource string optional Allowed values: queue,organization
tags string[] optional
meta object optional
meta.appointment string
meta.fromKiosk boolean
meta.progressNote object
meta.testOrders object[]

DiagnosticOrderItem object
meta.testPackage string
meta.patient string
meta.patientPicURL object
meta.patientName object
meta.patientName.prefix string
meta.patientName.firstName string
meta.patientName.middleName string
meta.patientName.lastName string
meta.patientName.generationalSuffix string

Jr., Sr., III, etc
meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
meta.patientName.suffix string
meta.patientSex string Allowed values: male,female
meta.patientBloodType string
meta.patientAddress object
meta.patientAddress.street1 string
meta.patientAddress.street2 string
meta.patientAddress.city string
meta.patientAddress.municipality string
meta.patientAddress.province string
meta.patientAddress.country string

three letter country code
meta.patientAddress.lat number
meta.patientAddress.lng number
meta.patientDateOfBirth number
meta.patientMobileNo string
meta.patientInsuranceCards object

InsuranceCard object
meta.patientOSCASeniorCitizenId string
meta.patientPWDId string

chat app
meta.assignmentTO number
meta.reassignedAt number
meta.reassignedBy string
meta.acceptedAt number
meta.acceptedBy string
meta.peService string
meta.peTemplate string
meta.trail string

trail id. auto generated for trails
meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
weight number optional

for autobalancing trails
queues string[] optional

alternative queues for trails
services object[] optional

unconfirmed services to perform
services.id string
services.service string

service id
services.metadata object

e.g. lab test order, etc...
servicesToPerform object[] optional

services to perform
servicesToPerform.id string Default value: auto-generated-id
servicesToPerform.group string
servicesToPerform.service string
servicesToPerform.provider string
servicesToPerform.createdAt number Default value: currentTime
bookkeeping object[] optional

timestamps for analysis
bookkeeping.id string
bookkeeping.referenceService string

reference document's service/collection
bookkeeping.reference string

reference id
bookkeeping.referenceType string

reference's type
bookkeeping.referenceSubtype string

reference's subtype
bookkeeping.text string
bookkeeping.timestamp number
bookkeeping.metadata object
accommodatingCounter string optional
finishReason string optional
rejectReason string optional
requeueReason string optional

for requeue ops
deferReason string optional

for defer ops
items object[] optional

QueueItem object - operator

Examples

Example usage:

curl "https://yourdomain.com/queue-items" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "createdAt": 1234567890,
    "queue": "queue-id"
  }'

Parameters examples

json - Request-Example

{
  "createdAt": 1234567890,
  "queue": "queue-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
queue string

queue id
queueType string

inherited from queue
organization string

inherited from queue
order number

queue index. if null, non-active (in queue trails)
subject string

entity that is being queued. medical-patient/account id/uid
subjectType string Allowed values: medical-patient,account
number number
numberingSource string Allowed values: queue,organization
tags string[]
meta object
meta.appointment string
meta.fromKiosk boolean
meta.progressNote object
meta.testOrders object[]

DiagnosticOrderItem object
meta.testPackage string
meta.patient string
meta.patientPicURL object
meta.patientName object
meta.patientName.prefix string
meta.patientName.firstName string
meta.patientName.middleName string
meta.patientName.lastName string
meta.patientName.generationalSuffix string

Jr., Sr., III, etc
meta.patientName.academicSuffix string

M.A., M.S., Ph.D., etc
meta.patientName.professionalSuffix string

indicates membership to professional societies. e.g.: FPCP, FPOGS
meta.patientName.suffix string
meta.patientSex string Allowed values: male,female
meta.patientBloodType string
meta.patientAddress object
meta.patientAddress.street1 string
meta.patientAddress.street2 string
meta.patientAddress.city string
meta.patientAddress.municipality string
meta.patientAddress.province string
meta.patientAddress.country string

three letter country code
meta.patientAddress.lat number
meta.patientAddress.lng number
meta.patientDateOfBirth number
meta.patientMobileNo string
meta.patientInsuranceCards object

InsuranceCard object
meta.patientOSCASeniorCitizenId string
meta.patientPWDId string

chat app
meta.assignmentTO number
meta.reassignedAt number
meta.reassignedBy string
meta.acceptedAt number
meta.acceptedBy string
meta.peService string
meta.peTemplate string
meta.trail string

trail id. auto generated for trails
meta.group string
  • used for grouping queue items

use cases

  • encounter id for grouping by encounter
weight number

for autobalancing trails
queues string[]

alternative queues for trails
services object[]

unconfirmed services to perform
services.id string
services.service string

service id
services.metadata object

e.g. lab test order, etc...
servicesToPerform object[]

services to perform
servicesToPerform.id string Default value: auto-generated-id
servicesToPerform.group string
servicesToPerform.service string
servicesToPerform.provider string
servicesToPerform.createdAt number Default value: currentTime
bookkeeping object[]

timestamps for analysis
bookkeeping.id string
bookkeeping.referenceService string

reference document's service/collection
bookkeeping.reference string

reference id
bookkeeping.referenceType string

reference's type
bookkeeping.referenceSubtype string

reference's subtype
bookkeeping.text string
bookkeeping.timestamp number
bookkeeping.metadata object
accommodatingCounter string
startedAt number
startedBy string
finishedAt number
finishedBy string
finishReason string
rejectedAt number
rejectedBy string
rejectReason string
requeuedAt number

for requeue ops
requeuedBy string
requeueReason string

for requeue ops
deferredAt number

for defer ops
deferredBy string
deferReason string

for defer ops
requeueDeferredAt number

for defer ops
requeueDeferredBy string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""