TemplateContents

object

What an installed template version holds, read from this server: its map's id, its datasets and a workflow example's workflow.

• mapIdstringrequired

  The template map's id. GET /api/maps/{id} reads the map with its layers' SQL and styles, and the layer render and widget-value operations answer its layers, as for a map one may only view; nothing writes it.

• revisionstringrequired

  The version's revision, from its archive's checksum; the same for as long as the version is installed.

• createdAtstringrequiredformat date-time

  When the template's map was made, as it was published.

• updatedAtstringrequiredformat date-time

  When the template's map last changed before it was published.

• datasetsarray of TemplateDatasetrequired

  The template's own datasets.

• workflowrequired

  A workflow example's workflow: its steps with their parameters and its saved canvas arrangement; null for a map template.

  Any of:

  • object

    • namestringrequired

      The workflow's name.

    • stepsarrayrequiredmin items 1max items 50

      The steps in their order, each with the bundled result it came with as its output; a template's workflow never runs.

      • (each item)object

        • idstringrequired

          The step's id in the template's workflow.

        • operationstringrequired

          The operation it runs, by its id in the operation catalogue.

        • parametersobjectrequired

          Its parameters as the workflow holds them, its output's name among them, as a workflow's step is defined.

        • outputTemplateDatasetrequired

        • readsarray of stringrequired

          The names it reads: the template's datasets and earlier steps' outputs.

        No other keys.

    • layoutobjectrequired

      • stepsobjectrequired

        A position per step, keyed by step id.

        • (any other key)LayoutPosition

      • sourcesobjectrequired

        A position per dataset read, keyed by its name.

        • (any other key)LayoutPosition

      • notesarray of LayoutNoterequired

        The canvas's notes, in their order.

      • updatedAtstringor nullrequiredformat date-time

        When the arrangement was last written before the version was published; null for one with nothing placed, which the canvas arranges itself.

      No other keys.

    No other keys.

  • or null

No other keys.