Platform | Custom Entity Record

Service to manage entities of type 'UserEntityRecord'.

Overview

{entity}

URL	api/{tenantKey}/{orgKey}/customentities/{entity}
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST CustomEntityRecords
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiCustomEntityRecordResource
CustomEntityRecordResource
CustomEntityRecordResource.
ExtensibilityCustomAttributeValueResource

GET Operations

GET CustomEntityRecords (odata)

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

The following elements are required:

entity

(string) The entity.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/customentities/{entity}/odata

GET /customentities/{entity}/odata

GET CustomEntityRecord by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.
entity	(string) The entity.

Response:

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

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

GET /customentities/{entity}/{id}

GET CustomEntityRecord by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
key	(string) Key.
entity	(string) The entity.

Response:

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

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}/customentities/{entity}/{companyKey}/{key}

GET /customentities/{entity}/{companyKey}/{key}

GET CustomEntityRecord by key

Returns the entity record that matches the specified key.

The following elements are required:

key	(string) Key.
entity	(string) The entity.

Response:

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

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}/customentities/{entity}/{key}

GET /customentities/{entity}/{key}

GET CustomEntityRecord OData

Returns the list of all the entity records available.

Response:

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

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}/customentities/{entity}/odata

GET /customentities/{entity}/odata

POST Operations

POST CustomEntityRecords

Creates a new entity record.

The following elements are required:

customEntityRecordResource	(ApiCustomEntityRecordResource) The request body should contain the entity record that should be created. See ApiCustomEntityRecordResource.
entity	(string) The entity.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/customentities/{entity}

POST /customentities/{entity}

PUT Operations

PUT Set Description CustomEntityRecord

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

The following elements are required:

key	(string) Key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.
entity	(string) The entity.

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}/customentities/{entity}/{companyKey}/{key}/description

PUT /customentities/{entity}/{companyKey}/{key}/description

PUT Set Description CustomEntityRecord

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

The following elements are required:

key	(string) Key.
value	(string) The request body should contain the new value for the attribute.
entity	(string) The entity.

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}/customentities/{entity}/{key}/description

PUT /customentities/{entity}/{key}/description

PUT Set IsActive CustomEntityRecord

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

The following elements are required:

key	(string) Key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.
entity	(string) The entity.

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}/customentities/{entity}/{companyKey}/{key}/isActive

PUT /customentities/{entity}/{companyKey}/{key}/isActive

PUT Set IsActive CustomEntityRecord

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

The following elements are required:

key	(string) Key.
value	(bool) The request body should contain the new value for the attribute.
entity	(string) The entity.

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}/customentities/{entity}/{key}/isActive

PUT /customentities/{entity}/{key}/isActive

PUT Set Custom Attribute CustomEntityRecord

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
schemaEntity	(string) Schema Entity
key	(string) Key
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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}/customentities/{entity}/{customAttributeName}

PUT /customentities/{entity}/{customAttributeName}

DELETE Operations

DELETE CustomEntityRecord by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.
entity	(string) The entity.

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

DELETE /customentities/{entity}/{id}

DELETE CustomEntityRecord by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
key	(string) Key.
entity	(string) The entity.

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}/customentities/{entity}/{companyKey}/{key}

DELETE /customentities/{entity}/{companyKey}/{key}

DELETE CustomEntityRecord by key

Deletes the entity record that matches the specified key.

The following elements are required:

key	(string) Key.
entity	(string) The entity.

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}/customentities/{entity}/{key}

DELETE /customentities/{entity}/{key}

Resources

ApiCustomEntityRecordResource

The following elements are required:

schemaEntity	(string) Schema Entity.
key	(string) Key.
description	(string) Description.

The following elements are optional:

company

(string) Company.

CustomEntityRecordResource

The following elements are required:

schemaEntity	(string) Schema Entity. (fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
key	(string) Key.
description	(string) Description.

The following elements are optional:

company

(string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

CustomEntityRecordResource.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.