Skip to main content
GET
/
api
/
organizations
/
{id}
/
availableTemplates
cURL
curl --request GET \
  --url http://localhost/api/organizations/{id}/availableTemplates
{
  "totalPages": 123,
  "totalElements": 123,
  "size": 123,
  "content": [
    {
      "ref": "<string>",
      "template": true,
      "orgSlug": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "version": "<string>",
      "get_id": "<string>",
      "publicAccess": true,
      "imageUrl": "<string>",
      "icon": "<string>",
      "overviewMarkdown": "<string>",
      "provider": "<string>",
      "providerUrl": "<string>",
      "providerImageUrl": "<string>",
      "deleteProtection": true,
      "checksum": "<string>",
      "deprecated": true,
      "extensionPackRef": "<string>",
      "stores": [
        {
          "slug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "storeType": "DOCUMENT",
          "storePurpose": "OPERATIONAL",
          "templateRef": "<string>",
          "ref": "<string>",
          "deleteProtection": true,
          "showThumbnails": true,
          "hasImage": true,
          "showStoreInLabeling": true,
          "highQualityPreview": true,
          "documentProperties": [
            {
              "groupOptions": [
                "<any>"
              ],
              "properties": {},
              "tabName": "<string>",
              "name": "<string>",
              "aliases": [
                "<any>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "type": "<string>",
              "subType": "<string>",
              "listType": "<string>",
              "displayProperties": {},
              "listLabel": "<string>",
              "listDescription": "<string>",
              "featureFlag": "<string>",
              "default": {},
              "description": "<string>",
              "supportArticle": "<string>",
              "overviewMarkdown": "<string>",
              "showIf": "<string>",
              "developerOnly": true,
              "showOnPopup": true,
              "possibleValues": [
                "<any>"
              ]
            }
          ],
          "labelExpressions": [
            {
              "label": "<string>",
              "expression": "<string>"
            }
          ],
          "allowDataEditing": true,
          "files": [
            {
              "url": "<string>",
              "metadata": {}
            }
          ]
        }
      ],
      "assistants": [
        {
          "name": "<string>",
          "slug": "<string>",
          "description": "<string>",
          "assistantDefinitionRef": "<string>",
          "options": {},
          "stores": [
            "<string>"
          ],
          "schedules": [
            {
              "type": "<string>",
              "cronExpression": "<string>",
              "lastEvent": "2023-11-07T05:31:56Z",
              "nextEvent": "2023-11-07T05:31:56Z"
            }
          ],
          "connections": [
            {
              "sourceType": "STORE",
              "sourceRef": "<string>",
              "targetType": "STORE",
              "targetRef": "<string>",
              "subscription": "<string>",
              "active": true
            }
          ],
          "subscription": "<string>",
          "loggingEnabled": true,
          "showInTraining": true,
          "priorityHint": 123,
          "chatEnabled": true,
          "assistantRole": "<string>"
        }
      ],
      "taxonomies": [
        {
          "slug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "taxonomyType": "CONTENT",
          "taxons": [
            {
              "id": "<string>",
              "label": "<string>",
              "order": 123,
              "generateName": true,
              "group": true,
              "name": "<string>",
              "selectWeight": 123,
              "externalName": "<string>",
              "valuePath": "VALUE_OR_ALL_CONTENT",
              "metadataValue": "FILENAME",
              "dataPath": "<string>",
              "expression": "<string>",
              "enableFallbackExpression": true,
              "fallbackExpression": "<string>",
              "enableSerializationExpression": true,
              "serializationExpression": "<string>",
              "nullable": true,
              "nullValue": "<string>",
              "denormalizeToChildren": true,
              "notUserLabelled": true,
              "description": "<string>",
              "overviewMarkdown": "<string>",
              "semanticDefinition": "<string>",
              "synonyms": [
                "<string>"
              ],
              "lexicalRelations": [
                {
                  "type": "SYNONYM",
                  "value": "<string>",
                  "weight": 123
                }
              ],
              "additionContexts": [
                {
                  "type": "RECORD_DEFINITION",
                  "context": "<string>",
                  "weight": 123,
                  "negative": true
                }
              ],
              "guideProperties": {
                "guidanceKey": true,
                "guidanceKeyExpression": "<string>",
                "useGuidanceForClassification": true,
                "ifPresentRequired": true
              },
              "enabled": true,
              "color": "<string>",
              "children": [
                {}
              ],
              "options": [
                {
                  "groupOptions": [
                    "<any>"
                  ],
                  "properties": {},
                  "tabName": "<string>",
                  "name": "<string>",
                  "aliases": [
                    "<any>"
                  ],
                  "label": "<string>",
                  "falseLabel": "<string>",
                  "hint": "<string>",
                  "required": true,
                  "type": "<string>",
                  "subType": "<string>",
                  "listType": "<string>",
                  "displayProperties": {},
                  "listLabel": "<string>",
                  "listDescription": "<string>",
                  "featureFlag": "<string>",
                  "default": {},
                  "description": "<string>",
                  "supportArticle": "<string>",
                  "overviewMarkdown": "<string>",
                  "showIf": "<string>",
                  "developerOnly": true,
                  "showOnPopup": true,
                  "possibleValues": [
                    "<any>"
                  ]
                }
              ],
              "nodeTypes": [
                "<string>"
              ],
              "taxonType": "STRING",
              "selectionOptions": [
                {
                  "label": "<string>",
                  "id": "<string>",
                  "description": "<string>",
                  "isConditional": true,
                  "conditionalFormula": "<string>",
                  "lexicalRelations": [
                    {}
                  ]
                }
              ],
              "typeFeatures": {},
              "properties": {},
              "conditionalFormats": [
                {
                  "type": "<string>",
                  "condition": "<string>",
                  "properties": {}
                }
              ],
              "validationRules": [
                {
                  "name": "<string>",
                  "disabled": true,
                  "description": "<string>",
                  "conditional": true,
                  "conditionalFormula": "<string>",
                  "ruleFormula": "<string>",
                  "messageFormula": "<string>",
                  "detailFormula": "<string>",
                  "exceptionId": "<string>",
                  "supportArticleId": "<string>",
                  "overridable": true
                }
              ],
              "cardinality": "ONCE_PER_DOCUMENT",
              "path": "<string>",
              "multiValue": true,
              "userEditable": true,
              "usePostExpression": true,
              "postExpression": "<string>"
            }
          ],
          "templateRef": "<string>",
          "ref": "<string>"
        }
      ],
      "dashboards": [
        {
          "slug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "widgets": [
            {
              "id": "<string>",
              "name": "<string>",
              "type": "<string>",
              "entryPoints": [
                "<string>"
              ],
              "properties": {},
              "children": [
                {}
              ]
            }
          ],
          "templateRef": "<string>",
          "ref": "<string>",
          "singleWidget": {
            "id": "<string>",
            "name": "<string>",
            "type": "<string>",
            "entryPoints": [
              "<string>"
            ],
            "properties": {},
            "children": [
              {}
            ]
          }
        }
      ],
      "dataForms": [
        {
          "name": "<string>",
          "description": "<string>",
          "slug": "<string>",
          "entrypoints": [
            "<string>"
          ],
          "cards": [
            {
              "id": "<string>",
              "type": "<string>",
              "properties": {},
              "children": [
                {}
              ]
            }
          ],
          "templateRef": "<string>",
          "ref": "<string>"
        }
      ],
      "workspaces": [
        {
          "name": "<string>",
          "slug": "<string>",
          "oldIdentifier": "<string>",
          "description": "<string>",
          "workspaceStorage": {
            "overview": "<string>",
            "currentViewId": "<string>",
            "defaultSidebar": "<string>",
            "properties": {},
            "availablePanels": {}
          }
        }
      ],
      "guidance": [
        {
          "slug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "guidance": [
            {
              "id": "<string>",
              "name": "<string>",
              "guidanceType": "<string>",
              "guidanceKey": "<string>",
              "taxonomyRef": "<string>",
              "taxonPath": "<string>",
              "documentFamilyId": "<string>",
              "documentName": "<string>",
              "documentPage": 123,
              "guidanceText": "<string>",
              "relationEmbeddings": [
                {
                  "relation": "<string>",
                  "modelId": "<string>",
                  "embedding": [
                    123
                  ]
                }
              ],
              "summary": "<string>",
              "guidanceResponse": {},
              "active": true,
              "applicableTags": [
                "<string>"
              ],
              "requiredTags": [
                "<string>"
              ],
              "priority": 123,
              "userInstructions": "<string>",
              "userId": "<string>",
              "created": "2023-11-07T05:31:56Z",
              "updated": "2023-11-07T05:31:56Z",
              "userInstructionsProperties": {},
              "userSelection": [
                {
                  "text": "<string>",
                  "lineUuid": "<string>"
                }
              ],
              "compiledGuidance": {},
              "guidanceOptions": [
                {
                  "groupOptions": [
                    "<any>"
                  ],
                  "properties": {},
                  "tabName": "<string>",
                  "name": "<string>",
                  "aliases": [
                    "<any>"
                  ],
                  "label": "<string>",
                  "falseLabel": "<string>",
                  "hint": "<string>",
                  "required": true,
                  "type": "<string>",
                  "subType": "<string>",
                  "listType": "<string>",
                  "displayProperties": {},
                  "listLabel": "<string>",
                  "listDescription": "<string>",
                  "featureFlag": "<string>",
                  "default": {},
                  "description": "<string>",
                  "supportArticle": "<string>",
                  "overviewMarkdown": "<string>",
                  "showIf": "<string>",
                  "developerOnly": true,
                  "showOnPopup": true,
                  "possibleValues": [
                    "<any>"
                  ]
                }
              ]
            }
          ],
          "activeStore": true,
          "storage": {
            "embeddingModelId": "<string>",
            "summarizeModelId": "<string>",
            "useCustomSummarizePrompt": true,
            "summarizePrompt": "<string>",
            "embeddingTypes": [
              "SUMMARY"
            ]
          },
          "templateRef": "<string>",
          "ref": "<string>"
        }
      ],
      "helpUrl": "<string>",
      "documentStatuses": [
        {
          "color": "<string>",
          "icon": "<string>",
          "status": "<string>",
          "slug": "<string>",
          "oldIdentifier": "<string>",
          "statusType": "UNRESOLVED"
        }
      ],
      "taskStatuses": [
        {
          "color": "<string>",
          "icon": "<string>",
          "label": "<string>",
          "slug": "<string>",
          "oldIdentifier": "<string>",
          "statusType": "TODO"
        }
      ],
      "attributeStatuses": [
        {
          "color": "<string>",
          "icon": "<string>",
          "status": "<string>",
          "statusType": "UNRESOLVED"
        }
      ],
      "options": {
        "options": [
          {
            "groupOptions": [
              "<any>"
            ],
            "properties": {},
            "tabName": "<string>",
            "name": "<string>",
            "aliases": [
              "<any>"
            ],
            "label": "<string>",
            "falseLabel": "<string>",
            "hint": "<string>",
            "required": true,
            "type": "<string>",
            "subType": "<string>",
            "listType": "<string>",
            "displayProperties": {},
            "listLabel": "<string>",
            "listDescription": "<string>",
            "featureFlag": "<string>",
            "default": {},
            "description": "<string>",
            "supportArticle": "<string>",
            "overviewMarkdown": "<string>",
            "showIf": "<string>",
            "developerOnly": true,
            "showOnPopup": true,
            "possibleValues": [
              "<any>"
            ]
          }
        ],
        "properties": {},
        "groupTaxonTypeFeatures": {},
        "taxonTypeFeatures": {},
        "taskOptions": {
          "showTakeNext": true,
          "showNewTask": true
        }
      },
      "tags": [
        {
          "label": "<string>",
          "color": "<string>"
        }
      ],
      "memory": {
        "recentFilters": {},
        "recentQueries": {},
        "orderedDashboards": [
          "<string>"
        ],
        "changeSequence": 123
      },
      "taskTemplates": [
        {
          "name": "<string>",
          "description": "<string>",
          "slug": "<string>",
          "oldIdentifier": "<string>",
          "metadata": {
            "options": [
              {
                "groupOptions": [
                  "<any>"
                ],
                "properties": {},
                "tabName": "<string>",
                "name": "<string>",
                "aliases": [
                  "<any>"
                ],
                "label": "<string>",
                "falseLabel": "<string>",
                "hint": "<string>",
                "required": true,
                "type": "<string>",
                "subType": "<string>",
                "listType": "<string>",
                "displayProperties": {},
                "listLabel": "<string>",
                "listDescription": "<string>",
                "featureFlag": "<string>",
                "default": {},
                "description": "<string>",
                "supportArticle": "<string>",
                "overviewMarkdown": "<string>",
                "showIf": "<string>",
                "developerOnly": true,
                "showOnPopup": true,
                "possibleValues": [
                  "<any>"
                ]
              }
            ],
            "forms": [
              {
                "dataFormRef": "<string>",
                "actions": [
                  {
                    "uuid": "<string>",
                    "type": "<string>",
                    "label": "<string>",
                    "properties": {}
                  }
                ],
                "availablePanels": {},
                "properties": {}
              }
            ],
            "actions": [
              {
                "uuid": "<string>",
                "type": "<string>",
                "label": "<string>",
                "properties": {}
              }
            ],
            "documentFamilyGroups": [
              {
                "name": "<string>",
                "notes": "<string>",
                "documentFamilyFilter": "<string>",
                "maxHits": 123,
                "sort": "<string>",
                "automaticallyAdd": true,
                "editable": true
              }
            ],
            "workspaceId": "<string>",
            "properties": {},
            "priority": 123
          }
        }
      ],
      "scheduledModels": [
        {
          "name": "<string>",
          "description": "<string>",
          "modelRef": "<string>",
          "properties": {},
          "schedules": [
            {
              "type": "<string>",
              "cronExpression": "<string>",
              "lastEvent": "2023-11-07T05:31:56Z",
              "nextEvent": "2023-11-07T05:31:56Z",
              "id": "<string>"
            }
          ],
          "active": true,
          "deleted": true,
          "oldIdentifier": "<string>"
        }
      ]
    }
  ],
  "number": 123,
  "sort": [
    {
      "direction": "<string>",
      "nullHandling": "<string>",
      "ascending": true,
      "property": "<string>",
      "ignoreCase": true
    }
  ],
  "first": true,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "sort": [
      {
        "direction": "<string>",
        "nullHandling": "<string>",
        "ascending": true,
        "property": "<string>",
        "ignoreCase": true
      }
    ],
    "paged": true,
    "unpaged": true,
    "pageNumber": 123,
    "pageSize": 123
  },
  "last": true,
  "empty": true
}

Path Parameters

id
string
required

Query Parameters

page
integer
default:0

Zero-based page index (0..N)

pageSize
integer
default:10

The size of the page to be returned

sort
string

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

filter
string

A filter that will be applied

query
string

A simple text query that will be applied

Response

OK

totalPages
integer
totalElements
integer
size
integer
content
object[]
number
integer
sort
object[]
first
boolean
numberOfElements
integer
pageable
object
last
boolean
empty
boolean
I