Retrieve Service Task

GET https://secure.fleetio.com/api/v1/service_tasks/:id

Retrieve the details of an existing Service Task.

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

Query Parameters

expand object

Currently accepts service_task_parts.

Responses

application/json

Schema
Example (auto)

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestringrequired

A name for this Service Task.

Possible values: <= 255 characters

descriptionstringnullablerequired

A description of this Service Task.

expected_duration_in_secondsintegernullable

The expected duration in seconds this Service Task should take to complete.

archived_atdate-timenullable

The date and time at which this Service Task was archived. null if this Service Task is active.

subtasks object[]required

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestring

The name of this subtask.

descriptionstringnullable

A description of this subtask.

expected_duration_in_secondsintegernullable

The expected duration in seconds this subtask should take to complete.

subtasksarray

The subtasks array at this level will always be empty.

default_vmrs_reason_for_repair objectnullable

default_vmrs_system_group objectnullable

default_vmrs_system objectnullable

default_vmrs_assembly objectnullable

default_vmrs_component objectnullable

]

usageinteger

Indicates the number of times this Service Task has been used. Available by setting the include_usage query parameter to 1.

default_vmrs_reason_for_repair objectnullablerequired

default_vmrs_system_group objectnullablerequired

default_vmrs_system objectnullablerequired

default_vmrs_assembly objectnullablerequired

default_vmrs_component objectnullablerequired

service_task_parts object[]

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "description": "string",
  "expected_duration_in_seconds": 0,
  "archived_at": "2024-07-29T15:51:28.071Z",
  "subtasks": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "name": "string",
      "description": "string",
      "expected_duration_in_seconds": 0,
      "subtasks": [
        null
      ],
      "default_vmrs_reason_for_repair": {
        "account_id": 0,
        "alias": "string",
        "code": "string",
        "enabled": true,
        "id": 0,
        "name": "string",
        "repair_type": "string",
        "standard": true,
        "standard_name": "string",
        "type": "string",
        "vmrs_standard_reason_for_repair": {}
      },
      "default_vmrs_system_group": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "default_vmrs_system": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "default_vmrs_assembly": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      },
      "default_vmrs_component": {
        "account_id": 0,
        "assembly_code": "string",
        "assembly_name": "string",
        "code_type": "system_group",
        "component_code": "string",
        "component_name": "string",
        "enabled": true,
        "id": 0,
        "permissions": {
          "destroy": true
        },
        "standard": true,
        "system_code": "string",
        "system_group": "string",
        "system_group_code": "string",
        "system_name": "string",
        "type": "string",
        "vmrs_standard_system_assembly_component": {}
      }
    }
  ],
  "usage": 0,
  "default_vmrs_reason_for_repair": {
    "account_id": 0,
    "alias": "string",
    "code": "string",
    "enabled": true,
    "id": 0,
    "name": "string",
    "repair_type": "string",
    "standard": true,
    "standard_name": "string",
    "type": "string",
    "vmrs_standard_reason_for_repair": {}
  },
  "default_vmrs_system_group": {
    "account_id": 0,
    "assembly_code": "string",
    "assembly_name": "string",
    "code_type": "system_group",
    "component_code": "string",
    "component_name": "string",
    "enabled": true,
    "id": 0,
    "permissions": {
      "destroy": true
    },
    "standard": true,
    "system_code": "string",
    "system_group": "string",
    "system_group_code": "string",
    "system_name": "string",
    "type": "string",
    "vmrs_standard_system_assembly_component": {}
  },
  "default_vmrs_system": {
    "account_id": 0,
    "assembly_code": "string",
    "assembly_name": "string",
    "code_type": "system_group",
    "component_code": "string",
    "component_name": "string",
    "enabled": true,
    "id": 0,
    "permissions": {
      "destroy": true
    },
    "standard": true,
    "system_code": "string",
    "system_group": "string",
    "system_group_code": "string",
    "system_name": "string",
    "type": "string",
    "vmrs_standard_system_assembly_component": {}
  },
  "default_vmrs_assembly": {
    "account_id": 0,
    "assembly_code": "string",
    "assembly_name": "string",
    "code_type": "system_group",
    "component_code": "string",
    "component_name": "string",
    "enabled": true,
    "id": 0,
    "permissions": {
      "destroy": true
    },
    "standard": true,
    "system_code": "string",
    "system_group": "string",
    "system_group_code": "string",
    "system_name": "string",
    "type": "string",
    "vmrs_standard_system_assembly_component": {}
  },
  "default_vmrs_component": {
    "account_id": 0,
    "assembly_code": "string",
    "assembly_name": "string",
    "code_type": "system_group",
    "component_code": "string",
    "component_name": "string",
    "enabled": true,
    "id": 0,
    "permissions": {
      "destroy": true
    },
    "standard": true,
    "system_code": "string",
    "system_group": "string",
    "system_group_code": "string",
    "system_name": "string",
    "type": "string",
    "vmrs_standard_system_assembly_component": {}
  },
  "service_task_parts": [
    {
      "id": 0,
      "quantity": 0,
      "part_id": 0,
      "part_archived_at": "2024-07-29T15:51:28.071Z",
      "position": 0
    }
  ]
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

The requested resource could not be located

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

CURL

curl -L 'https://secure.fleetio.com/api/v1/service_tasks/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

ResponseClear

Click the Send API Request button above and see the response here!

Retrieve Service Task

https://secure.fleetio.com/api/v1/service_tasks/:id

Request​

Path Parameters

Query Parameters

Responses​

Authorization: Authorization

Request

Responses