Valuekeep Developers - Web API Reference

Framework | 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

GET Operations (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 OperationResource.

Response status codes:

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

Resource URL:

GET /corePatterns/operations/odata

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 /corePatterns/operations/{id}

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:

GET /corePatterns/operations/{name}/{module}/{serviceName}

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:

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.


Enumerations


OperationType

1 ServiceOperation
2 ListOperation
3 ReportOperation
4 ExtensionOperation
5 CustomOperation
6 DashboardOperation
7 StepperOperation


OperationTypeSpecification

1 Custom
2 DisplayAndEditEntity
3 InsertEntity
4 Other
5 Picking
6 Settings
7 EntityManagementList
8 CustomList