(Quick Reference)
29 Attribute values (Item) - Reference Documentation
Version: 2.1
29 Attribute values (Item)
29.1 List
Service: List attribute values
Description: This web service returns a json list of attribute values.
URL:
https://BASE_URL/api/VERSION/attributeValues
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The
max parameter is set to
100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| attributeReference | Wildcard search by the attribute's reference | String | no | attributeReference=*color* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Status: HTTP/1.1 200 OK
{
"paging": {
"total": 27,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"attribute": {
"id": 1,
"reference": "color",
"name": "couleur",
"href": "/api/v1.0/attributes/1"
},
"value": "vert",
"color": "#03b69c",
"displayOrder": 51,
"organization": "entity1",
"dateCreated": "2016-01-18T15:40:13Z",
"lastUpdated": "2016-01-26T11:25:11Z"
}…
]
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}29.2 Show
Service: Show an attribute value
Description: This web service return an existing attribute value of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/attributeValues/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired attribute value | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 1,
"attribute": {
"id": 1,
"reference": "color",
"name": "couleur",
"href": "/api/v1.0/attributes/1"
},
"value": "vert",
"color": "#03b69c",
"displayOrder": 51,
"organization": "entity1",
"dateCreated": "2016-01-18T15:40:13Z",
"lastUpdated": "2016-01-26T11:25:11Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The attribute value with the id 199 doesn't exist."
} Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
