Get TaskStatusHistory

1 min

GET

https://dev1.frontu.com//client/api/v2/tasksstatushistory

This endpoint allows us to get task status history information, oldest first (ordered by created ascending). Available in JSON and XML via the Accept header.

Pass task to narrow the feed to a single task. Omit it to get the full history feed for every task, as before. An identifier matching no task returns 200 with an empty items list.

Pass status to narrow the feed to particular task statuses - for example status=300 returns only the entries where work was stopped, each carrying the reason in stopStatusMessage. All filters combine.

Query Parameters

taskstring
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.
statusstring
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.
pagestring
Description
Page number.
itemsstring
Description
Items per page. Values above 1000 are capped at 1000; 0 or a missing value falls back to 100.
versionstring
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.

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonExampleExample with custom valuesExample of a stopped entry

Responses

200Returned when successful

object
- next_pagenumberrequired
- itemsobject[]required
  - taskstringrequired
    Min Length
    1
  - statusstringrequired
    Min Length
    1
  - createdstringrequired
    Min Length
    1
  - versionnumberrequired
  - coordinatesstringrequired
    Min Length
    1
  - stopStatusMessagestringrequired
    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.

400Returned when the status filter is not an integer or a comma separated list of integers

404Entity not found

curl

curl --request GET \
     --url https://dev1.frontu.com//client/api/v2/tasksstatushistory \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://dev1.frontu.com//client/api/v2/tasksstatushistory", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://dev1.frontu.com//client/api/v2/tasksstatushistory")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://dev1.frontu.com//client/api/v2/tasksstatushistory"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Returned when successful
{
  "next_page": 0,
  "items": [
    {
      "task": "",
      "status": "",
      "created": "",
      "version": 0,
      "coordinates": "",
      "stopStatusMessage": ""
    }
  ]
}

400

// Returned when the status filter is not an integer or a comma separated list of integers

404

// Entity not found