Create Service Task

Creates a new Service Task

application/json

Request Body

name string required
Possible values: <= 255 characters
The name of the Service Task.
description string
A description of the Service Task.

Responses

Response Headers

application/json

Schema
Example (from schema)

Schema

id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
account_id integer
Possible values: >= 1
archived_at date-time
The date and time this Service Task was archived, if applicable.
name string
Possible values: <= 255 characters
A name for this Service Task.
description string
A description of this Service Task.
is_group boolean
Whether this Service Task belongs to a group of Service Tasks.
expected_duration_in_seconds integer
The expected duration in seconds this Service Task should take to complete.
standard boolean
Whether this Service Task is a standard (commonly performed) Service Task.
category_hierarchy string
Possible values: <= 255 characters
The category hierarchy of this Service Task.
service_task_category_id integer
The ID of the Service Task Category this Service Task belongs to.
standard_service_task_id integer
The ID of the Standard Service Task this Service Task belongs to.
default_vmrs_reason_for_repair_id integer
The ID of the default VMRS Reason for Repair for this Service Task.
default_vmrs_system_id integer
The ID of the default VMRS System for this Service Task.
default_vmrs_assembly_id integer
The ID of the default VMRS Assembly for this Service Task.
default_vmrs_component_id integer
The ID of the default VMRS Component for this Service Task.
default_vmrs_system_group_id integer
The ID of the default VMRS System Group for this Service Task.
merged_service_task_id integer
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

{
  "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-12-19",
  "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
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
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.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
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 (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
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.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
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"
}

Unprocessable Entity

application/json

Schema
Example (from schema)
Example

Schema

errors object
type
items string

{
  "errors": {}
}

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

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
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.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
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"
}