This endpoint allows us to get task status history information, oldest first (ordered by\ncreated ascending). Available in JSON and XML via the Accept header.
\nPass task to narrow the feed to a single task. Omit it to get the full history feed for every\ntask, as before. An identifier matching no task returns 200 with an empty items list.
\nPass status to narrow the feed to particular task statuses - for example status=300 returns\nonly the entries where work was stopped, each carrying the reason in stopStatusMessage. All\nfilters combine.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values", "Example of a stopped entry" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "task", "type": "string", "description": "Narrow the results to one task. Accepts either the task GUID (generated by Frontu) or its systemId (identifier from an external system) - the endpoint detects which format was passed. Omit to return every task's history.
" }, { "kind": "optional", "name": "status", "type": "string", "example": "300,600", "description": "Narrow the results to one or more task statuses. Accepts a single status (status=300) or a comma separated list (status=300,600). Statuses no record uses are simply not matched. Anything other than digits and commas returns 400. Omit to return entries of every status.
" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "items", "type": "string", "description": "Items per page. Values above 1000 are capped at 1000; 0 or a missing value falls back to 100.
" }, { "kind": "optional", "name": "version", "type": "string", "description": "Filter data by given timestamp. (WHERE table.created >
). Strictly greater than, so records created in the boundary second are not returned. Omit to get the full history." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "Value: Bearer {access_token}
", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "status", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "coordinates", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "stopStatusMessage", "kind": "required", "type": "string", "nullable": true, "description": "The reason work was stopped, as recorded on this entry. Free text taken from the stop reason the app user picked, so it is the reason title rather than a stable identifier from the taskstopreasons dictionary. Null on entries that do not record a stop.
" } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Returned when the status filter is not an integer or a comma separated list of integers", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "CQB52SxOIdbC-FpC616GD", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://dev1.frontu.com//client/api/v2/tasksstatushistory \\\n --header 'accept: application/json'" }, { "id": "BTNFOP82kM4vQcyjaA9nj", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://dev1.frontu.com//client/api/v2/tasksstatushistory\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "IEk9Z4gP5_qOVMWPprJ-8", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://dev1.frontu.com//client/api/v2/tasksstatushistory\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "-gHHXWuKE-rlnOwTsKxzK", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://dev1.frontu.com//client/api/v2/tasksstatushistory\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "CQB52SxOIdbC-FpC616GD" }, "results": { "languages": [ { "id": "PKL2Ggzr0HGibDq1p70Ie", "language": "200", "code": "// Returned when successful\n{\n \"next_page\": 0,\n \"items\": [\n {\n \"task\": \"\",\n \"status\": \"\",\n \"created\": \"\",\n \"version\": 0,\n \"coordinates\": \"\",\n \"stopStatusMessage\": \"\"\n }\n ]\n}" }, { "id": "wq1P-RMF5pvYcJQr7OpKt", "language": "400", "code": "// Returned when the status filter is not an integer or a comma separated list of integers\n" }, { "id": "vuaN7l35-JihUlJDBcB2p", "language": "404", "code": "// Entity not found\n" } ], "selectedLanguageId": "PKL2Ggzr0HGibDq1p70Ie" } }, "children": [ { "text": "" } ] }