Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

Recipe

object

  • editRevisionstringpattern ^[0-9a-f]{32}$

    Opaque durable revision paired with this document state. Camera and derived writes do not change it.

  • lastChangedAtstringor nullformat date-time

    Time of the last accepted covered change, independent of camera and cache clocks.

  • lastChangedBy

    A named actor has display and fixed SQL names. { deleted: true } explicitly identifies a deleted actor and carries no names or profile fields. Null explicitly means unknown. Never inferred from ownership.

    One of:

    • object

      • namestringrequired

      • sqlNamestringrequired

      No other keys.

    • object

      • deletedbooleanalways truerequired

      No other keys.

    • or null

  • idstring

  • namestring

  • originstring

    Which surface made it: the workflows page lists workflow; the builder's one-step Tools make builder. Fixed at creation.

    One of workflow, builder

  • projectIdstringor null

    The project this workflow is in: on the caller's own workflow always, a project they no longer reach included (they withdraw it with PATCH /api/projects/{id}/members), and on anyone else's the project through which the caller reaches it; null = in no project.

  • ownerPersonrequired

    The workflow's owner.

  • homestringrequired

    The SQL name of the workflow's SQL home: the account whose datasets its plain table names mean, whoever reads or runs it.

  • createdAtstring

  • updatedAtstring

    When it was last edited: rename, or a step added, edited, reordered or removed. A run is not an edit, and neither is a refused change. Strictly increasing.

  • summaryRecipeSummary

  • stepsarray of RecipeStep

All of:

  • object

    • editRevisionstringrequiredpattern ^[0-9a-f]{32}$

      Opaque durable revision paired with this document state. Camera and derived writes do not change it.

    • lastChangedAtstringor nullrequiredformat date-time

      Time of the last accepted covered change, independent of camera and cache clocks.

    • lastChangedByrequired

      A named actor has display and fixed SQL names. { deleted: true } explicitly identifies a deleted actor and carries no names or profile fields. Null explicitly means unknown. Never inferred from ownership.

      One of:

      • object

        • namestringrequired

        • sqlNamestringrequired

        No other keys.

      • object

        • deletedbooleanalways truerequired

        No other keys.

      • or null

Dezfil · Apache-2.0docs from 7439201b