List Service Tasks

Returns a list of Service Tasks belonging to your account.

Query Parameters

• start_cursor string

  The start cursor for Keyset pagination.

• per_page integer

  Possible values: >= 2 and <= 100

  Default value: 50

  The number of records per page to return.

• filter object

  The fields, operations, and values to filter the records by.

  • name object

    like string required
  • default_vmrs_assembly_id object

    eq string required
  • default_vmrs_component_id object

    eq string required
  • default_vmrs_reason_for_repair_id object

    eq string required
  • default_vmrs_system_group_id object

    eq string required
  • default_vmrs_system_id object

    eq string required
  • service_task_category_id object

    eq string required
  • created_at object

    oneOf

    • MOD1
    • MOD2
    • MOD3
    • MOD4

    ---

    lt string required

    lte string required

    gt string required

    gte string required
  • updated_at object

    oneOf

    • MOD1
    • MOD2
    • MOD3
    • MOD4

    ---

    lt string required

    lte string required

    gt string required

    gte string required
• sort object

  The fields and direction to sort the results by.

  • id string

    Possible values: [asc, desc]

    Default value: desc

  • created_at string

    Possible values: [asc, desc]

  • updated_at string

    Possible values: [asc, desc]

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• start_cursor string

  The current start cursor of the records returned.

• next_cursor string

  The next cursor to retrieve the next page of records.

• per_page integer

  The maxumum number of records returned.

• estimated_remaining_count integer

  The number of remaining records including the returned records, up to a maximum of 500.

• filtered_by object[]

  The filters applied to the returned record set.

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4
  • MOD5
  • MOD6
  • MOD7
  • MOD8
  • MOD9

  ---

  name object

  like string

  default_vmrs_assembly_id object

  eq string

  default_vmrs_component_id object

  eq string

  default_vmrs_reason_for_repair_id object

  eq string

  default_vmrs_system_group_id object

  eq string

  default_vmrs_system_id object

  eq string

  service_task_category_id object

  eq string

  created_at object

  oneOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  lt string

  lte string

  gt string

  gte string

  updated_at object

  oneOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  lt string

  lte string

  gt string

  gte string
• sorted_by object[]

  The sorts applied to the returned record set.

  anyOf

  • MOD1
  • MOD2
  • MOD3

  ---

  id string

  Possible values: [asc, desc]

  created_at string

  Possible values: [asc, desc]

  updated_at string

  Possible values: [asc, desc]

• records object[]

  id integer

  created_at date-time

  updated_at date-time

  archived_at date-time

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

  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.

  default_vmrs_assembly_id integer

  The ID of the VMRS assembly associated with this Service Task.

  default_vmrs_component_id integer

  The ID of the VMRS component associated with this Service Task.

  default_vmrs_reason_for_repair_id integer

  The ID of the VMRS reason for repair associated with this Service Task.

  default_vmrs_system_group_id integer

  The ID of the VMRS system group associated with this Service Task.

  default_vmrs_system_id integer

  The ID of the VMRS system associated with this Service Task.

  service_task_category_id integer

  The ID of the Service Task Category associated with this Service Task.

  standard_service_task_id integer

  The ID of the Standard Service Task associated with this Service Task.

  merged_service_task_id integer

  The ID of the Merged Service Task associated with this Service Task.

  standard boolean

  Whether or not this Service Task is a Standard Service Task.

  is_group boolean

  Whether or not this Service Task is a group.

  service_task_category object

  A Service Task Category

  id integer

  name string

  The name of this Service Task Category.

  description string

  A description for this Service Task Category.

  parent_category_id integer

  The ID of the parent Service Task Category.

  standard boolean

  Whether or not this Service Task Category is standard.

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "name": {
        "like": "string"
      }
    },
    {
      "default_vmrs_assembly_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_component_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_reason_for_repair_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_system_group_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_system_id": {
        "eq": "string"
      }
    },
    {
      "service_task_category_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "id": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2024-11-21",
      "updated_at": "2024-11-21",
      "archived_at": "2024-11-21",
      "name": "string",
      "description": "string",
      "expected_duration_in_seconds": 0,
      "default_vmrs_assembly_id": 0,
      "default_vmrs_component_id": 0,
      "default_vmrs_reason_for_repair_id": 0,
      "default_vmrs_system_group_id": 0,
      "default_vmrs_system_id": 0,
      "service_task_category_id": 0,
      "standard_service_task_id": 0,
      "merged_service_task_id": 0,
      "standard": true,
      "is_group": true,
      "service_task_category": {
        "id": 0,
        "name": "string",
        "description": "string",
        "parent_category_id": 0,
        "standard": true
      }
    }
  ]
}

The format or parameters of the request was invalid

application/json

• Schema
• Example (from schema)

---

Schema

• errors object

  type

  items string

{
  "errors": {}
}

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"
}

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"
}

Loading...