{
  "opencollection": "1.0.0",
  "info": {
    "name": "Templafy Public DataSourceFields Documents API",
    "version": "v3"
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generates a document from a template and returns information about the file, which includes the download url.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/documents/assets/:assetId/generate",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The identifier of the space"
              },
              {
                "name": "assetId",
                "value": "",
                "type": "path",
                "description": "The identifier of the document template"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a file from the template in a docx format. The file will have bindings replaced using various data sources. The url will only be valid for a short amount of time. When a PDF is included in the response, its download URL may briefly be unavailable on receipt; clients should retry the download with a short backoff before treating an initial failure as final."
        },
        {
          "info": {
            "name": "Lists all document templates in the folder.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/documents/folders/:folderId/assets",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The identifier of the space"
              },
              {
                "name": "folderId",
                "value": "",
                "type": "path",
                "description": "The identifier of the folder"
              },
              {
                "name": "searchQuery",
                "value": "",
                "type": "query",
                "description": "Filter on template name, description and tags"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number from the result set. Page number is set to 1 by default if {searchQuery} is passed. A value passed only for the page number and not for the page size is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the returned page. If {searchQuery} is not set, not passing page size or having it 0 returns all the assets from the folder. Acceptable values are 0 to 1000, inclusive."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "The result does not include document templates from subfolders. When {searchQuery} is used the result includes document templates from subfolders. The search mode enables pagination with 1000 page size maximum."
        },
        {
          "info": {
            "name": "Uploads the document template.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/documents/folders/:folderId/assets",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The identifier of the space"
              },
              {
                "name": "folderId",
                "value": "",
                "type": "path",
                "description": "The identifier of the folder"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "File",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Description",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Tags",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "ExternalData",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Only one file can be attached to the request body. The supported file format is .DOCX"
        },
        {
          "info": {
            "name": "Returns the document template by the identifier.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/documents/assets/:assetId",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The identifier of the space"
              },
              {
                "name": "assetId",
                "value": "",
                "type": "path",
                "description": "The identifier of the document template to retrieve"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the document template by the identifier."
        },
        {
          "info": {
            "name": "Updates the document template.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/documents/assets/:assetId",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The identifier of the space"
              },
              {
                "name": "assetId",
                "value": "",
                "type": "path",
                "description": "The identifier of the document template"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "FolderId",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Description",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Tags",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "ExternalData",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "File",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Only one file can be attached to the request body. The supported file format is .DOCX"
        },
        {
          "info": {
            "name": "Deletes the document template by the identifier.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/documents/assets/:assetId",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The identifier of the space"
              },
              {
                "name": "assetId",
                "value": "",
                "type": "path",
                "description": "The identifier of the document template to delete"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes the document template by the identifier."
        }
      ]
    }
  ],
  "bundled": true
}