AMEE API / AMEE Data API / Data Category Resource
Overview
This resource allows you to interact with Data Categories.The URL structure follows the URL Architecture.
All Profiles within the same Environment contain Profile Categories that directly match the URL structure of the Data Categories.
Example API Responses
Example API responses are available in the AMEE admin interface. Look for the API buttons on the right hand side.
Supported Methods
- GET - Fetch a Data Category and along with references to child objects.
- POST - Create a new Data Category or Data Item. Response will show the new object.
- PUT - Update the Data Category.
- DELETE - Delete a Data Category.
Parameter Definition
| Parameter | Definition | Methods |
| name | The name of the Data Category. | POST, PUT |
| path | The path of the Data Category. | POST, PUT |
| newObjectType | Should be 'DC' for a new Data Category or 'DI for a new Data Item. | POST |
| itemDefinitionUid | The UID of the Item Definition when creating a Data Category. Optional. | POST |
| {valueName} | Set a Data Item Value by specifying the name and value. For example, the value name could be 'distance' supplied with a value of '300'. Multiple name & value pairs can be submitted so long as the Item Values exist for the Data Item. | POST |
