WorkspaceNoteFields

Note fields for create/update. Anchor the note with location; optionally link an asset with assetKey + asset.

  • location
    Type: string
    required

    Required. The location's primary-key value (its name / code). Files the note against that location row.

  • asset
    Type: string

    The asset row's primary-key value, linking the note to that asset.

  • assetKey
    Type: string

    The asset table slug the asset value lives in (e.g. assets). Required when asset is sent.

  • assignee
    Type: string

    Identifier of the user the note is assigned to.

  • customFields
    Type: object

    Form field values keyed by field — captured through the note's form template.

    • propertyName
      Type: anything
  • description
    Type: string

    Note body / details.

  • dueDate
    Type: string Format: date-time

    Due date (ISO 8601).

  • id
    Type: integer

    Note ID. Omit to create a new note; include to update an existing one.

  • priority
    Type: string

    Note priority.

  • reporter
    Type: string

    Identifier of the user reporting the note.

  • scheduledDate
    Type: string Format: date-time

    When the work is scheduled (ISO 8601).

  • status
    Type: string

    Note status.

  • title
    Type: string

    Note title.