---
updatedAt: 2026-07-28T13:50:54.000Z
---
# (Beta) Get application domains and their entities for export
Get application domains and their entities and export them as a JSON file that can be used to create new application domains in other Solace Cloud. This API is intended for providing application domain data to other accounts and not for data storage or backup. Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ application_domain:export:* ]
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Event Portal - Designer",
"description": "REST API Concepts\n\nSolace Event Portal provides REST APIs that you can use to manage your data in Solace Cloud. \nThe REST APIs allow you to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use in Event Portal 2.0. Objects created in this \nversion will not be available in Event Portal 1.0. APIs that display (Beta) in their summary are provided as-is and \nare subject to change or removal. They may not be of the quality expected for generally available APIs and have no \nguaranteed forward compatibility with the generally available version of the API.\n\n",
"version": "2.13.2"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace PubSub+ Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace PubSub+ Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace PubSub+ Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace PubSub+ Cloud SG Region"
}
],
"security": [
{
"APIToken": []
}
],
"tags": [
{
"name": "Application Domains"
}
],
"paths": {
"/api/v2/architecture/applicationDomains/export/{ids}": {
"get": {
"tags": [
"Application Domains"
],
"summary": "(Beta) Get application domains and their entities for export",
"description": "Get application domains and their entities and export them as a JSON file that can be used to create new application domains in other Solace Cloud. This API is intended for providing application domain data to other accounts and not for data storage or backup. Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ application_domain:export:* ]",
"operationId": "exportApplicationDomains",
"parameters": [
{
"name": "ids",
"in": "path",
"description": "The IDs of the application domains to export ",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
],
"responses": {
"200": {
"description": "Export file containing the application domains and accompanying entities",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApplicationDomainExportDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"501": {
"description": "Not Implemented",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Address": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"addressLevels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLevel"
}
},
"addressType": {
"type": "string",
"enum": [
"topic"
]
},
"type": {
"type": "string"
}
},
"required": [
"addressLevels"
]
},
"AddressLevel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "root"
},
"addressLevelType": {
"type": "string",
"enum": [
"literal",
"variable"
]
},
"enumVersionId": {
"type": "string"
}
},
"required": [
"addressLevelType",
"name"
]
},
"AddressSpace": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": 123456,
"readOnly": true
},
"brokerType": {
"type": "string",
"example": "kafka"
},
"delimiter": {
"type": "string",
"example": "_"
},
"type": {
"type": "string",
"readOnly": true
}
}
},
"Application": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"name": {
"type": "string",
"example": "My First Application",
"maxLength": 255,
"minLength": 1
},
"applicationType": {
"type": "string",
"example": "standard",
"maxLength": 255,
"minLength": 1
},
"brokerType": {
"type": "string",
"enum": [
"kafka",
"solace"
],
"example": "solace",
"maxLength": 255,
"minLength": 1
},
"applicationDomainId": {
"type": "string",
"example": "acb2j5k3mly"
},
"numberOfVersions": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"type": {
"type": "string"
}
},
"required": [
"applicationDomainId",
"applicationType",
"brokerType",
"name"
]
},
"ApplicationDomain": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": 12345678,
"readOnly": true
},
"name": {
"type": "string",
"example": "My First Application Domain",
"maxLength": 255,
"minLength": 1
},
"description": {
"type": "string",
"example": "Application Domain created by the Solace Cloud API documentation",
"maxLength": 10000
},
"uniqueTopicAddressEnforcementEnabled": {
"type": "boolean",
"description": "Forces all topic addresses within the application domain to be unique.",
"example": false
},
"topicDomainEnforcementEnabled": {
"type": "boolean",
"description": "Forces all topic addresses within the application domain to be prefixed with one of the application domain's configured topic domains.",
"example": false
},
"deletionProtected": {
"type": "boolean",
"description": "If set to true, application domain cannot be deleted until deletion protected is disabled.",
"example": false
},
"nonDraftDescriptionsEditable": {
"type": "boolean",
"description": "If set to true, descriptions of entities in a non-draft state can be edited.",
"example": false
},
"stats": {
"$ref": "#/components/schemas/ApplicationDomainStats",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"type": {
"type": "string"
}
},
"required": [
"name"
]
},
"ApplicationDomainExportDTO": {
"type": "object",
"properties": {
"formatVersion": {
"type": "string"
},
"applicationDomains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationDomain"
}
},
"topicDomains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicDomain"
}
},
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
},
"applicationVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationVersion"
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
},
"eventVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventVersion"
}
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaObject"
}
},
"schemaVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaVersion"
}
},
"enums": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicAddressEnum"
}
},
"enumVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicAddressEnumVersion"
}
},
"eventApis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApi"
}
},
"eventApiVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApiVersion"
}
},
"eventApiProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApiProduct"
}
},
"eventApiProductVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApiProductVersion"
}
},
"addressSpaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressSpace"
}
},
"customAttributeDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDefinition"
}
}
}
},
"ApplicationDomainStats": {
"type": "object",
"properties": {
"schemaCount": {
"type": "integer",
"format": "int32"
},
"eventCount": {
"type": "integer",
"format": "int32"
},
"applicationCount": {
"type": "integer",
"format": "int32"
},
"enumCount": {
"type": "integer",
"format": "int32"
},
"eventApiCount": {
"type": "integer",
"format": "int32"
},
"eventApiProductCount": {
"type": "integer",
"format": "int32"
}
}
},
"ApplicationVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"applicationId": {
"type": "string",
"example": "acb2j5k3mly"
},
"description": {
"type": "string",
"example": "Application created by Solace Cloud documentation",
"maxLength": 10000
},
"version": {
"type": "string",
"example": "1.0.0"
},
"displayName": {
"type": "string",
"example": "Display name for the version",
"maxLength": 40
},
"declaredProducedEventVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
]
}
},
"declaredConsumedEventVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
]
}
},
"declaredEventApiProductVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
]
}
},
"stateId": {
"type": "string",
"example": 1,
"readOnly": true
},
"consumers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consumer"
},
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"messagingServiceIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"validationMessages": {
"$ref": "#/components/schemas/ValidationMessagesDTO"
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z"
},
"inboundApplicationVersionAssociations": {
"type": "array",
"description": "The application versions that reference this application version. targetId can be left blank",
"items": {
"$ref": "#/components/schemas/ApplicationVersionToApplicationVersionAssocation"
}
},
"outboundApplicationVersionAssociations": {
"type": "array",
"description": "The application versions that reference this application version. sourceId can be left blank",
"items": {
"$ref": "#/components/schemas/ApplicationVersionToApplicationVersionAssocation"
}
},
"transformations": {
"type": "object",
"additionalProperties": {},
"description": "Transformation mappings for this micro integration flow application version."
},
"type": {
"type": "string"
}
},
"required": [
"applicationId",
"version"
]
},
"ApplicationVersionToApplicationVersionAssocation": {
"type": "object",
"properties": {
"sourceId": {
"type": "string"
},
"destinationId": {
"type": "string"
}
}
},
"AssociatedEntity": {
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"applicationDomainIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AttractedEventVersionTuple": {
"type": "object",
"properties": {
"eventVersionId": {
"type": "string"
},
"eventMeshIds": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
},
"AttractingApplicationVersionTuple": {
"type": "object",
"properties": {
"applicationVersionId": {
"type": "string"
},
"eventMeshIds": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
},
"Consumer": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"name": {
"type": "string",
"example": "My First Consumer",
"maxLength": 255,
"minLength": 1
},
"applicationVersionId": {
"type": "string",
"example": "acb2j5k3mly"
},
"brokerType": {
"type": "string",
"example": "solace"
},
"consumerType": {
"type": "string",
"example": "eventQueue"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
},
"type": {
"type": "string"
}
},
"required": [
"applicationVersionId"
]
},
"CustomAttribute": {
"type": "object",
"properties": {
"customAttributeDefinitionId": {
"type": "string",
"example": "acb2j5k3mly"
},
"customAttributeDefinitionName": {
"type": "string",
"example": "color",
"pattern": "a-zA-Z0-9_\\-\\."
},
"value": {
"type": "string",
"example": "red",
"pattern": "a-zA-Z0-9_\\-\\."
},
"stringValues": {
"type": "string",
"example": "red",
"pattern": "a-zA-Z0-9_\\-\\."
}
}
},
"CustomAttributeDefinition": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string"
},
"name": {
"type": "string",
"example": "colour",
"pattern": "[a-zA-Z0-9\\._-]+"
},
"valueType": {
"type": "string",
"enum": [
"STRING",
"LONG_TEXT",
"MULTI_STRING_VALUE"
]
},
"scope": {
"type": "string",
"enum": [
"organization",
"applicationDomain"
]
},
"associatedEntityTypes": {
"type": "array",
"items": {
"type": "string",
"example": [
"event",
"application"
]
}
},
"associatedEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociatedEntity"
}
},
"validationMessages": {
"$ref": "#/components/schemas/ValidationMessagesDTO"
},
"applicationDomainId": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"scope"
]
},
"DeliveryDescriptor": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"brokerType": {
"type": "string"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"keySchemaVersionId": {
"type": "string",
"example": "shb3mlyec2g"
},
"keySchemaPrimitiveType": {
"type": "string",
"enum": [
"BOOLEAN",
"BYTES",
"DOUBLE",
"FLOAT",
"INT",
"LONG",
"NULL",
"NUMBER",
"STRING"
],
"example": "BYTES"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"ErrorResponse": {
"type": "object",
"discriminator": {
"propertyName": "errorType"
},
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {},
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
},
"errorType": {
"type": "string",
"writeOnly": true
}
}
},
"Event": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"name": {
"type": "string",
"example": "My First Event",
"maxLength": 2048,
"minLength": 1
},
"shared": {
"type": "boolean",
"example": false
},
"applicationDomainId": {
"type": "string",
"example": "acb2j5k3mly"
},
"brokerType": {
"type": "string",
"example": "kafka",
"readOnly": true
},
"numberOfVersions": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"requiresApproval": {
"type": "boolean",
"example": false
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"applicationDomainId",
"name"
]
},
"EventApi": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"description": "Primary key set by the server.",
"example": 12345,
"readOnly": true
},
"name": {
"type": "string",
"description": "The name of the event api.",
"example": "Apitest",
"maxLength": 60,
"minLength": 1
},
"shared": {
"type": "boolean",
"example": true
},
"applicationDomainId": {
"type": "string",
"example": "acb2j5k3mly"
},
"numberOfVersions": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"brokerType": {
"type": "string",
"default": "solace",
"description": "The type of the broker used for the event API",
"enum": [
"kafka",
"solace"
]
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"type": {
"type": "string",
"description": "The type of this payload, eventApi.",
"readOnly": true
}
}
},
"EventApiProduct": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"description": "Primary key set by the server",
"example": 12345,
"readOnly": true
},
"name": {
"type": "string",
"description": "The name of the event API product",
"example": "EventApiProductTest",
"maxLength": 60,
"minLength": 1
},
"applicationDomainId": {
"type": "string",
"example": "abcappdomainid"
},
"shared": {
"type": "boolean",
"example": true
},
"numberOfVersions": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"brokerType": {
"type": "string",
"default": "solace",
"description": "The type of the broker used for the event API product",
"enum": [
"kafka",
"solace"
]
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"type": {
"type": "string",
"description": "The type of payload",
"readOnly": true
}
}
},
"EventApiProductRegistration": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"applicationDomainId": {
"type": "string",
"example": 12345678
},
"registrationId": {
"type": "string",
"example": 12345678
},
"accessRequestId": {
"type": "string",
"example": 12345678
},
"eventApiProductVersionId": {
"type": "string",
"example": 12345678
},
"planId": {
"type": "string",
"example": 12345678
},
"state": {
"type": "string",
"enum": [
"Pending Approval",
"Rejected",
"Revoked",
"Approved",
"Error",
"Live"
]
},
"type": {
"type": "string",
"default": "eventApiProductRegistration",
"description": "The type of payload",
"readOnly": true
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"accessRequestId",
"applicationDomainId",
"eventApiProductVersionId",
"planId",
"registrationId"
]
},
"EventApiProductVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"eventApiProductId": {
"type": "string",
"example": "acb2j5k3mly"
},
"description": {
"type": "string",
"example": "Event API product created by Solace Cloud documentation",
"maxLength": 10000
},
"version": {
"type": "string",
"example": "1.0.0"
},
"summary": {
"type": "string",
"example": "Summary string value of event API product version"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"displayName": {
"type": "string",
"example": "Event API product version display name",
"maxLength": 40
},
"eventApiVersionIds": {
"type": "array",
"description": "List of IDs of associated event API versions",
"items": {
"type": "string"
}
},
"stateId": {
"type": "string",
"example": 1
},
"eventApiProductRegistrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApiProductRegistration"
}
},
"plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plan"
}
},
"solaceMessagingServices": {
"type": "array",
"description": "Solace Messaging Services",
"items": {
"$ref": "#/components/schemas/SolaceMessagingService"
}
},
"filters": {
"type": "array",
"description": "List of filters that contains eventVersionId name and variables",
"items": {
"$ref": "#/components/schemas/Filter"
}
},
"approvalType": {
"type": "string",
"default": "automatic",
"description": "Approval type",
"enum": [
"automatic",
"manual"
]
},
"publishState": {
"type": "string",
"default": "unset",
"description": "Publish state",
"enum": [
"unset",
"published"
]
},
"publishedTime": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z"
},
"type": {
"type": "string",
"description": "The type of payload",
"readOnly": true
}
},
"required": [
"eventApiProductId"
]
},
"EventApiVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"eventApiId": {
"type": "string",
"example": "acb2j5k3mly"
},
"description": {
"type": "string",
"example": "Event API created by Solace Cloud documentation",
"maxLength": 10000
},
"version": {
"type": "string",
"example": "1.0.0"
},
"displayName": {
"type": "string",
"example": "Display name for the eventApi version",
"maxLength": 40
},
"producedEventVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
]
}
},
"consumedEventVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
]
}
},
"declaredEventApiProductVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
]
}
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"stateId": {
"type": "string",
"example": 1
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"type": {
"type": "string"
}
},
"required": [
"eventApiId"
]
},
"EventVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"eventId": {
"type": "string",
"example": "acb2j5k3mly"
},
"description": {
"type": "string",
"example": "Event version created by Solace Cloud documentation",
"maxLength": 10000
},
"version": {
"type": "string",
"example": "1.0.0"
},
"displayName": {
"type": "string",
"example": "Display name for the version",
"maxLength": 40,
"minLength": 0
},
"declaredProducingApplicationVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"declaredConsumingApplicationVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"producingEventApiVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"consumingEventApiVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"attractingApplicationVersionIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttractingApplicationVersionTuple"
},
"readOnly": true
},
"schemaVersionId": {
"type": "string",
"example": "shb3mlyec2g"
},
"schemaPrimitiveType": {
"type": "string",
"enum": [
"BOOLEAN",
"BYTES",
"DOUBLE",
"FLOAT",
"INT",
"LONG",
"NULL",
"NUMBER",
"STRING"
],
"example": "BYTES"
},
"deliveryDescriptor": {
"$ref": "#/components/schemas/DeliveryDescriptor"
},
"stateId": {
"type": "string",
"example": 1,
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"messagingServiceIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"validationMessages": {
"$ref": "#/components/schemas/ValidationMessagesDTO"
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z"
},
"type": {
"type": "string"
}
},
"required": [
"eventId",
"version"
]
},
"Filter": {
"type": "object",
"properties": {
"eventVersionId": {
"type": "string",
"example": 123456
},
"topicFilters": {
"type": "array",
"description": "List of variable that contains address node name and filters",
"items": {
"$ref": "#/components/schemas/TopicFilter"
}
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"default": "filter",
"description": "The type of payload",
"readOnly": true
}
}
},
"InvalidNonStateReference": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"entityType": {
"type": "string"
}
}
},
"InvalidStateReference": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
},
{
"type": "object",
"properties": {
"targetStateId": {
"type": "string"
},
"inboundInvalidNonStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidNonStateReference"
}
},
"inboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"outboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"errorType": {
"type": "string"
}
}
}
]
},
"Plan": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID value of the object",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "Title of the object",
"example": "Gold"
},
"solaceClassOfServicePolicy": {
"$ref": "#/components/schemas/SolaceClassOfServicePolicy",
"description": "Solace class of service policy"
},
"type": {
"type": "string",
"default": "plan",
"description": "The type of this payload",
"readOnly": true
}
}
},
"SchemaObject": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": 12345678,
"readOnly": true
},
"applicationDomainId": {
"type": "string",
"example": 12345678
},
"name": {
"type": "string",
"example": "My First Schema",
"maxLength": 2048
},
"shared": {
"type": "boolean",
"example": false
},
"schemaType": {
"type": "string",
"example": "jsonSchema",
"maxLength": 255,
"minLength": 0
},
"numberOfVersions": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"eventVersionRefCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"applicationDomainId",
"name",
"schemaType"
]
},
"SchemaVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": 12345678,
"readOnly": true
},
"schemaId": {
"type": "string",
"example": 12345678
},
"description": {
"type": "string",
"example": "Schema created by Solace Cloud API documentation",
"maxLength": 10000,
"minLength": 0
},
"version": {
"type": "string",
"example": "1.0.0",
"pattern": "^\\d+\\.\\d+\\.\\d+$"
},
"displayName": {
"type": "string",
"example": "Display name for the version",
"maxLength": 40,
"minLength": 0
},
"content": {
"type": "string",
"example": "{ \"$schema\": \"http://json-schema.org/draft-07/schema#\", \"$id\": \"http://example.com/root.json\",\"type\": \"object\", \"title\": \"An example schema\", \"required\": [ \"attribute\", ], \"properties\": { \"attribute\": { \"$id\": \"#/properties/attribute\", \"type\": \"string\", \"title\": \"An example of a string based attribute\", \"examples\": [ \"aValue\" ], \"pattern\": \"^(.*)$\" } }}"
},
"referencedByEventVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"referencedBySchemaVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"schemaVersionReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaVersionReferenceDTO"
}
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"stateId": {
"type": "string",
"example": 1,
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z"
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"schemaId",
"version"
]
},
"SchemaVersionReferenceDTO": {
"type": "object",
"properties": {
"schemaVersionId": {
"type": "string"
}
}
},
"SolaceClassOfServicePolicy": {
"type": "object",
"properties": {
"messageDeliveryMode": {
"type": "string",
"default": "direct",
"description": "The mode that will be used for message delivery (ex: `guaranteed` uses a queue)",
"enum": [
"direct",
"guaranteed"
]
},
"accessType": {
"type": "string",
"enum": [
"exclusive",
"non-exclusive"
]
},
"maximumTimeToLive": {
"type": "integer",
"format": "int32",
"description": "Duration in seconds of how long a message can live in a queue",
"example": 1500
},
"queueType": {
"type": "string",
"default": "combined",
"description": "The arrangement of queues on a broker used for message delivery (ex: `single` uses one queue per event API version in this event API product)",
"enum": [
"single",
"combined"
]
},
"maxMsgSpoolUsage": {
"type": "integer",
"format": "int32",
"description": "Total number of MBs available for the queue to use",
"example": 5
},
"id": {
"type": "string",
"description": "ID value of the object",
"example": 123456,
"readOnly": true
},
"type": {
"type": "string",
"default": "solaceClassOfServicePolicy",
"description": "The type of payload",
"readOnly": true
}
}
},
"SolaceMessagingService": {
"type": "object",
"properties": {
"solaceCloudMessagingServiceId": {
"type": "string",
"example": "service123"
},
"id": {
"type": "string",
"description": "ID value of the object",
"example": 123456,
"readOnly": true
},
"messagingServiceId": {
"type": "string",
"description": "ID of the Event Portal messaging service",
"example": 456789,
"readOnly": true
},
"messagingServiceName": {
"type": "string",
"description": "Name of the Event Portal messaging service",
"example": "Messaging Service",
"readOnly": true
},
"supportedProtocols": {
"type": "array",
"description": "Values for allowed supported protocols",
"items": {
"type": "string"
}
},
"environmentId": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"environmentName": {
"type": "string",
"deprecated": true,
"description": "*Deprecation Date: 2025-01-17
Removal Date: 2026-01-17
Reason: Environment name should be fetched from Platform APIs.*
",
"example": "Production",
"readOnly": true
},
"eventMeshId": {
"type": "string",
"example": "xyz23mwec2y",
"readOnly": true
},
"eventMeshName": {
"type": "string",
"example": "US East Mesh",
"readOnly": true
},
"type": {
"type": "string",
"default": "solaceManagedMessagingService",
"description": "The type of payload",
"readOnly": true
}
}
},
"Subscription": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"subscriptionType": {
"type": "string",
"example": "topic"
},
"value": {
"type": "string",
"example": "solace/cloud"
},
"attractedEventVersionIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttractedEventVersionTuple"
},
"readOnly": true
}
}
},
"TopicAddressEnum": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"applicationDomainId": {
"type": "string",
"example": 12345678
},
"name": {
"type": "string",
"example": "My First Enum",
"maxLength": 60
},
"shared": {
"type": "boolean",
"example": false
},
"numberOfVersions": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"eventVersionRefCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"applicationDomainId",
"name"
]
},
"TopicAddressEnumValue": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"enumVersionId": {
"type": "string",
"example": "xyz23mwec2g"
},
"value": {
"type": "string",
"example": "Ontario",
"maxLength": 255
},
"label": {
"type": "string",
"example": "Display name for the value",
"maxLength": 40,
"minLength": 0
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"value"
]
},
"TopicAddressEnumVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"enumId": {
"type": "string",
"example": "xyz23mwec2g"
},
"description": {
"type": "string",
"example": "Enum created by Solace Cloud API documentation",
"maxLength": 10000,
"minLength": 0
},
"version": {
"type": "string",
"example": "1.0.0"
},
"displayName": {
"type": "string",
"example": "Display name for the version",
"maxLength": 40,
"minLength": 0
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicAddressEnumValue"
}
},
"referencedByEventVersionIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"referencedByTopicDomainIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"5h2km5khkj",
"h5mk26hkm2"
],
"readOnly": true
}
},
"stateId": {
"type": "string",
"example": 1,
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z"
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"enumId",
"values",
"version"
]
},
"TopicDomain": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "vck3mzyb2j5",
"readOnly": true
},
"applicationDomainId": {
"type": "string",
"example": "acb2j5k3mly"
},
"brokerType": {
"type": "string",
"example": "solace"
},
"addressLevels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressLevel"
}
},
"type": {
"type": "string",
"example": "topicDomain",
"readOnly": true
}
},
"required": [
"addressLevels",
"applicationDomainId",
"brokerType"
]
},
"TopicFilter": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"name": {
"type": "string",
"description": "name of address node",
"example": "name"
},
"filterValue": {
"type": "string",
"description": "Different filter values separated by comma",
"example": " Tes?, TEST*FILTER, SAmPle"
},
"eventVersionIds": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"type": {
"type": "string",
"default": "topicFilter",
"description": "The type of payload",
"readOnly": true
}
},
"required": [
"eventVersionIds"
]
},
"ValidationMessageContext": {
"type": "object",
"properties": {
"entityNames": {
"type": "array",
"items": {
"type": "string"
}
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"entityType": {
"type": "string"
}
}
},
"ValidationMessageDTO": {
"type": "object",
"properties": {
"messageKey": {
"type": "string"
},
"message": {
"type": "string"
},
"context": {
"$ref": "#/components/schemas/ValidationMessageContext"
}
}
},
"ValidationMessagesDTO": {
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationMessageDTO"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationMessageDTO"
}
}
}
}
},
"securitySchemes": {
"APIToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```