Tasks
API endpoint to get information about Task entities
Retrieve Task data
GET
Supported Protocol: HTTPS
GET /api/:version_number/:project_name/entity/task?:pagination_params
curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY" https://services.traxretail.com/api/v4/my-project/entity/task?sort=task_name&page=1&per_page=10
metadata object
Info related to pagination
task Object[]
List of tasks objects, each containing the following fields:
task_name string
Task name (Task names that have been configured in coordination with Trax implementation team)
task_code string
Task code (Task code names that have been configured in coordination with Trax implementation team)
task_uuid string
Unique identifier of the task
is_deleted boolean
True/False
template_group string
The template's template_group
fixture string
A type of display in the store such as cooler, main shelf, or secondary display
additional_attribute_1 string
The template's additional_attribute_1
additional_attribute_2 string
The template's additional_attribute_2
additional_attribute_3 string
The template's additional_attribute_3
additional_attribute_4 string
The template's additional_attribute_4
Request Details
Mandatory fields marked indicated by
*
{
"metadata": {
"page": 1,
"per_page": 200,
"page_count": 1,
"total_count": 1,
"links": {
"self": "?page=0&per_page=200",
"first": "?page=0&per_page=200",
"previous": "",
"next": "",
"last": ""
}
},
"task": [
{
"task_name": "My task",
"is_deleted": false,
"task_code": "My task code",
"task_uuid": "d1d0c666-c794-11eb-b8bc-0242ac130003",
"template_group": "test_group",
"fixture": "Primary Shelf",
"additional_attribute_1":"att 1",
"additional_attribute_2": "att 2",
"additional_attribute_3": "att 3",
"additional_attribute_4": "att 4"
},
{
"task_name": "My task-1",
"is_deleted": false,
"task_code": "My task code",
"task_uuid": "fe3283e2-c795-11eb-b8bc-0242ac130003",
"template_group": "test_group",
"fixture": "Primary Shelf",
"additional_attribute_1":"att 1",
"additional_attribute_2": "att 2",
"additional_attribute_3": "att 3",
"additional_attribute_4": "att 4"
}
]
}
Response
Response Details
The Tasks GET reply body will contain the following fields:
Validation and Errors
The following are the validations and errors that may appear due to an invalid GET request:
Incorrect or expired token
-
Error Code: 401 - Unauthorized
-
Error: Incorrect or expired token
Requesting a forbidden resource
-
Error Code: 403 - Forbidden
-
Error: A forbidden resource has been requested <resource>
Request Headers
Authorization string
Value: 'Auth-Token {project auth token}'
Authentication token provided by Trax
Query Parameters
version_number string *
The current implemented API version. <Major> version (e.g. 'v4')
project_name string *
Project name as provided by Trax
pagination params
For more info see the pagination page. By default the first page will be returned first