Skip to content

Dispatch

Create and manage dispatch entries.

CreateDispatch

    core.CreateDispatch(dispatch)

Create a new dispatch. Author is a required field even for Swimlane entries.

  • Object
    • author: String!
    • userId: String
    • when: Date
    • swimlaneId: String
    • trackerId: String
    • body: String
    • blocks: String
    • data: Table
    • taskState: String
    • startTime: DateTime
    • endTime: DateTime
    • serviceId: String
    • batchId: String
    • attachments: String[]
    • taskTracker: String
    • swimlaneHandle: String
    • trackerHandle: String
    • programStatus: String
    • programId: String
    • updateMessage: String
    • createdAt: String typically set by the system but allows override for imported data
  • Number number of items in the table
    values = {
        someValue="foo", someOtherValue="bar"
    }
    core.CreateDispatch({
        author="..valid author id..",
        userId="..valid user id (if not author)..",
        trackerId="..valid tracker id..",
        data=values
    })

CreateOrUpdateDispatch

    core.CreateOrUpdateDispatch(dispatch)

Creates a dispatch as above but uses serviceId to find and update or create a new dispatch.

Find a dispatch by serviceId and update or create a new dispatch if not found. Author is a required field even for Swimlane entries.

  • Object
    • author: String!
    • userId: String
    • when: Date
    • swimlaneId: String
    • trackerId: String
    • body: String
    • blocks: String
    • data: Table
    • taskState: String
    • startTime: DateTime
    • endTime: DateTime
    • serviceId: String Required
    • batchId: String
    • attachments: String[]
    • taskTracker: String
    • swimlaneHandle: String
    • trackerHandle: String
    • programStatus: String
    • programId: String
    • updateMessage: String
  • Number number of items in the table
    values = {
        someValue="foo", someOtherValue="bar"
    }
    core.CreateOrUpdateDispatch({
        author="..valid author..",
        userId="..valid user id..",
        trackerId="..valid tracker id..",
        serviceId="..unique within the org..",
        data=values, 
    })

UpdateDispatchData

    core.UpdateDispatchData({dispatchId=...})

Finds an existing dispatch and updates the data attached, replacing the existing data.

  • Object
    • dispatchId: UUID!
    • trackerId: UUID!
    • data: Lua table
  • Boolean

UpdateDispatchTracker

    core.UpdateDispatchTracker({id=...})

Updates the tracker id for a dispatch. Provide either a tracker id or a tracker handle.

  • Object
    • id: UUID!
    • trackerId: UUID
    • trackerHandle: String
  • Boolean

AddAction

    core.AddAction({dispatchId=...})

Add a social action or participant to a dispatch.

  • Object
    • dispatchId: String! dispatch id
    • userId: UUID! user for the action
    • action: Enumeration! answer, participant, leader, organizer, like, bookmark, confirm, process
    • payload: String action specific payload
  • Boolean