Platform | BackgroundOperation

Service to manage entities of type 'BackgroundOperation'.

Overview

URL	api/{tenantKey}/{orgKey}/corePatterns/backgroundOperations
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET BackgroundOperations
  • GET BackgroundOperations (paged)
  • GET BackgroundOperation by identifier
  • GET BackgroundOperation by key
  • GET Print BackgroundOperation by identifier
  • GET Print BackgroundOperation by key
  • GET Original Print BackgroundOperationOriginal by identifier
  • GET Original Print BackgroundOperation by key
• POST:
  • POST BackgroundOperations
  • POST BackgroundOperation
• PUT:
  • PUT Set IsActive BackgroundOperation
  • PUT Set BackgroundOperationKey BackgroundOperation
  • PUT Set EventType BackgroundOperation
  • PUT Set Operation BackgroundOperation
  • PUT Set SchemaEntity BackgroundOperation
  • PUT Set EntityUri BackgroundOperation
  • PUT Set EntityKey BackgroundOperation
  • PUT Set UserName BackgroundOperation
  • PUT Set BackgroundOperationStatus BackgroundOperation
  • PUT Set Description BackgroundOperationDetail
  • PUT Set BackgroundOperationDetailStatus BackgroundOperationDetail
• DELETE:
  • DELETE Background Operation Detail by identifier
  • DELETE BackgroundOperation by identifier
  • DELETE BackgroundOperation by key

All Resources

This service uses the following resources:

• ApiBackgroundOperationBackgroundOperationDetailsResource
• ApiBackgroundOperationResource
• BackgroundOperationDetailResource
• BackgroundOperationResource

All Enumerations

This service uses the following enumerations:

• BackgroundOperationDetailStatus
• BackgroundOperationStatus

GET Operations

GET BackgroundOperations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET BackgroundOperations (paged)

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

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

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

Response status codes:

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

Resource URL:

GET BackgroundOperation 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 BackgroundOperationResource.

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:

GET BackgroundOperation by key

Returns the entity record that matches the specified key.

The following elements are required:

backgroundOperationKey

(string) Background Operation.

Response:

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

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:

GET Print BackgroundOperation by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print BackgroundOperation by key

Prints the specified entity record.

The following elements are required:

backgroundOperationKey

(string) Background Operation.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

GET Original Print BackgroundOperationOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print BackgroundOperation by key

Prints the specified entity record.

The following elements are required:

backgroundOperationKey

(string) Background Operation.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

POST Operations

POST BackgroundOperations

Creates a new entity record.

The following elements are required:

backgroundOperationResource

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

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 ApiBackgroundOperationResource.

Response status codes:

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

Resource URL:

POST BackgroundOperation

Inserts a new 'Background Operation Detail' in the 'BackgroundOperation'.

The following elements are required:

backgroundOperationKey	(string) Background Operation.
value	(ApiBackgroundOperationBackgroundOperationDetailsResource) The ApiBackgroundOperationBackgroundOperationDetailsResource instance. See ApiBackgroundOperationBackgroundOperationDetailsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set BackgroundOperationDetailStatus BackgroundOperationDetail

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
lineId	(string) The detail identifier.
value	(enum BackgroundOperationDetailStatus) The request body should contain the new value for the attribute. See BackgroundOperationDetailStatus.

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:

PUT Set BackgroundOperationKey BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set BackgroundOperationStatus BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
value	(enum BackgroundOperationStatus) The request body should contain the new value for the attribute. See BackgroundOperationStatus.

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:

PUT Set Description BackgroundOperationDetail

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
lineId	(string) The detail identifier.
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:

PUT Set EntityKey BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set EntityUri BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set EventType BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set IsActive BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set Operation BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set SchemaEntity BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

PUT Set UserName BackgroundOperation

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

The following elements are required:

backgroundOperationKey	(string) Background Operation.
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:

DELETE Operations

DELETE Background Operation Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

backgroundOperationKey	(string) Background Operation.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE BackgroundOperation 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:

DELETE BackgroundOperation by key

Deletes the entity record that matches the specified key.

The following elements are required:

backgroundOperationKey

(string) Background Operation.

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:

Resources

ApiBackgroundOperationBackgroundOperationDetailsResource

The following elements are optional:

description	(string) Description.
backgroundOperationDetailStatus	(enum BackgroundOperationDetailStatus) Background Operation Detail Status. See BackgroundOperationDetailStatus.

ApiBackgroundOperationResource

The following elements are required:

backgroundOperationKey	(string) Background Operation.
operation	(string) Operation.
schemaEntity	(string) Schema Entity.

The following elements are optional:

eventType	(string) Event Type.
entityUri	(string) Entity Uri.
backgroundOperationDetails	(List of ApiBackgroundOperationBackgroundOperationDetailsResource) Background Operation Details. See ApiBackgroundOperationBackgroundOperationDetailsResource.
entityKey	(string) Entity.
userName	(string) User Name.
backgroundOperationStatus	(enum BackgroundOperationStatus) Background Operation Status. See BackgroundOperationStatus.

BackgroundOperationDetailResource

The following elements are optional:

description	(string) Description.
backgroundOperationDetailStatus	(enum BackgroundOperationDetailStatus) Background Operation Detail Status. See BackgroundOperationDetailStatus.

BackgroundOperationResource

The following elements are required:

backgroundOperationKey	(string) Background Operation.
operation	(string) Operation. (fk) Allowed value: the natural key of a record of type Operation. These records are accessibly through the Operations service.
schemaEntity	(string) Schema Entity. (fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.

The following elements are optional:

eventType	(string) Event Type.
entityUri	(string) Entity Uri.
backgroundOperationDetails	(List of BackgroundOperationDetailResource) Background Operation Details. See BackgroundOperationDetailResource.
entityKey	(string) Entity.
userName	(string) User Name.
backgroundOperationStatus	(enum BackgroundOperationStatus) Background Operation Status. See BackgroundOperationStatus.

Enumerations

BackgroundOperationDetailStatus

2	InProgress
3	Succeded
4	Failed

BackgroundOperationStatus

2	InProgress
3	Completed
4	CompletedWithErrors