Get the available model for the organization

cURL

curl --request GET \
  --url http://localhost/api/organizations/{id}/availableAssistants

{
  "totalPages": 123,
  "totalElements": 123,
  "size": 123,
  "content": [
    {
      "orgSlug": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "name": "<string>",
      "version": "<string>",
      "ref": "<string>",
      "template": true,
      "description": "<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>",
      "schedulable": true,
      "reactive": true,
      "assistant": {
        "package": "<string>",
        "class": "<string>"
      },
      "services": [
        {
          "orgSlug": "<string>",
          "slug": "<string>",
          "type": "<string>",
          "name": "<string>",
          "version": "<string>",
          "ref": "<string>",
          "template": true,
          "description": "<string>",
          "get_id": "<string>",
          "publicAccess": true,
          "imageUrl": "<string>",
          "icon": "<string>",
          "overviewMarkdown": "<string>",
          "provider": "<string>",
          "providerUrl": "<string>",
          "providerImageUrl": "<string>",
          "deleteProtection": true,
          "checksum": "<string>",
          "deprecated": true
        }
      ],
      "processingTaxonomies": [
        {
          "ref": "<string>"
        }
      ],
      "options": [
        {
          "name": "<string>",
          "type": "<string>",
          "groupOptions": "<array>",
          "properties": {},
          "tabName": "<string>",
          "aliases": [
            "<string>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "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": [
            {
              "label": "<string>",
              "value": {},
              "description": "<string>"
            }
          ]
        }
      ],
      "optionTabs": [
        {
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "optionNames": [
            "<string>"
          ],
          "showInTraining": true,
          "showIf": "<string>"
        }
      ],
      "additionalTaxonOptions": [
        {
          "name": "<string>",
          "type": "<string>",
          "groupOptions": "<array>",
          "properties": {},
          "tabName": "<string>",
          "aliases": [
            "<string>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "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": [
            {
              "label": "<string>",
              "value": {},
              "description": "<string>"
            }
          ]
        }
      ],
      "taxonFeatures": [
        {
          "taxonPath": "<string>",
          "groupOnly": true,
          "options": [
            {
              "name": "<string>",
              "type": "<string>",
              "groupOptions": "<array>",
              "properties": {},
              "tabName": "<string>",
              "aliases": [
                "<string>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "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": [
                {
                  "label": "<string>",
                  "value": {},
                  "description": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "eventTypes": [
        {
          "name": "<string>",
          "icon": "<string>",
          "label": "<string>",
          "description": "<string>",
          "contentObject": true,
          "entryPoints": [
            "<string>"
          ],
          "optionTabs": [
            {
              "name": "<string>",
              "description": "<string>",
              "icon": "<string>",
              "optionNames": [
                "<string>"
              ],
              "showInTraining": true,
              "showIf": "<string>"
            }
          ],
          "options": [
            {
              "name": "<string>",
              "type": "<string>",
              "groupOptions": "<array>",
              "properties": {},
              "tabName": "<string>",
              "aliases": [
                "<string>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "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": [
                {
                  "label": "<string>",
                  "value": {},
                  "description": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "defaultSchedules": [
        {
          "type": "<string>",
          "cronExpression": "<string>",
          "lastEvent": "2023-11-07T05:31:56Z",
          "nextEvent": "2023-11-07T05:31:56Z"
        }
      ],
      "subscription": "<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
}

GET

api

organizations

{id}

availableAssistants

cURL

curl --request GET \
  --url http://localhost/api/organizations/{id}/availableAssistants

{
  "totalPages": 123,
  "totalElements": 123,
  "size": 123,
  "content": [
    {
      "orgSlug": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "name": "<string>",
      "version": "<string>",
      "ref": "<string>",
      "template": true,
      "description": "<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>",
      "schedulable": true,
      "reactive": true,
      "assistant": {
        "package": "<string>",
        "class": "<string>"
      },
      "services": [
        {
          "orgSlug": "<string>",
          "slug": "<string>",
          "type": "<string>",
          "name": "<string>",
          "version": "<string>",
          "ref": "<string>",
          "template": true,
          "description": "<string>",
          "get_id": "<string>",
          "publicAccess": true,
          "imageUrl": "<string>",
          "icon": "<string>",
          "overviewMarkdown": "<string>",
          "provider": "<string>",
          "providerUrl": "<string>",
          "providerImageUrl": "<string>",
          "deleteProtection": true,
          "checksum": "<string>",
          "deprecated": true
        }
      ],
      "processingTaxonomies": [
        {
          "ref": "<string>"
        }
      ],
      "options": [
        {
          "name": "<string>",
          "type": "<string>",
          "groupOptions": "<array>",
          "properties": {},
          "tabName": "<string>",
          "aliases": [
            "<string>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "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": [
            {
              "label": "<string>",
              "value": {},
              "description": "<string>"
            }
          ]
        }
      ],
      "optionTabs": [
        {
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "optionNames": [
            "<string>"
          ],
          "showInTraining": true,
          "showIf": "<string>"
        }
      ],
      "additionalTaxonOptions": [
        {
          "name": "<string>",
          "type": "<string>",
          "groupOptions": "<array>",
          "properties": {},
          "tabName": "<string>",
          "aliases": [
            "<string>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "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": [
            {
              "label": "<string>",
              "value": {},
              "description": "<string>"
            }
          ]
        }
      ],
      "taxonFeatures": [
        {
          "taxonPath": "<string>",
          "groupOnly": true,
          "options": [
            {
              "name": "<string>",
              "type": "<string>",
              "groupOptions": "<array>",
              "properties": {},
              "tabName": "<string>",
              "aliases": [
                "<string>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "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": [
                {
                  "label": "<string>",
                  "value": {},
                  "description": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "eventTypes": [
        {
          "name": "<string>",
          "icon": "<string>",
          "label": "<string>",
          "description": "<string>",
          "contentObject": true,
          "entryPoints": [
            "<string>"
          ],
          "optionTabs": [
            {
              "name": "<string>",
              "description": "<string>",
              "icon": "<string>",
              "optionNames": [
                "<string>"
              ],
              "showInTraining": true,
              "showIf": "<string>"
            }
          ],
          "options": [
            {
              "name": "<string>",
              "type": "<string>",
              "groupOptions": "<array>",
              "properties": {},
              "tabName": "<string>",
              "aliases": [
                "<string>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "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": [
                {
                  "label": "<string>",
                  "value": {},
                  "description": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "defaultSchedules": [
        {
          "type": "<string>",
          "cronExpression": "<string>",
          "lastEvent": "2023-11-07T05:31:56Z",
          "nextEvent": "2023-11-07T05:31:56Z"
        }
      ],
      "subscription": "<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

string

required

Query Parameters

includePublic

boolean

default:true

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

totalPages

integer<int32>

totalElements

integer<int64>

size

integer<int32>

content

object[]

Show child attributes

content.orgSlug

string

required

The slug of the organization that owns this metadata object

content.slug

string

required

The slug used when referencing this metadata object

content.type

string

required

The type of metadata object

content.name

string

required

The name of the object

content.version

string

required

The version of the object

content.ref

string

The reference to the metadata object

content.template

boolean

Is this component a template that can be used to create new components

content.description

string

The description of the object

content.get_id

string

An internal identifier (not for public use)

content.publicAccess

boolean

Is the metadata object publicly accessible by other organizations

content.imageUrl

string

URL of image when presenting this object in a UI

content.icon

string

Material Icon name to use in the UI

content.overviewMarkdown

string

Markdown that is used to present the overview of the object

content.provider

string

The details of the of provider

content.providerUrl

string

The link to the provider website

content.providerImageUrl

string

The link to the model image

content.deleteProtection

boolean

Delete protection status

content.checksum

string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

content.deprecated

boolean

The resource is marked for deprecation

content.extensionPackRef

string

The reference to the extension pack (if the metadata object was created by an extension pack)

content.schedulable

boolean

The assistant can be scheduled

content.reactive

boolean

deprecated

The assistant is reactive to content changes

content.assistant

object

The implementation of the assistant

Show child attributes

content.assistant.package

string

required

content.assistant.class

string

required

content.services

object[]

Services used by the assistant

Show child attributes

content.services.orgSlug

string

required

The slug of the organization that owns this metadata object

content.services.slug

string

required

The slug used when referencing this metadata object

content.services.type

string

required

The type of metadata object

content.services.name

string

required

The name of the object

content.services.version

string

required

The version of the object

content.services.ref

string

The reference to the metadata object

content.services.template

boolean

Is this component a template that can be used to create new components

content.services.description

string

The description of the object

content.services.get_id

string

An internal identifier (not for public use)

content.services.publicAccess

boolean

Is the metadata object publicly accessible by other organizations

content.services.imageUrl

string

URL of image when presenting this object in a UI

content.services.icon

string

Material Icon name to use in the UI

content.services.overviewMarkdown

string

Markdown that is used to present the overview of the object

content.services.provider

string

The details of the of provider

content.services.providerUrl

string

The link to the provider website

content.services.providerImageUrl

string

The link to the model image

content.services.deleteProtection

boolean

Delete protection status

content.services.checksum

string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

content.services.deprecated

boolean

The resource is marked for deprecation

content.processingTaxonomies

object[]

Taxonomies that the assistant uses

Show child attributes

content.processingTaxonomies.ref

string

content.options

object[]

Options for the assistant

Show child attributes

content.options.name

string

required

content.options.type

string

required

content.options.groupOptions

array

content.options.properties

object

Properties that are used for display purposes

Show child attributes

content.options.properties.{key}

object

Properties that are used for display purposes

content.options.tabName

string

content.options.aliases

string[]

content.options.label

string

content.options.falseLabel

string

content.options.hint

string

content.options.required

boolean

content.options.subType

string

content.options.listType

string

content.options.displayProperties

object

Show child attributes

content.options.displayProperties.{key}

object

content.options.listLabel

string

content.options.listDescription

string

content.options.featureFlag

string

content.options.default

object

content.options.description

string

content.options.supportArticle

string

content.options.overviewMarkdown

string

content.options.showIf

string

content.options.developerOnly

boolean

content.options.possibleValues

object[]

Show child attributes

content.options.possibleValues.label

string

content.options.possibleValues.value

object

content.options.possibleValues.description

string

content.optionTabs

object[]

Definition of how the options will be grouped onto tabs

Show child attributes

content.optionTabs.name

string

content.optionTabs.description

string

content.optionTabs.icon

string

content.optionTabs.optionNames

string[]

content.optionTabs.showInTraining

boolean

content.optionTabs.showIf

string

content.additionalTaxonOptions

object[]

This are additional properties that can be set on a label when the assistant is part of the project

Show child attributes

content.additionalTaxonOptions.name

string

required

content.additionalTaxonOptions.type

string

required

content.additionalTaxonOptions.groupOptions

array

content.additionalTaxonOptions.properties

object

Properties that are used for display purposes

Show child attributes

content.additionalTaxonOptions.properties.{key}

object

Properties that are used for display purposes

content.additionalTaxonOptions.tabName

string

content.additionalTaxonOptions.aliases

string[]

content.additionalTaxonOptions.label

string

content.additionalTaxonOptions.falseLabel

string

content.additionalTaxonOptions.hint

string

content.additionalTaxonOptions.required

boolean

content.additionalTaxonOptions.subType

string

content.additionalTaxonOptions.listType

string

content.additionalTaxonOptions.displayProperties

object

Show child attributes

content.additionalTaxonOptions.displayProperties.{key}

object

content.additionalTaxonOptions.listLabel

string

content.additionalTaxonOptions.listDescription

string

content.additionalTaxonOptions.featureFlag

string

content.additionalTaxonOptions.default

object

content.additionalTaxonOptions.description

string

content.additionalTaxonOptions.supportArticle

string

content.additionalTaxonOptions.overviewMarkdown

string

content.additionalTaxonOptions.showIf

string

content.additionalTaxonOptions.developerOnly

boolean

content.additionalTaxonOptions.possibleValues

object[]

Show child attributes

content.additionalTaxonOptions.possibleValues.label

string

content.additionalTaxonOptions.possibleValues.value

object

content.additionalTaxonOptions.possibleValues.description

string

content.taxonFeatures

object[]

This are additional properties that can be set as part of the taxon in the taxonomy (not a label but at the taxon level) they will be stored under the type_features

Show child attributes

content.taxonFeatures.taxonPath

string

content.taxonFeatures.groupOnly

boolean

content.taxonFeatures.options

object[]

Show child attributes

content.taxonFeatures.options.name

string

required

content.taxonFeatures.options.type

string

required

content.taxonFeatures.options.groupOptions

array

content.taxonFeatures.options.properties

object

Properties that are used for display purposes

Show child attributes

content.taxonFeatures.options.properties.{key}

object

Properties that are used for display purposes

content.taxonFeatures.options.tabName

string

content.taxonFeatures.options.aliases

string[]

content.taxonFeatures.options.label

string

content.taxonFeatures.options.falseLabel

string

content.taxonFeatures.options.hint

string

content.taxonFeatures.options.required

boolean

content.taxonFeatures.options.subType

string

content.taxonFeatures.options.listType

string

content.taxonFeatures.options.displayProperties

object

Show child attributes

content.taxonFeatures.options.displayProperties.{key}

object

content.taxonFeatures.options.listLabel

string

content.taxonFeatures.options.listDescription

string

content.taxonFeatures.options.featureFlag

string

content.taxonFeatures.options.default

object

content.taxonFeatures.options.description

string

content.taxonFeatures.options.supportArticle

string

content.taxonFeatures.options.overviewMarkdown

string

content.taxonFeatures.options.showIf

string

content.taxonFeatures.options.developerOnly

boolean

content.taxonFeatures.options.possibleValues

object[]

Show child attributes

content.taxonFeatures.options.possibleValues.label

string

content.taxonFeatures.options.possibleValues.value

object

content.taxonFeatures.options.possibleValues.description

string

content.eventTypes

object[]

Custom event types that the assistant is able to response to

Show child attributes

content.eventTypes.name

string

The name of the event

content.eventTypes.icon

string

The name of a Material Design Icon to use for the event

content.eventTypes.label

string

The label to use on the event in the UI

content.eventTypes.description

string

The long description for the event

content.eventTypes.contentObject

boolean

Does the event require a content object

content.eventTypes.entryPoints

string[]

Entrypoints should we show this event (test, assistantBar, documentFamily)

content.eventTypes.optionTabs

object[]

Definition of how the options will be grouped onto tabs

Show child attributes

content.eventTypes.optionTabs.name

string

content.eventTypes.optionTabs.description

string

content.eventTypes.optionTabs.icon

string

content.eventTypes.optionTabs.optionNames

string[]

content.eventTypes.optionTabs.showInTraining

boolean

content.eventTypes.optionTabs.showIf

string

content.eventTypes.options

object[]

Options available for this event

Show child attributes

content.eventTypes.options.name

string

required

content.eventTypes.options.type

string

required

content.eventTypes.options.groupOptions

array

content.eventTypes.options.properties

object

Properties that are used for display purposes

Show child attributes

content.eventTypes.options.properties.{key}

object

Properties that are used for display purposes

content.eventTypes.options.tabName

string

content.eventTypes.options.aliases

string[]

content.eventTypes.options.label

string

content.eventTypes.options.falseLabel

string

content.eventTypes.options.hint

string

content.eventTypes.options.required

boolean

content.eventTypes.options.subType

string

content.eventTypes.options.listType

string

content.eventTypes.options.displayProperties

object

Show child attributes

content.eventTypes.options.displayProperties.{key}

object

content.eventTypes.options.listLabel

string

content.eventTypes.options.listDescription

string

content.eventTypes.options.featureFlag

string

content.eventTypes.options.default

object

content.eventTypes.options.description

string

content.eventTypes.options.supportArticle

string

content.eventTypes.options.overviewMarkdown

string

content.eventTypes.options.showIf

string

content.eventTypes.options.developerOnly

boolean

content.eventTypes.options.possibleValues

object[]

Show child attributes

content.eventTypes.options.possibleValues.label

string

content.eventTypes.options.possibleValues.value

object

content.eventTypes.options.possibleValues.description

string

content.defaultSchedules

object[]

The default schedules that the assistant has

Show child attributes

content.defaultSchedules.type

string

content.defaultSchedules.cronExpression

string

content.defaultSchedules.lastEvent

string<date-time>

content.defaultSchedules.nextEvent

string<date-time>

content.subscription

string

The subscription that the assistant has, this can not be overridden by the subscription in the instance

number

integer<int32>

sort

object[]

Show child attributes

sort.direction

string

sort.nullHandling

string

sort.ascending

boolean

sort.property

string

sort.ignoreCase

boolean

first

boolean

numberOfElements

integer<int32>

pageable

object

Show child attributes

pageable.offset

integer<int64>

pageable.sort

object[]

Show child attributes

pageable.sort.direction

string

pageable.sort.nullHandling

string

pageable.sort.ascending

boolean

pageable.sort.property

string

pageable.sort.ignoreCase

boolean

pageable.paged

boolean

pageable.unpaged

boolean

pageable.pageNumber

integer<int32>

pageable.pageSize

integer<int32>

last

boolean

empty

boolean

Get the available model for the organization Cancel the specific execution

⌘I

Introduction

Tasks

Projects

Assistants

DocumentFamilies

Taxonomies

Stores

Organizations

Executions

Data Forms

Account & User

Get the available model for the organization

Path Parameters

Query Parameters

Response