TemplateDetail

object

One template: its card, how it is made, and what its version holds once installed.

• idstringrequired

  The template's id, the same across its versions.

• kindstringrequired

  A finished map, or a workflow example with its result map.

  One of map, workflow

• versionintegerrequiredminimum 1

  The version an open or a copy begun now takes: the newest the catalogue lists, unless the installed one is as new.

• titlestringrequired

  The template's title.

• questionstringrequired

  The question it answers, in a line.

• placestringrequired

  Where its data is.

• tagsarrayrequiredmin items 1max items 3

  One to three tags from a closed list.

  • (each item)string

    One of First map, Time, Analysis, 3D, Big data, Widgets, Flows

• dataDatestringrequiredpattern ^\d{4}(-\d{2}(-\d{2})?)?$

  The data's date: a year, a month or a day.

• sourcesarray of TemplateSourcerequiredmin items 1

  Every source of its data, with its licence and the credit it asks for.

• stepsarrayor nullrequiredmin items 1max items 50

  A workflow example's steps in their order, as its workflow holds them, so its graph can be drawn before it is downloaded; null for a map template.

  • (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.

    • outputstringrequired

      The name of the dataset it makes.

    • readsarray of stringrequired

      The names it reads: datasets of the template and earlier steps' outputs, never anything outside the template.

    No other keys.

• originstringrequired

  shipped: in this instance's image, working with no network; catalogue: listed by the template catalogue.

  One of shipped, catalogue

• installedintegeror nullrequiredminimum 1

  The version installed on this server (shipped or downloaded), or null.

• listedintegeror nullrequiredminimum 1

  The newest version the catalogue's last list names, or null.

• presentbooleanrequired

  Whether version is installed; false means its first open or copy downloads it.

• sizeintegerrequiredminimum 0

  The version's archive size in bytes, as transferred.

• picturestringrequired

  kept: GET /api/templates/{id}/picture answers it; not_kept: the catalogue's picture could not be read, or the pictures kept for one list reached their 64 MB first; too_large: the catalogue's picture was over its 2 MB bound and refused (template_picture_too_large).

  One of kept, not_kept, too_large

• howMadeobjectrequired

  • questionstringrequired

    The question in full.

  • datasetsarrayrequired

    • (each item)object

      • datasetstringrequired

        A dataset of the template.

      • sourcestringrequired

        The source it came from.

      • madestringrequired

        How it was made, in a line.

      No other keys.

  • stylingarray of stringrequired

    The styling choices, a line each.

  No other keys.

• contentsrequired

  What the version holds, once it is installed on this server (shipped, or downloaded and whole by its record); null while it is not, or when its files do not read. POST /api/templates/{id}/fetch installs a listed version.

  Any of:

  • TemplateContents

  • or null

No other keys.