Jasmin Developers - Web API Reference

Platform | Entity Lock Reason

Service to manage entities of type 'EntityLockReason'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/entityLockReasons
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET EntityLockReasons (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 EntityLockReasonResource.

Response status codes:

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

Resource URL:

GET /corePatterns/entityLockReasons/odata

GET EntityLockReason 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 EntityLockReasonResource.

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

GET EntityLockReason by key

Returns the entity record that matches the specified key.

The following elements are required:

reasonKey (string) Reason.

Response:

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

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/entityLockReasons/{reasonKey}

Resources


EntityLockReasonResource

The following elements are required:

reasonKey (string) Reason.

The following elements are optional:

description (string) Description.