(Quick Reference)
31 Attributes (Item) - Reference Documentation
Version: 2.1
31 Attributes (Item)
31.1 List
Service: List attributes
Description: This web service returns a json list of attributes.
URL:
https://BASE_URL/api/VERSION/attributes
: 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 | |
| reference | Wildcard search by the resource's reference | String | no | reference=*color* |
| name | Wildcard search by the resource's name | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Status: HTTP/1.1 200 OK
{
"paging": {
"total": 7,
"max": 1,
"offset": 0,
"previous": null,
"next": "/api/v1.0/attributes?max=1&offset=1&sort=dateCreated&order=asc"
},
"data": [
{
"id": 1,
"reference": "color",
"name": "couleur",
"type": "COLOR",
"attributeValues": [
{
"id": 1,
"value": "vert",
"href": "/api/v1.0/attributeValues/1"
},
{
"id": 4,
"value": "Bleu",
"href": "/api/v1.0/attributeValues/4"
},
{
"id": 6,
"value": "Rouge",
"href": "/api/v1.0/attributeValues/6"
},
{
"id": 8,
"value": "Noir",
"href": "/api/v1.0/attributeValues/8"
},
{
"id": 14,
"value": "violet",
"href": "/api/v1.0/attributeValues/14"
},
{
"id": 15,
"value": "orange",
"href": "/api/v1.0/attributeValues/15"
},
{
"id": 16,
"value": "blanc",
"href": "/api/v1.0/attributeValues/16"
},
{
"id": 17,
"value": "rose",
"href": "/api/v1.0/attributeValues/17"
}
],
"organization": "entity1",
"dateCreated": "2016-01-18T15:40:12Z",
"lastUpdated": "2016-03-18T13:41:34Z"
}
]
} 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."
}31.2 Show
Service: Show an attribute
Description: This web service return an existing attribute of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/attributes/{id}:
https://BASE_URL/api/VERSION/attributes/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired attribute | Long/String | Yes | 123 |
Success Output
Success case: response.status=200
{
"id": 1,
"reference": "color",
"name": "couleur",
"type": "COLOR",
"attributeValues": [
{
"id": 1,
"value": "vert",
"href": "/api/v1.0/attributeValues/1"
},
{
"id": 4,
"value": "Bleu",
"href": "/api/v1.0/attributeValues/4"
},
{
"id": 6,
"value": "Rouge",
"href": "/api/v1.0/attributeValues/6"
},
{
"id": 8,
"value": "Noir",
"href": "/api/v1.0/attributeValues/8"
},
{
"id": 14,
"value": "violet",
"href": "/api/v1.0/attributeValues/14"
},
{
"id": 15,
"value": "orange",
"href": "/api/v1.0/attributeValues/15"
},
{
"id": 16,
"value": "blanc",
"href": "/api/v1.0/attributeValues/16"
},
{
"id": 17,
"value": "rose",
"href": "/api/v1.0/attributeValues/17"
}
],
"organization": "entity1",
"dateCreated": "2016-01-18T15:40:12Z",
"lastUpdated": "2016-08-22T13:24:40Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The attribute 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."
}31.3 Create
Service: Create an attribute
Description: Returns the created attribute in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/attributes
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| reference | | String | yes | |
| name | | String | yes | |
| type | Should be equal to COLOR,STRING or NUMBER. | String | yes | COLOR,STRING,NUMBER |
Attribute values parameterParameter name: values
Parameter type: a json structure
| Name | Description | Type | Required | Example values |
|---|
| value | | String | yes | black |
| color | Color code must be provided if type parameter is equal to COLOR | String | - | #000000 |
Success Output
Status: HTTP/1.1 201 Created
{
"id": 10,
"reference": "europe_shoe_size",
"name": "Women's shoe size",
"type": "NUMBER",
"attributeValues": [
{
"id": 35,
"value": "35",
"href": "/api/v1.0/attributeValues/35"
},
{
"id": 36,
"value": "36",
"href": "/api/v1.0/attributeValues/36"
},
{
"id": 37,
"value": "37",
"href": "/api/v1.0/attributeValues/37"
},
{
"id": 38,
"value": "38",
"href": "/api/v1.0/attributeValues/38"
},
{
"id": 39,
"value": "39",
"href": "/api/v1.0/attributeValues/39"
},
{
"id": 40,
"value": "40",
"href": "/api/v1.0/attributeValues/40"
},
{
"id": 41,
"value": "42",
"href": "/api/v1.0/attributeValues/41"
}
],
"organization": "entity1",
"dateCreated": "2016-08-22T14:10:44Z",
"lastUpdated": "2016-08-22T14:10:44Z"
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "missing_param",
"error_description": "name parameter is missing"
}{
"error": "invalid_param_type",
"error_description": "An invalid value was specified for parameter: type (must be in list)"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}31.4 Update
Service: Update an attribute
Description: Returns the updated attribute in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/attributes/{id}:
https://BASE_URL/api/VERSION/attributes/reference/{id}: PUT
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired attribute | Long | Yes | 123 |
| reference | | String | yes | |
| name | | String | yes | |
| type | Should be equal to COLOR,STRING or NUMBER. | String | yes | COLOR,STRING,NUMBER |
Attribute values parameterParameter name: values
Parameter type: a json structure
| Name | Description | Type | Required | Example values |
|---|
| value | | String | yes | black |
| color | Color code must be provided if type parameter is equal to COLOR | String | - | #000000 |
Success Output
Status: HTTP/1.1 200 OK
{
"id": 10,
"reference": "europe_shoe_size",
"name": "Women's shoe size",
"type": "NUMBER",
"attributeValues": [
{
"id": 49,
"value": "36",
"href": "/api/v1.0/attributeValues/49"
},
{
"id": 50,
"value": "37",
"href": "/api/v1.0/attributeValues/50"
},
{
"id": 51,
"value": "38",
"href": "/api/v1.0/attributeValues/51"
},
{
"id": 52,
"value": "39",
"href": "/api/v1.0/attributeValues/52"
},
{
"id": 53,
"value": "40",
"href": "/api/v1.0/attributeValues/53"
},
{
"id": 54,
"value": "42",
"href": "/api/v1.0/attributeValues/54"
}
],
"organization": "entity1",
"dateCreated": "2016-08-22T14:10:44Z",
"lastUpdated": "2016-08-22T14:38:06Z"
} Failure Output
Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The attribute with the id 42 doesn't exist."
} Status: HTTP/1.1 400 Bad Request
{
"error": "save_failed",
"error_description": "Failed to save instance"
}31.5 Delete
Service: Delete an attribute
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/attributes/{id}:
https://BASE_URL/api/VERSION/attributes/reference/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired attribute | LOng/String | yes | 123 |
Success Output
Status: HTTP/1.1 200 OK
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The attribute with the id 70 doesn't exist."
}
