Settings | Tag Template
Service to manage entities of type 'LabelConfiguration'.
Overview
| URL | api/{tenantKey}/{orgKey}/settings/labelConfigurations |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute LabelConfiguration
- PUT Set IsActive LabelConfiguration
- PUT Set LabelConfigurationKey LabelConfiguration
- PUT Set Description LabelConfiguration
- PUT Set IsDefault LabelConfiguration
- PUT Set Type LabelConfiguration
- PUT Set Width LabelConfiguration
- PUT Set Height LabelConfiguration
- PUT Set Padding LabelConfiguration
- PUT Set ShowText LabelConfiguration
- PUT Set TextSize LabelConfiguration
- PUT Set Tags LabelConfiguration
- PUT Set Remarks LabelConfiguration
- DELETE:
All Resources
This service uses the following resources:
- ApiLabelConfigurationResource
- CustomReportResource
- LabelConfigurationResource
- PrintDefaultResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET LabelConfigurations (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 LabelConfigurationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET LabelConfiguration 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 LabelConfigurationResource. |
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 LabelConfiguration by key
Returns the entity record that matches the specified key.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
Response:
| When successful, the response body contains the entity record. See LabelConfigurationResource. |
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:
POST LabelConfigurations
Creates a new entity record.
The following elements are required:
| labelConfigurationResource | (ApiLabelConfigurationResource) The request body should contain the entity record that should be created. See ApiLabelConfigurationResource. |
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 ApiLabelConfigurationResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Print
Custom operation 'Print'.
The following elements are required:
| configuration | (ApiLabelConfigurationResource) Configuration. |
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 a string. |
Resource URL:
POST Print Custom
Custom operation 'PrintCustom'.
The following elements are required:
| customReport | (CustomReportResource) CustomReport. |
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 a string. |
Resource URL:
POST Print Default
Custom operation 'PrintDefault'.
The following elements are required:
| tags | (List |
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 a string. |
Resource URL:
PUT Set Description LabelConfiguration
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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:
PUT Set Height LabelConfiguration
Updates the value of attribute 'Height' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| value | (int) 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:
PUT Set IsActive LabelConfiguration
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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:
PUT Set IsDefault LabelConfiguration
Updates the value of attribute 'IsDefault' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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. |
Resource URL:
PUT Set LabelConfigurationKey LabelConfiguration
Updates the value of attribute 'LabelConfigurationKey' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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:
PUT Set Padding LabelConfiguration
Updates the value of attribute 'Padding' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| value | (int) 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:
PUT Set Remarks LabelConfiguration
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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:
PUT Set ShowText LabelConfiguration
Updates the value of attribute 'ShowText' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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. |
Resource URL:
PUT Set Tags LabelConfiguration
Updates the value of attribute 'Tags' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| 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:
PUT Set TextSize LabelConfiguration
Updates the value of attribute 'TextSize' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| value | (int) 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:
PUT Set Type LabelConfiguration
Updates the value of attribute 'Type' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| value | (enum LabelType) The request body should contain the new value for the attribute. See LabelType. |
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:
PUT Set Width LabelConfiguration
Updates the value of attribute 'Width' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| value | (int) 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:
PUT Set Custom Attribute LabelConfiguration
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| labelConfigurationKey | (string) Tag Template |
| 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:
DELETE LabelConfiguration 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:
DELETE LabelConfiguration by key
Deletes the entity record that matches the specified key.
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
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:
Resources
ApiLabelConfigurationResource
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| type | (enum LabelType) Type.
See LabelType. |
The following elements are optional:
| description | (string) Description. |
| isDefault | (bool) Is Default. |
| width | (int) Width. |
| height | (int) Height. |
| padding | (int) Padding. |
| showText | (bool) Show Text. |
| textSize | (int) Text Size. |
| tags | (string) Tags. |
| remarks | (string) Remarks. |
CustomReportResource
The following elements are optional:
| reportDefinition | (string) Report Definition. |
| tags | (string) Tags. |
| keyword | (string) Keyword. |
LabelConfigurationResource
The following elements are required:
| labelConfigurationKey | (string) Tag Template. |
| type | (enum LabelType) Type.
See LabelType. |
The following elements are optional:
| description | (string) Description. |
| isDefault | (bool) Is Default. |
| width | (int) Width. |
| height | (int) Height. |
| padding | (int) Padding. |
| showText | (bool) Show Text. |
| textSize | (int) Text Size. |
| tags | (string) Tags. |
| remarks | (string) Remarks. |
PrintDefaultResource
The following elements are optional:
| tags | (string) Tags. |
| keywords | (string) Keywords. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |