Skip to main content

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

    • lt string required
    • updated_at object
      oneOf

    • lt 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

OK


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

  • name object
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf

  • id 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.

Loading...