Create Service Task

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

Creates a new Service Task

Request

application/json

Body

namestringrequired

The name of the Service Task.

Possible values: <= 255 characters

descriptionstringnullable

A description of the Service Task.

Responses

201

OK

Response Headers

application/json

Schema

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

account_idId (integer)required

Possible values: >= 1

archived_atdate-timenullable

The date and time this Service Task was archived, if applicable.

namestringrequired

A name for this Service Task.

Possible values: <= 255 characters

descriptionstringnullablerequired

A description of this Service Task.

is_groupboolean

Whether this Service Task belongs to a group of Service Tasks.

expected_duration_in_secondsintegernullable

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

standardboolean

Whether this Service Task is a standard (commonly performed) Service Task.

category_hierarchystring

The category hierarchy of this Service Task.

Possible values: <= 255 characters

service_task_category_idintegernullable

The ID of the Service Task Category this Service Task belongs to.

standard_service_task_idintegernullable

The ID of the Standard Service Task this Service Task belongs to.

default_vmrs_reason_for_repair_idintegernullable

The ID of the default VMRS Reason for Repair for this Service Task.

default_vmrs_system_idintegernullable

The ID of the default VMRS System for this Service Task.

default_vmrs_assembly_idintegernullable

The ID of the default VMRS Assembly for this Service Task.

default_vmrs_component_idintegernullable

The ID of the default VMRS Component for this Service Task.

default_vmrs_system_group_idintegernullable

The ID of the default VMRS System Group for this Service Task.

merged_service_task_idintegernullable

If this Service Task has been merged, this is the ID of the Service Task it was merged into. More information can be found here: Merging Service Tasks

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "archived_at": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "description": "string",
  "is_group": true,
  "expected_duration_in_seconds": 0,
  "standard": true,
  "category_hierarchy": "string",
  "service_task_category_id": 0,
  "standard_service_task_id": 0,
  "default_vmrs_reason_for_repair_id": 0,
  "default_vmrs_system_id": 0,
  "default_vmrs_assembly_id": 0,
  "default_vmrs_component_id": 0,
  "default_vmrs_system_group_id": 0,
  "merged_service_task_id": 0
}

401

Request could not be authenticated

application/json

Schema

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.

Example (auto)

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

403

Insufficient permission to perform this operation

application/json

Schema

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.

Example (auto)

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

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

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.

Example (auto)

{
  "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
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/service_tasks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "name": "string",
  "description": "string"
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "name": "string",
  "description": "string"
}

ResponseClear

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