SG Ground Truth

Recipes

A recipe records one call that ran, the response it returned, and the errors hit on the way to it. Every recipe was produced by a probe in the repository.

  • 001 publish version with media

    Publish a generated image to Flow PT as a Version, with provenance and the workflow attached

    • write
    • version
    • upload
    • attachment
    • provenance
  • 002 batch

    Apply many creates, updates and deletes in one atomic call, and match the results back to the requests

    • write
    • batch
    • create
    • version
    • shot
    • error-handling
    • silent
  • 003 query fields and pages

    Resolve a query field's value, and run the rows a saved Page shows

    • query
    • filter
    • summary
    • page
    • schema
    • operator
    • dotted-field
  • 004 register published file

    Register the next PublishedFile without overwriting the last one, and write a path the server resolves for every platform

    • write
    • published-file
    • path
    • storage
    • version
    • create
    • entity-field
  • 005 propagate status

    Roll a status up from a parent's Tasks and Versions onto the parent, without racing a concurrent write

    • write
    • status
    • task
    • version
    • shot
    • schema
    • batch
    • filter
    • silent
  • 006 media round trip

    Take media off one Version and put the same bytes on another, which is what every sync, transfer and hand-off does

    • write
    • version
    • media
    • upload
    • attachment
    • url
    • image
    • async
  • 007 build and reconcile a cut

    Write a Cut and its CutItems from an edit, read the timeline back, and reconcile a second edit against the Cut already there

    • write
    • cut
    • timecode
    • version
    • shot
    • batch
    • filter
    • entity-field
    • multi-entity
  • 008 delivery progress

    Keep a Delivery honest about what a long transfer is doing, including when it is cancelled and when it crashes

    • write
    • delivery
    • status
    • list-field
    • reply
    • upload
    • attachment
    • version
    • error-handling
  • 009 multi entity safely

    Add to and remove from a multi_entity field without destroying the links you did not mean to touch

    • write
    • multi-entity
    • entity-field
    • playlist
    • note
    • version
    • filter
    • silent
    • destructive
  • 010 status picker

    List the statuses a project actually offers, each with the label, colour and icon needed to draw it

    • status
    • icon
    • colour
    • schema
    • list-field
    • entity-field
    • dotted-field
    • project
    • cache
  • 012 sign in as a person

    Reach the REST API as a person, with no script key and no password, by having them approve a login in their browser

    • auth
    • token
    • user
    • launcher
  • 013 publish file bytes

    Publish a file's bytes onto a PublishedFile when the caller has no LocalStorage root to write under

    • upload
    • published-file
    • attachment
    • path
    • url
  • 014 notes about

    Find the Notes about a Shot, Asset or Version by the name of the thing, and read what each Note is linked to

    • note
    • dotted-field
    • multi-entity

Every entry on this site is the output of a probe in probes/. The corpus is generated by running those probes against a live Flow Production Tracking site, not written from memory.

Not affiliated with or endorsed by Autodesk. Flow Production Tracking is their product; this is an independent record of how its REST API answers.