Platform | Operation
Service to manage entities of type 'Operation'.
Overview
| URL | api/{tenantKey}/{orgKey}/corePatterns/operations |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Operations
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See OperationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Operations (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 OperationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Operation 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 OperationResource. |
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 Operation by key
Returns the entity record that matches the specified key.
The following elements are required:
| name | (string) The operation’s name. |
| module | (string) The operation’s module. |
| serviceName | (string) The operation’s service name. |
Response:
| When successful, the response body contains the entity record. See OperationResource. |
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:
Resources
OperationResource
The following elements are required:
| name | (string) The operation’s name. |
| module | (string) The operation’s module. |
| serviceName | (string) The operation’s service name. |
| type | (enum OperationType) The operation’s type.
See OperationType. |
| useDraft | (bool) Use Draft. |
| listDraft | (bool) List Draft. |
The following elements are optional:
| process | (string) The operation’s process.
(fk) Allowed value: the natural key of a record of type Process. |
| localizableCaption | (string) The operation’s localizable caption. |
| schemaEntity | (string) The operation’s schema entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service. |
| operationTypeSpecification | (enum OperationTypeSpecification) The operation’s type specification.
See OperationTypeSpecification. |