Work | Queue Tbx

Service to manage entities of type 'QueueTbx'.

Overview

api/{tenantKey}/{orgKey}/maintenance/queueTbxes

URL	api/{tenantKey}/{orgKey}/maintenance/queueTbxes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST QueueTbxes
PUT:
DELETE:
- DELETE QueueTbx by identifier
- DELETE QueueTbx by key

All Resources

This service uses the following resources:

ApiQueueTbxResource
QueueTbxResource

GET Operations

GET QueueTbxes (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See QueueTbxResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/odata

GET /maintenance/queueTbxes/odata

GET QueueTbx by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See QueueTbxResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{id}

GET /maintenance/queueTbxes/{id}

GET QueueTbx by key

Returns the entity record that matches the specified key.

The following elements are required:

queueKey

(int) Queue.

Response:

When successful, the response body contains the entity record. See QueueTbxResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}

GET /maintenance/queueTbxes/{queueKey}

POST Operations

POST QueueTbxes

Creates a new entity record.

The following elements are required:

queueTbxResource

(ApiQueueTbxResource) The request body should contain the entity record that should be created.
See ApiQueueTbxResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiQueueTbxResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes

POST /maintenance/queueTbxes

PUT Operations

PUT Set Entity QueueTbx

Updates the value of attribute 'Entity' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/entity

PUT /maintenance/queueTbxes/{queueKey}/entity

PUT Set EntityKey QueueTbx

Updates the value of attribute 'EntityKey' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/entityKey

PUT /maintenance/queueTbxes/{queueKey}/entityKey

PUT Set ErrorMessage QueueTbx

Updates the value of attribute 'ErrorMessage' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/errorMessage

PUT /maintenance/queueTbxes/{queueKey}/errorMessage

PUT Set ErrorStatusCode QueueTbx

Updates the value of attribute 'ErrorStatusCode' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/errorStatusCode

PUT /maintenance/queueTbxes/{queueKey}/errorStatusCode

PUT Set EventNaturalKey QueueTbx

Updates the value of attribute 'EventNaturalKey' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/eventNaturalKey

PUT /maintenance/queueTbxes/{queueKey}/eventNaturalKey

PUT Set EventOccurrence QueueTbx

Updates the value of attribute 'EventOccurrence' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/eventOccurrence

PUT /maintenance/queueTbxes/{queueKey}/eventOccurrence

PUT Set IsActive QueueTbx

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/isActive

PUT /maintenance/queueTbxes/{queueKey}/isActive

PUT Set MaintenanceTaskId QueueTbx

Updates the value of attribute 'MaintenanceTaskId' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/maintenanceTaskId

PUT /maintenance/queueTbxes/{queueKey}/maintenanceTaskId

PUT Set SourceContext QueueTbx

Updates the value of attribute 'SourceContext' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/sourceContext

PUT /maintenance/queueTbxes/{queueKey}/sourceContext

PUT Set TaskId QueueTbx

Updates the value of attribute 'TaskId' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/taskId

PUT /maintenance/queueTbxes/{queueKey}/taskId

PUT Set TaskState QueueTbx

Updates the value of attribute 'TaskState' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/taskState

PUT /maintenance/queueTbxes/{queueKey}/taskState

PUT Set TaskUrl QueueTbx

Updates the value of attribute 'TaskUrl' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/taskUrl

PUT /maintenance/queueTbxes/{queueKey}/taskUrl

PUT Set UserCulture QueueTbx

Updates the value of attribute 'UserCulture' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/userCulture

PUT /maintenance/queueTbxes/{queueKey}/userCulture

PUT Set UserId QueueTbx

Updates the value of attribute 'UserId' in the specified entity record.

The following elements are required:

queueKey	(int) Queue.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}/userId

PUT /maintenance/queueTbxes/{queueKey}/userId

DELETE Operations

DELETE QueueTbx by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{id}

DELETE /maintenance/queueTbxes/{id}

DELETE QueueTbx by key

Deletes the entity record that matches the specified key.

The following elements are required:

queueKey

(int) Queue.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/maintenance/queueTbxes/{queueKey}

DELETE /maintenance/queueTbxes/{queueKey}

Resources

ApiQueueTbxResource

The following elements are required:

entityKey

(string) Entity.

The following elements are optional:

entity	(string) Entity.
taskState	(int) Task State.
taskId	(string) Task Id.
taskUrl	(string) Task Url.
errorMessage	(string) Error Message.
errorStatusCode	(string) Error Status.
userCulture	(string) User Culture.
userId	(string) User Id.
maintenanceTaskId	(string) Maintenance Task Id.
sourceContext	(string) Source Context.
eventOccurrence	(int) The event occurrence.
eventNaturalKey	(string) the event Natural Key.

QueueTbxResource

The following elements are required:

queueKey	(int) Queue.
entityKey	(string) Entity.

The following elements are optional:

entity	(string) Entity.
taskState	(int) Task State.
taskId	(string) Task Id.
taskUrl	(string) Task Url.
errorMessage	(string) Error Message.
errorStatusCode	(string) Error Status.
userCulture	(string) User Culture.
userId	(string) User Id.
maintenanceTaskId	(string) Maintenance Task Id.
sourceContext	(string) Source Context.
eventOccurrence	(int) The event occurrence.
eventNaturalKey	(string) the event Natural Key.