Templates

Changed on

Start an async job to install the applications of the given template into the given workspace if the user has access to that workspace. The response contains those newly created applications.

post/api/templates/install/{workspace_id}/{template_id}/async/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/templates/install/{workspace_id}/{template_id}/async/
  • Auth
    HTTP bearer

Path parameters

template_idinteger required

The id related to the template that must be installed.

workspace_idinteger required

The id related to the workspace where the template applications must be installed into.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

ClientUndoRedoActionGroupIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

Response

idinteger required
typestring required

The type of the job.

progress_percentageinteger required

A percentage indicating how far along the job is. 100 means that it's finished.

statestring required

Indicates the state of the import job.

human_readable_errorstring

A human readable error message indicating what went wrong.

error_codestring

A machine readable error code indicating why the job failed.

created_onstring date-time required
updated_onstring date-time required
installed_applicationsunknown required

Changes

  • a3756c326fe1Revision changes
    • breaking

      the response property ///// became optional for the status

    • breaking

      the ///// response property's maxLength was unset from 50 for the response status

    • breaking

      added subschema #1 subschema #2 to the ///// response property oneOf list for the response status

    • breaking

      the ///// response's property type changed from string to no type for status

    • info

      added the optional property ///// to the response with the status

    • info

      the ///// response's property pattern ^[-a-zA-Z0-9_]+$ was removed for the status

  • e81714236040Revision changes
    • info

      the endpoint scheme security UserSource JWT was removed from the API