Settings | Deleted Entity

Service to manage entities of type 'DeletedEntity'.

Overview

api/{tenantKey}/{orgKey}/settings/deletedEntities

URL	api/{tenantKey}/{orgKey}/settings/deletedEntities
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST DeletedEntities
PUT:
DELETE:
- DELETE DeletedEntity by identifier
- DELETE DeletedEntity by key

All Resources

This service uses the following resources:

ApiDeletedEntityResource
DeletedEntityResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET DeletedEntities (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 DeletedEntityResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/settings/deletedEntities/odata

GET /settings/deletedEntities/odata

GET DeletedEntity 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 DeletedEntityResource.

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

GET /settings/deletedEntities/{id}

GET DeletedEntity by key

Returns the entity record that matches the specified key.

The following elements are required:

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

Response:

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

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}/settings/deletedEntities/{companyKey}/{key}

GET /settings/deletedEntities/{companyKey}/{key}

POST Operations

POST DeletedEntities

Creates a new entity record.

The following elements are required:

deletedEntityResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/settings/deletedEntities

POST /settings/deletedEntities

PUT Operations

PUT Set Company DeletedEntity

Updates the value of attribute 'Company' 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.

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}/settings/deletedEntities/{companyKey}/{key}/company

PUT /settings/deletedEntities/{companyKey}/{key}/company

PUT Set EntityId DeletedEntity

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

The following elements are required:

key	(string) Key.
companyKey	(string) The company key.
value	(Guid) 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:

api/{tenantKey}/{orgKey}/settings/deletedEntities/{companyKey}/{key}/entityId

PUT /settings/deletedEntities/{companyKey}/{key}/entityId

PUT Set EntityNaturalKey DeletedEntity

Updates the value of attribute 'EntityNaturalKey' 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.

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}/settings/deletedEntities/{companyKey}/{key}/entityNaturalKey

PUT /settings/deletedEntities/{companyKey}/{key}/entityNaturalKey

PUT Set IsActive DeletedEntity

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.

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}/settings/deletedEntities/{companyKey}/{key}/isActive

PUT /settings/deletedEntities/{companyKey}/{key}/isActive

PUT Set Key DeletedEntity

Updates the value of attribute 'Key' 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.

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}/settings/deletedEntities/{companyKey}/{key}/key

PUT /settings/deletedEntities/{companyKey}/{key}/key

PUT Set SchemaEntity DeletedEntity

Updates the value of attribute 'SchemaEntity' 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.

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}/settings/deletedEntities/{companyKey}/{key}/schemaEntity

PUT /settings/deletedEntities/{companyKey}/{key}/schemaEntity

PUT Set Custom Attribute DeletedEntity

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

The following elements are required:

companyKey	(string) The company key.
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}/settings/deletedEntities/{companyKey}/{key}/{customAttributeName}

PUT /settings/deletedEntities/{companyKey}/{key}/{customAttributeName}

DELETE Operations

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

api/{tenantKey}/{orgKey}/settings/deletedEntities/{id}

DELETE /settings/deletedEntities/{id}

DELETE DeletedEntity by key

Deletes the entity record that matches the specified key.

The following elements are required:

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

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}/settings/deletedEntities/{companyKey}/{key}

DELETE /settings/deletedEntities/{companyKey}/{key}

Resources

ApiDeletedEntityResource

The following elements are required:

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

The following elements are optional:

entityId	(Guid) Entity Id.
entityNaturalKey	(string) Entity Natural.
company	(string) Company.

DeletedEntityResource

The following elements are required:

key	(string) Key.
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:

entityId	(Guid) Entity Id.
entityNaturalKey	(string) Entity Natural.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.