GET
/
templates
/
_schema
Get templates schema
curl --request GET \
  --url https://{FUSION_HOST.com}/api/templating/templates/_schema
{
  "type": "Templating Template",
  "title": "Templating Template",
  "description": "Stores configuration of the templates.",
  "properties": {
    "dirty": true,
    "zoneIds": [
      "ab6d0e24-9e7a-35h9-a2e7-5hjl72b8a3ea, 2abc1e65-162d-3a8e-76f0-6a962e0f43c5"
    ],
    "metadata": {},
    "isStaging": true,
    "startTime": "2023-11-07T05:31:56Z",
    "app": "application-id",
    "isPublished": true,
    "triggers": {
      "exact": true,
      "filters": [
        {
          "inheritable": true,
          "key": "key1",
          "value": "value1"
        }
      ],
      "matchMode": "all",
      "search": "<string>",
      "urlContext": "<string>",
      "urlPath": "<string>"
    }
  },
  "category": "<string>",
  "categoryPriority": 123,
  "unsafe": true,
  "all": true,
  "isMarkedForDeletion": true,
  "endTime": "2024-08-24T14:15:22Z",
  "dirtyZoneIds": [
    "a3e0e22-9e6a-45h9-a2e7-5hjk72b9a3ea, 5avc1e65-162d-5b8e-92f0-6a962e0f43c5"
  ],
  "templateDirty": false,
  "neverPublished": false,
  "name": "your-app-name",
  "priority": 10,
  "id": "6a163bd4-5098-466c-22aa-40bf68294303"
}

Response

OK

​
id
string<uuid>
required

The universal unique identifier (UUID) of the Fusion application.

Example:

"6a163bd4-5098-466c-22aa-40bf68294303"

​
type
string
default:object

The type of object returned in the response.

Example:

"Templating Template"

​
title
string

Description of what is returned in the schema response.

Example:

"Templating Template"

​
description
string

Description of the information stored in the schema.

Example:

"Stores configuration of the templates."

​
properties
object

Properties stored in the schema.

​
category
string

The category of the object in the schema.

​
categoryPriority
integer

The importance (priority) of the object in the schema.

​
unsafe
boolean

The security status of the objects in the schema. If false, the schema contents are valid. If true, the schema contents are not valid.

​
all
boolean

This field indicates if the request includes published or unpublished (staging) templates. The default of false includes only published templates. If set to true, the request includes published and unpublished (staging) templates.

​
isMarkedForDeletion
boolean

This field indicates if the staging version of this template has been marked for deletion, but the deletion has not been completed because it has not been published yet. If true, the template has been marked for deletion, and when it is published, it will actually be deleted. If false, the template has not been marked for deletion.

​
endTime
string<date-time>

The template cannot be used after this date and time. The format is Epoch time format.

Example:

"2024-08-24T14:15:22Z"

​
dirtyZoneIds
string[]

The comma-delimited list of universal unique identifiers (UUIDs) of the zones (query profiles) that are associated with the template and have unpublished changes. This only applies to zones and is different from the status of the template. Even if the associated template is dirty (contains some type of changes that have not yet been published), the zones and their respective changes are separate.

​
templateDirty
boolean
default:false

The status of the template. If false, the template does not have unpublished changes. If true, this is the staging version of this template and it contains changes that have not yet been published. This only applies to templates and is different from the status of the zone. Even if the associated zone (query profile) for this template is dirty (contains some type of changes that have not yet been published), the template and its status are separate.

​
neverPublished
boolean
default:false

The status of the template in the zone. If false, the template has been published at some point. If true, this template has never been published.

​
name
string

The Fusion application name.

Example:

"your-app-name"

​
priority
integer

The order in which this template is processed when multiple templates with the same status (published or staging) are associated with the application. The higher the number, the earlier the template will be used. For example, a template with a priority of 10 is triggered before a template with a priority of 3.

Example:

10