Settings | Attributes Configuration
Service to manage entities of type "Field Definition".
Overview
| URL | api/{tenantKey}/{orgKey}/settings/fieldDefinitionManagements |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Attributes Configuration
Returns the list of entity records that can be processed by the 'CompanySettings' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
The following elements are optional:
| schemaEntity | (string) Schema Entity This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See FieldDefinitionManagementLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Attributes Configuration
Instructs the 'CompanySettings' service to process the specified entity records.
The following elements are required:
| list | (FieldDefinitionManagementLine) List of the entity records that should be processed. See FieldDefinitionManagementLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
FieldDefinitionManagement
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| schemaEntity | (string) Schema Entity. |
FieldDefinitionManagementLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| key | (string) Key. |
| field | (string) Field. |
| attributeType | (string) Attribute Type. |
| isRequired | (bool) Is Required. |
| isInternal | (bool) Is Internal. |
| isSystemBase | (bool) Is System Base. |
| isSystem | (bool) Is System. |
| isCustomAttribute | (bool) Is Custom Attribute. |