> ## 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.

# Describe a call

> Describe one call on this API: its method and path, what it takes or what it returns, and the sentences the reference is written from.

Name the entity as well — `core.assets` — and a call that writes a record answers with that record's own fields, which is what goes inside its `p_values`, and with the name of the call that exists for that entity alone where there is one. `describe_call('create_record', 'core.assets')` is how to find out what adding an asset looks like.

Name a function or a read model of the api schema. The path from a request works too, with or without its query string, so `/rpc/create_asset` and `create_asset` ask the same question.

There is deliberately no way to list what exists. This answers about something you can already name, which is something you can already call — the description of this API as a whole is published as a reference document rather than served.

Needs the permission that covers integrations.



## OpenAPI

````yaml /api-reference/integration.json post /rpc/describe_call
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:
  /rpc/describe_call:
    post:
      tags:
        - Any record
      summary: Describe a call
      description: >-
        Describe one call on this API: its method and path, what it takes or
        what it returns, and the sentences the reference is written from.


        Name the entity as well — `core.assets` — and a call that writes a
        record answers with that record's own fields, which is what goes inside
        its `p_values`, and with the name of the call that exists for that
        entity alone where there is one. `describe_call('create_record',
        'core.assets')` is how to find out what adding an asset looks like.


        Name a function or a read model of the api schema. The path from a
        request works too, with or without its query string, so
        `/rpc/create_asset` and `create_asset` ask the same question.


        There is deliberately no way to list what exists. This answers about
        something you can already name, which is something you can already call
        — the description of this API as a whole is published as a reference
        document rather than served.


        Needs the permission that covers integrations.
      parameters:
        - $ref: '#/components/parameters/preferParams'
      requestBody:
        content:
          application/json:
            schema:
              description: >-
                Describe one call on this API: its method and path, what it
                takes or what it returns, and the sentences the reference is
                written from.


                Name the entity as well — `core.assets` — and a call that writes
                a record answers with that record's own fields, which is what
                goes inside its `p_values`, and with the name of the call that
                exists for that entity alone where there is one.
                `describe_call('create_record', 'core.assets')` is how to find
                out what adding an asset looks like.


                Name a function or a read model of the api schema. The path from
                a request works too, with or without its query string, so
                `/rpc/create_asset` and `create_asset` ask the same question.


                There is deliberately no way to list what exists. This answers
                about something you can already name, which is something you can
                already call — the description of this API as a whole is
                published as a reference document rather than served.


                Needs the permission that covers integrations.
              properties:
                p_entity:
                  format: text
                  type: string
                p_name:
                  format: text
                  type: string
              required:
                - p_name
              type: object
          application/vnd.pgrst.object+json:
            schema:
              description: >-
                Describe one call on this API: its method and path, what it
                takes or what it returns, and the sentences the reference is
                written from.


                Name the entity as well — `core.assets` — and a call that writes
                a record answers with that record's own fields, which is what
                goes inside its `p_values`, and with the name of the call that
                exists for that entity alone where there is one.
                `describe_call('create_record', 'core.assets')` is how to find
                out what adding an asset looks like.


                Name a function or a read model of the api schema. The path from
                a request works too, with or without its query string, so
                `/rpc/create_asset` and `create_asset` ask the same question.


                There is deliberately no way to list what exists. This answers
                about something you can already name, which is something you can
                already call — the description of this API as a whole is
                published as a reference document rather than served.


                Needs the permission that covers integrations.
              properties:
                p_entity:
                  format: text
                  type: string
                p_name:
                  format: text
                  type: string
              required:
                - p_name
              type: object
          application/vnd.pgrst.object+json;nulls=stripped:
            schema:
              description: >-
                Describe one call on this API: its method and path, what it
                takes or what it returns, and the sentences the reference is
                written from.


                Name the entity as well — `core.assets` — and a call that writes
                a record answers with that record's own fields, which is what
                goes inside its `p_values`, and with the name of the call that
                exists for that entity alone where there is one.
                `describe_call('create_record', 'core.assets')` is how to find
                out what adding an asset looks like.


                Name a function or a read model of the api schema. The path from
                a request works too, with or without its query string, so
                `/rpc/create_asset` and `create_asset` ask the same question.


                There is deliberately no way to list what exists. This answers
                about something you can already name, which is something you can
                already call — the description of this API as a whole is
                published as a reference document rather than served.


                Needs the permission that covers integrations.
              properties:
                p_entity:
                  format: text
                  type: string
                p_name:
                  format: text
                  type: string
              required:
                - p_name
              type: object
          text/csv:
            schema:
              description: >-
                Describe one call on this API: its method and path, what it
                takes or what it returns, and the sentences the reference is
                written from.


                Name the entity as well — `core.assets` — and a call that writes
                a record answers with that record's own fields, which is what
                goes inside its `p_values`, and with the name of the call that
                exists for that entity alone where there is one.
                `describe_call('create_record', 'core.assets')` is how to find
                out what adding an asset looks like.


                Name a function or a read model of the api schema. The path from
                a request works too, with or without its query string, so
                `/rpc/create_asset` and `create_asset` ask the same question.


                There is deliberately no way to list what exists. This answers
                about something you can already name, which is something you can
                already call — the description of this API as a whole is
                published as a reference document rather than served.


                Needs the permission that covers integrations.
              properties:
                p_entity:
                  format: text
                  type: string
                p_name:
                  format: text
                  type: string
              required:
                - p_name
              type: object
        required: true
      responses:
        '200':
          description: OK
components:
  parameters:
    preferParams:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - params=single-object
        type: string

````

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