AssetResponse

  • columns
    Type: array object[] · AssetColumnResponse[]

    Columns (field definitions) of this asset.

    • assetId
      Type: number
    • createdAt
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • descriptionOrder
      Type: number nullable
    • id
      Type: number

      Column ID

    • isDescription
      Type: boolean
    • isPrimaryKey
      Type: boolean
    • isRequired
      Type: boolean
    • isTitle
      Type: boolean
    • isVisible
      Type: boolean
    • key
      Type: string

      URL-safe key (slug). Auto-generated from name on create if omitted; unique within the asset; cannot be all-numeric. Usable in place of the id in any path.

    • name
      Type: string

      Column name. Must be unique within the asset; its key (slug) is derived from it.

    • order
      Type: number
    • settings
      Type: object
    • status
      Type: string enum
      values
      • active
      • inactive
    • type
      Type: string enum

      Column data type. One of: text, number, date, checkbox, hierarchyParent (links a row to a parent row), reference (links to another asset / entity), locationTag (ties the value to a tour location/tag), space (a space / environment), tagStatus (a status tag).

      values
      • text
      • number
      • date
      • checkbox
      • hierarchyParent
      • reference
      • locationTag
      • space
      • tagStatus
    • updatedAt
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • createdAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • id
    Type: number

    Asset ID

  • isTaggable
    Type: boolean
  • items
    Type: array object[] · AssetItemResponse[]

    Rows in this asset.

    A row — its id plus each column's key mapped to its value.

    • id
      Type: number

      Row ID.

    • propertyName
      Type: anything
  • itemsCount
    Type: number

    Total number of unique items in this asset

  • key
    Type: string

    URL-safe key (slug) — lowercase, no spaces. Auto-generated from name on create if omitted; unique within the project; cannot be all-numeric. Usable in place of the id in any path.

  • name
    Type: string
  • parentId
    Type: number nullable
  • projectId
    Type: number
  • scope
    Type: string enum

    Whether the asset is owned by the project or shared from the workspace.

    values
    • project
    • workspace
  • status
    Type: string enum
    values
    • active
    • inactive
  • updatedAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • workspaceId
    Type: number nullable

    Owning workspace (when scope is workspace).