WorkOrderFields

  • Work order content. title is required on create; every field is optional on update, and an anchor left out of the body is not touched.

    • asset
      Type: string nullable

      The asset row's primary-key value — the thing being worked on.

    • assetKey
      Type: string nullable

      The asset table slug the asset value lives in. Required when asset is sent.

    • assignee
      Type: string

      Free-text assignee label — an external system's name for the owner.

    • assigneeUserId
      Type: number

      A Treedis user id. Sets the person who owns the job, and derives the department when no team is given.

    • closeoutNotes
      Type: string

      What was actually done.

    • customFieldValues
      Type: object

      Form answers, keyed by the work order form template's field ids.

    • department
      Type: string nullable

      The department's title (its human name).

    • description
      Type: string

      Job details.

    • dueDate
      Type: string Format: date-time

      ISO 8601.

    • estimatedDurationMinutes
      Type: number

      Planned duration.

    • location
      Type: string nullable

      The location row's primary-key value (e.g. its functional-location code).

    • parentWorkOrderId
      Type: number

      Makes this row a sub-work-order — one department's step of a cross-department job. The tree stays one level deep.

    • priority
      Type: string
    • reporter
      Type: string

      Who raised it.

    • scheduledDate
      Type: string Format: date-time

      Board placement — the day the job is due to run.

    • startDate
      Type: string Format: date-time

      ISO 8601. A dueDate earlier than this is rejected.

    • statusId
      Type: string

      A status id from the workspace vocabulary. Unknown or omitted falls back to the workspace default.

    • teamId
      Type: number

      The team row the job sits on. Drives the department when departmentId is not sent.

    • title
      Type: string

      Required on create.