> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List failure codes

> The failure taxonomy this organisation classifies breakdowns with, for the picker that asks what failed when a job is completed.

`code` is what is written to a work order's own failure_code, so the reliability figures and the
job agree on one vocabulary. Inactive rows are returned rather than hidden, because a job closed
last year may still carry a mode that has since been retired; filter on is_active when offering
the list for a new answer.



## OpenAPI

````yaml /api-reference/integration.json get /failure_modes
openapi: 3.0.0
info:
  description: >-
    The calls an integration needs first. Every endpoint the application uses is
    in the complete reference.
  title: Asset Infinity integration API
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - description: >-
      Exchange an API key, or an email and password, for a short-lived session
      token, and send it as `Authorization: Bearer <token>` on every other call.
    name: Signing in
  - description: >-
      Where assets are and work happens. A location belongs to a site and may
      sit inside another location.
    name: Sites and locations
  - description: >-
      The asset register: read it, add to it, correct it, move an asset between
      sites and locations, and change its status.
    name: Assets
  - description: >-
      Report a problem. A request is triaged by a person, who turns it into a
      work order or turns it down.
    name: Work requests
  - description: >-
      Raise a job, give it to somebody, move it through the organisation's
      statuses, complete it and close it.
    name: Work orders
  - description: >-
      Send readings in. A meter reading brings the meter forward and raises any
      maintenance the usage has made due. A sensor reading can open or clear an
      alert.
    name: Meters and sensors
  - description: >-
      The part catalogue and what is on the shelf in each store, and the three
      movements an outside system most often records: a delivery in, an issue
      out and a correction.
    name: Parts and stock
  - description: >-
      Have the product call your system when something happens, instead of
      asking it on a timer.
    name: Webhooks
  - description: >-
      The calls behind every register that has no call of its own, answers to
      the organisation's own fields, and the two calls that answer what to send.
      `list_options` returns the ids a field accepts. `describe_call` returns
      the fields any call takes.
    name: Any record
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /failure_modes:
    get:
      tags:
        - Work orders
      summary: List failure codes
      description: >-
        The failure taxonomy this organisation classifies breakdowns with, for
        the picker that asks what failed when a job is completed.


        `code` is what is written to a work order's own failure_code, so the
        reliability figures and the

        job agree on one vocabulary. Inactive rows are returned rather than
        hidden, because a job closed

        last year may still carry a mode that has since been retired; filter on
        is_active when offering

        the list for a new answer.
      parameters:
        - $ref: '#/components/parameters/rowFilter.failure_modes.id'
        - $ref: '#/components/parameters/rowFilter.failure_modes.code'
        - $ref: '#/components/parameters/rowFilter.failure_modes.name'
        - $ref: '#/components/parameters/rowFilter.failure_modes.description'
        - $ref: '#/components/parameters/rowFilter.failure_modes.category'
        - $ref: '#/components/parameters/rowFilter.failure_modes.sort_order'
        - $ref: '#/components/parameters/rowFilter.failure_modes.is_active'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/failure_modes'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/failure_modes'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/failure_modes'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/failure_modes'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.failure_modes.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.failure_modes.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.failure_modes.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.failure_modes.description:
      in: query
      name: description
      required: false
      schema:
        type: string
    rowFilter.failure_modes.category:
      in: query
      name: category
      required: false
      schema:
        type: string
    rowFilter.failure_modes.sort_order:
      in: query
      name: sort_order
      required: false
      schema:
        type: string
    rowFilter.failure_modes.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    failure_modes:
      description: >-
        The failure taxonomy this organisation classifies breakdowns with, for
        the picker that asks

        what failed when a job is completed.


        `code` is what is written to a work order's own failure_code, so the
        reliability figures and the

        job agree on one vocabulary. Inactive rows are returned rather than
        hidden, because a job closed

        last year may still carry a mode that has since been retired; filter on
        is_active when offering

        the list for a new answer.
      properties:
        category:
          format: character varying
          maxLength: 60
          type: string
        code:
          format: character varying
          maxLength: 40
          type: string
        description:
          format: text
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        name:
          format: character varying
          maxLength: 150
          type: string
        sort_order:
          format: integer
          type: integer
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.