Get Task detail information

1 min

GET

https://dev1.frontu.com//client/api/v2/tasks/details

This endpoind allows to retrieve all information about one specific task and query params are used to retreive the one specific client.

Query Parameters

guidstringrequired
Description
GUID format entity identifier generated by Frontu.
systemIdstring
Description
Entity identifier from external system.
codestring
Description
Task code identifier.
billStatusstring
Description
Bill status.
statusstring
Description
Task status, if it is finished or not.
receivedByExternalSystemstring
Description
Task status, if it is received by external system.
isChildboolean
Description
true returns only tasks that are children of another task (parentId set), false only tasks without a parent. Also accepts 1/0. Omitted, empty or unrecognised values leave the list unfiltered.
hasChildrenboolean
Description
true returns only tasks that have at least one child task, false only tasks with no children. Also accepts 1/0. Omitted, empty or unrecognised values leave the list unfiltered.
pastDueboolean
Description
1/true returns only past-due tasks, 0/false only tasks that are not past due. Exact match on the task's pastDue flag. Omitted, empty or unrecognised values leave the list unfiltered.

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonExampleExample with custom values

Responses

200Returned when successful

object
- systemIdstring
  Min Length
  1
- codestring
  Min Length
  1
- titlestring
  Min Length
  1
- clientNamestring
  Min Length
  1
- clientEmailstring
  Min Length
  1
- ratingnumber
- agreementboolean
- signatureTypestring
  Min Length
  1
- signatureFilestring
  Min Length
  1
- descriptionstring
  Min Length
  1
- abortMessagestring
  Min Length
  1
- clientNotestring
  Min Length
  1
- clientNoteReplystring
  Min Length
  1
- distancenumber
- workPricenumber
- workPriceWithVatnumber
- routePricenumber
- routePriceWithVatnumber
- materialPricenumber
- materialPriceWithVatnumber
- finalPricenumber
- finalPriceWithVatnumber
- vatnumber
- currencystring
  Min Length
  1
- statusnumber
- stopStatusMessagestring
  Min Length
  1
- plannedTimestring
  Min Length
  1
- plannedEndTimestring
  Min Length
  1
- fixedPlannedTimeboolean
- fetchedboolean
- timestring
  Min Length
  1
- endedstring
  Min Length
  1
- pastDueboolean
- durationnumber
- durationFullnumber
- billDatestring
  Min Length
  1
- billStatusboolean
- reassignedboolean
- filesExistsboolean
- officeobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
  - addressstring
    Min Length
    1
- userobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- formerUserobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- assignorobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- taskTypeobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- workspaceobject
  - titlestring
    Min Length
    1
  - serialNumberstring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- clientobject
  - titlestring
    Min Length
    1
  - companyCodestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- createdByobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- taskRequeststring
  Min Length
  1
- requireObjectCodeboolean
- requireSignatureCodeboolean
- taskTypePrioritynumber
- guidstring
  Min Length
  1
- createdstring
  Min Length
  1
- updatedstring
  Min Length
  1
- versionnumber
- deletedboolean
- receivedByExternalSystemboolean
- approvedByobject
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- customValuesobject[]
  - guidstring
    Min Length
    1
  - guid2string
    Min Length
    1
- slaobject
  Description
  SLA assigned to the task, or null when none is assigned. duration is in MINUTES - the admin UI displays it as hours (duration / 60).
  - guidstring
  - systemIdstring
  - titlestring
  - durationinteger
    Description
    SLA duration in minutes.
- helpersobject[]
  - titlestring
    Min Length
    1
  - guidstring
    Min Length
    1
  - systemIdstring
    Min Length
    1
- tagsobject[]

400

Returned when the request contains no recognised filter parameter (e.g. guid or systemId), or when more than one entity matches.

object

Example

{
  "error": "At least one recognised filter parameter (e.g. guid or systemId) is required."
}

errorstring

404Entity not found

curl

curl --request GET \
     --url 'https://dev1.frontu.com//client/api/v2/tasks/details?guid=string' \
     --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/tasks/details?guid=string", 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/tasks/details?guid=string")

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/tasks/details?guid=string"

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
{
  "systemId": "",
  "code": "",
  "title": "",
  "clientName": "",
  "clientEmail": "",
  "rating": 0,
  "agreement": false,
  "signatureType": "",
  "signatureFile": "",
  "description": "",
  "abortMessage": "",
  "clientNote": "",
  "clientNoteReply": "",
  "distance": 0,
  "workPrice": 0,
  "workPriceWithVat": 0,
  "routePrice": 0,
  "routePriceWithVat": 0,
  "materialPrice": 0,
  "materialPriceWithVat": 0,
  "finalPrice": 0,
  "finalPriceWithVat": 0,
  "vat": 0,
  "currency": "",
  "status": 0,
  "stopStatusMessage": "",
  "plannedTime": "",
  "plannedEndTime": "",
  "fixedPlannedTime": false,
  "fetched": false,
  "time": "",
  "ended": "",
  "pastDue": false,
  "duration": 0,
  "durationFull": 0,
  "billDate": "",
  "billStatus": false,
  "reassigned": false,
  "filesExists": false,
  "office": {
    "title": "",
    "guid": "",
    "systemId": "",
    "address": ""
  },
  "user": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "formerUser": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "assignor": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "taskType": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "workspace": {
    "title": "",
    "serialNumber": "",
    "guid": "",
    "systemId": ""
  },
  "client": {
    "title": "",
    "companyCode": "",
    "guid": "",
    "systemId": ""
  },
  "createdBy": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "taskRequest": "",
  "requireObjectCode": false,
  "requireSignatureCode": false,
  "taskTypePriority": 0,
  "guid": "",
  "created": "",
  "updated": "",
  "version": 0,
  "deleted": false,
  "receivedByExternalSystem": false,
  "approvedBy": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "customValues": [
    {
      "guid": "",
      "guid2": ""
    }
  ],
  "sla": {
    "guid": "",
    "systemId": "",
    "title": "",
    "duration": 0
  },
  "helpers": [
    {
      "title": "",
      "guid": "",
      "systemId": ""
    }
  ],
  "tags": [
    {}
  ]
}

400

// Returned when the request contains no recognised filter parameter (e.g. guid or systemId), or when more than one entity matches.
{
  "error": ""
}

404

// Entity not found