Resource URL
Summary| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Retrieve the details of a specific Flex Attribute
Insert a specific Flex Attribute
Update a specific Flex Attribute
Push Flex Attribute changes to mobile device
Delete a specific Flex Attribute |
API Specific Parameters
| Parameter | Description |
|---|---|
| Identifies the unique flex attribute object. |
Supported HTTP Methods
| Method | Description |
|---|---|
| GET | Returns the flex attribute definition identified by the ${FlexAttrID} URL parameter. |
| PUT | Creates a new flex attribute definition identified by the ${FlexAttrID} URL parameter. If the flex attribute definition already exists and error will be returned. |
| POST | Updates the existing flex attribute definition identified by the ${FlexAttrID} URL parameter. |
| DELETE | Deletes an existing flex attribute definition, identified by
|
HTTP Body
The body contains a single FlexAttr object in the format specified on the URL.
RefreshMobile=1 | Add this parameter with a value of 1 to push updates to mobile devices. |
| Include Page | ||||
|---|---|---|---|---|
|
API Specifics
| Panel | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Retrieve the details of a specific Flex AttributeURL
HTTP Request BodyThis request does not require a request body. HTTP Response BodyOn success, an HTTP response code of 200 will be returned, and the response body will contain a REST Object Definitions Configuration Related Objects FlexAttr Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
|
| Panel | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Insert a specific Flex AttributeThis REST API will insert a new Flex Attribute with the specified ID into the system, if a Flex Attribute with the specified ID does not already exist in the system. The system will return error in case Flex Attribute with specific ID exists. URL
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Configuration Related Objects FlexAttr Object. HTTP ResponseOn success the API will return a response code of 200. |
| Panel | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Update a specific Flex AttributeThis REST API will update a Flex Attribute with the specified ID in the system. The Flex Attribute with the specified ID must already exist in the system. URL
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Configuration Related Objects FlexAttr Object. HTTP ResponseOn success the API will return a response code of 200. |
| Panel | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Push Flex Attribute changes to mobile deviceURL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success the API will return a response code of 200. |
| Panel | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Delete a specific Flex AttributeThis REST API will delete a Flex Attribute with the specified ID from the system. The Flex Attribute with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success the API will return a response code of 200. |