Retrieve Service Task
Retrieve the details of an existing Service Task.
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
Query Parameters
- expand object
Currently accepts
service_task_parts
.- service_task_parts string
- 200
- 401
- 403
- 404
- 500
OK
- 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.
- name string
Possible values:
<= 255 characters
A name for this Service Task.
- description string
A description of this Service Task.
- expected_duration_in_seconds integer
The expected duration in seconds this Service Task should take to complete.
- archived_at date-time
The date and time at which this Service Task was archived.
null
if this Service Task is active. subtasks object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
name stringThe name of this subtask.
description stringA description of this subtask.
expected_duration_in_seconds integerThe expected duration in seconds this subtask should take to complete.
subtasks arrayThe subtasks array at this level will always be empty.
default_vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectdefault_vmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component object- usage integer
Indicates the number of times this Service Task has been used. Available by setting the
include_usage
query parameter to1
. default_vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectdefault_vmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectservice_task_parts object[]
Any
Parts
associated with this Service Task. Available by setting theexpand[]
query parameter toservice_task_parts
.id integerquantity floatThe quantity of this
Part
related to the Service Task.part_id integerThe ID of this
Part
related to the Service Task.part_archived_at date-timeThe date and time at which the
Part
related to the Service Task was archived, if applicable.position integerThe position of this
Part
in the list of Service Task Parts.
{
"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-10-07",
"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-10-07",
"position": 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"
}
The requested resource could not be located
- 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"
}
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"
}