TypeCatalog

Every exposed record type, in the shape an agent can read in one call.

  • segment_rule
    Type: string · Segment Rule
    required

    How a path segment is derived from a public type name.

  • types
    Type: array object[] · Types
    required

    How one exposed record type can be queried.

    • expandable_links
      Type: array string[] · Expandable Links
      required

      Values the expand parameter accepts.

    • filterable_fields
      Type: array string[] · Filterable Fields
      required

      Query parameters the list route accepts for this type.

    • has_status
      Type: boolean · Has Status
      required

      Whether the type carries a status and accepts the filter.

    • name
      Type: string · Name
      required

      Public type name, as in id.dataType (e.g. Invoice).

    • segment
      Type: string · Segment
      required

      URL path segment for this type (e.g. vendor-bills).

    • sortable_fields
      Type: array string[] · Sortable Fields
      required

      Values the sort parameter accepts.

    • status_values
      Type: array string[] · Status Values
      required

      Accepted status values; empty without status.