{
"openapi" : "3.1.0",
"info" : {
"title" : "Event Portal",
"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 Cloud"
} ],
"security" : [ {
"APIToken" : [ ]
} ],
"tags" : [ {
"name" : "Application Configuration Push Job"
}, {
"name" : "Application Deployments"
}, {
"name" : "Application Domain Operations"
}, {
"name" : "Application Domains"
}, {
"name" : "Application Promotion Requests"
}, {
"name" : "Application Version Event Access Requests"
}, {
"name" : "Applications"
}, {
"name" : "Audit Results"
}, {
"name" : "Configuration Templates"
}, {
"name" : "Configuration Types"
}, {
"name" : "Consumers"
}, {
"name" : "Custom Attribute Definitions"
}, {
"name" : "Designer Configurations"
}, {
"name" : "Enums"
}, {
"name" : "Environments"
}, {
"name" : "Event API Products"
}, {
"name" : "Event APIs"
}, {
"name" : "Event Access Requests"
}, {
"name" : "Event Access Reviews"
}, {
"name" : "Event Management Agents"
}, {
"name" : "Event Meshes"
}, {
"name" : "Event Portal Usage Stats"
}, {
"name" : "Events"
}, {
"name" : "Messaging Service Scan Data"
}, {
"name" : "Messaging Service Scan Logs"
}, {
"name" : "Messaging Service Scans"
}, {
"name" : "Messaging Services"
}, {
"name" : "Modeled Event Broker"
}, {
"name" : "Schemas"
}, {
"name" : "States"
}, {
"name" : "Topic Domains"
} ],
"paths" : {
"/api/v2/architecture/enums" : {
"get" : {
"tags" : [ "Enums" ],
"summary" : "Get a list of enumerations",
"description" : "Use this API to get a list of enumerations based on certain criteria.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEnums",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of enumerations to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The IDs of the enumerations.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"description" : "The application domain ID of the enumerations.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only enumerations in the given application domain ids.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "names",
"in" : "query",
"description" : "The names of the enumerations.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}, {
"name" : "shared",
"in" : "query",
"description" : "Match only with shared or unshared enumerations.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of enumerations and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Enums" ],
"summary" : "Create an enumeration",
"description" : "An enumeration is a bounded variable with a limited set of literal values. Use this API to create an enumeration to define acceptable values for a level in a topic address or topic domain.
Token Permissions: [ `ep_enum:create:*` ]",
"operationId" : "createEnum",
"requestBody" : {
"description" : "Enumeration description.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnum"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an enumeration. The newly saved enumeration is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/events" : {
"get" : {
"tags" : [ "Events" ],
"summary" : "Get a list of events",
"description" : "Use this API to get a list of events that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEvents",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of events to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name of the event to match on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "shared",
"in" : "query",
"description" : "Match only with shared or unshared events.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "brokerType",
"in" : "query",
"description" : "Match only events with the given broker type",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"description" : "Match only events in the given application domain.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only events in the given application domain ids.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only events with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of events and the accompanying metadata.",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/EventsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Events" ],
"summary" : "Create an event",
"description" : "Events are the primary building block of an event-driven architecture. Applications publish and subscribe to events and events reference schemas. In the Event Portal, an event is a type of event as opposed to a specific event instance.
Token Permissions: [ `event:create:*` ]",
"operationId" : "createEvent",
"requestBody" : {
"description" : "The event requires a name and an application domain ID.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Event"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an event. The newly saved event is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/states" : {
"get" : {
"tags" : [ "States" ],
"summary" : "Get a list of lifecycle states",
"description" : "Use this API to get a list of lifecycle states that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getStates",
"responses" : {
"200" : {
"description" : "Get a list of lifecycle states and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/StatesResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/schemas" : {
"get" : {
"tags" : [ "Schemas" ],
"summary" : "Get a list of schemas",
"description" : "Use this API to get a list of schemas that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getSchemas",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of schemas to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name of the schema to match on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "shared",
"in" : "query",
"description" : "Match only with shared or unshared schemas.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"description" : "Match only schemas in the given application domain.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "schemaType",
"in" : "query",
"description" : "Match only schemas with the given schema type",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only schemas in the given application domain ids.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only schemas with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of schemas and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemasResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Schemas" ],
"summary" : "Create a schema",
"description" : "To model your event-driven architecture, schemas are a fundamental building block for modelling the payloads of the events flowing through your system. Use this API to create schemas that can later be referenced by events.
Token Permissions: [ `schema:create:*` ]",
"operationId" : "createSchema",
"requestBody" : {
"description" : "The schema requires a name, an application domain and a schema type.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaObject"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a schema. The newly saved schema is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApis" : {
"get" : {
"tags" : [ "Event APIs" ],
"summary" : "Get a List of Event APIs",
"description" : "Use this API to get a list of event APIs that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventApis",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of event APIs to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name of the event API to match on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only event APIs with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"description" : "Match only event APIs in the given application domain.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only event APIs in the given application domains.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "eventApiVersionIds",
"in" : "query",
"description" : "Match only event APIs in the given event API version ids.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "availableWithinApplicationDomainIds",
"in" : "query",
"description" : "Additionally match any shared event APIs in any application domain.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "shared",
"in" : "query",
"description" : "Match only with shared or unshared event APIs.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "brokerType",
"in" : "query",
"description" : "Match only event APIs with the given broker type.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of event APIs and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApisResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event APIs" ],
"summary" : "Create an Event API",
"description" : "Use this API to create an event API.
Token Permissions: [ `event_api:create:*` ]",
"operationId" : "createEventApi",
"requestBody" : {
"description" : "The event API.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApi"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an event API. The newly saved event API is returned in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/consumers" : {
"get" : {
"tags" : [ "Consumers" ],
"summary" : "Get a list of consumers",
"description" : "Use this API to get a list of consumers that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getConsumers",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of consumers to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "applicationVersionIds",
"in" : "query",
"description" : "Match only consumers with the given application version IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only consumers with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of consumers and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConsumersResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Consumers" ],
"summary" : "Create a consumer",
"description" : "Use this API to create a consumer.
Token Permissions: [ `application:update:*` ]",
"operationId" : "createConsumer",
"requestBody" : {
"description" : "The consumer.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConsumerRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a consumer. Returns the newly saved consumer in the response body.",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ConsumerResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/enums/{id}" : {
"get" : {
"tags" : [ "Enums" ],
"summary" : "Get an enumeration",
"description" : "Use this API to get a single enumeration by its ID.
Token Permissions: [ `ep_enum:get:*` ]",
"operationId" : "getEnum",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the enumeration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The enumeration.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Enums" ],
"summary" : "Delete an enumeration",
"description" : "Use this API to delete an enumeration. The enumeration must not have any versions or else it cannot be deleted.
Token Permissions: [ `ep_enum:delete:*` ]",
"operationId" : "deleteEnum",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the enumeration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned if the delete was successful."
},
"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" : "If the enumeration did not exist."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Enums" ],
"summary" : "Update an enumeration",
"description" : "Use this API to update an enumeration object. You only need to specify the fields that need to be updated.
Token Permissions: [ `ep_enum:update:*` ]",
"operationId" : "updateEnum",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the enumeration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Enumeration updates.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnum"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Updated an enumeration. The newly saved enumeration is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventMeshes" : {
"get" : {
"tags" : [ "Event Meshes" ],
"summary" : "Get a list of modeled event meshes",
"description" : "Get a list of modeled event meshes that match the given parameters.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventMeshes",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of modeled event meshes to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name of the modeled event mesh to match on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "environmentId",
"in" : "query",
"description" : "Match only modeled event meshes in the given environment",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only modeled event meshes with the given unique identifiers separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMeshesResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event Meshes" ],
"summary" : "Create a modeled event mesh",
"description" : "Create a modeled event mesh in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `modeled_event_mesh:create:*` ]",
"operationId" : "createEventMesh",
"requestBody" : {
"description" : "The JSON schema that defines the modeled event mesh.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMesh"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMeshResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/events/{id}" : {
"get" : {
"tags" : [ "Events" ],
"summary" : "Get an event",
"description" : "Use this API to get a single event by its ID.
Token Permissions: [ `event:get:*` ]",
"operationId" : "getEvent",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The event.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Events" ],
"summary" : "Delete an event",
"description" : "Use this API to delete an event.
Token Permissions: [ `event:delete:*` ]",
"operationId" : "deleteEvent",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Events" ],
"summary" : "Update an event",
"description" : "Use this API to update an event. You only need to specify the fields that need to be updated.
Token Permissions: [ `event:update:*` ]",
"operationId" : "updateEvent",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Event"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated event.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/topicDomains" : {
"get" : {
"tags" : [ "Topic Domains" ],
"summary" : "Get a list of the topic domains",
"description" : "Use this API to get a list of topic domains that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getTopicDomains",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of topic domains to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only topic domains with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "brokerType",
"in" : "query",
"description" : "Match only topic domains with the given brokerType.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only topic domains with the given application domain ids separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of topic domains and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicDomainsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Topic Domains" ],
"summary" : "Create a topic domain",
"description" : "Topic Domains govern the format of topic addresses within an application domain
Token Permissions: [ `topic_domain:create:*` ]",
"operationId" : "createTopicDomain",
"requestBody" : {
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicDomain"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a topic domain. Returns the newly saved topic domain in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicDomainResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/enumVersions" : {
"get" : {
"tags" : [ "Enums" ],
"summary" : "Get a list of enumeration versions",
"description" : "Use this API to get a list of enumeration versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEnumVersions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of enumeration versions to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "enumIds",
"in" : "query",
"description" : "Match only enumeration versions of these enumeration IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only enumeration versions with the given IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of enumeration versions and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Enums" ],
"summary" : "Create an enumeration version",
"description" : "Create an enumeration version.
Token Permissions: [ `ep_enum:update:*` ]",
"operationId" : "createEnumVersion",
"requestBody" : {
"description" : "Enumeration version description with its values.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersion"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an enumeration version and its values. The newly saved enumeration version is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applications" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "Get a list of applications",
"description" : "Use this API to get a list of applications that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getApplications",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of applications to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name of the application to match on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"description" : "Match only applications in the given application domain.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only applications with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
}, {
"name" : "applicationType",
"in" : "query",
"description" : "Match only applications with the given applicationType.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationSubType",
"in" : "query",
"description" : "Match only applications with the given applicationSubType.",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of applications and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Applications" ],
"summary" : "Create an application",
"description" : "To model your event-driven architecture, applications are a fundamental building block for modelling the producers and consumers of events. Use this API to create applications and model the events they produce and consume.
Token Permissions: [ `application:create:*` ]",
"operationId" : "createApplication",
"requestBody" : {
"description" : "Applications have a name and live within an application domain. Events can be added to the application as produced or consumed.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Application"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an application. Returns the newly saved application in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/schemas/{id}" : {
"get" : {
"tags" : [ "Schemas" ],
"summary" : "Get a schema",
"description" : "Use this API to get a single schema by its ID.
Token Permissions: [ `schema:get:*` ]",
"operationId" : "getSchema",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the schema.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The schema.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Schemas" ],
"summary" : "Delete a schema",
"description" : "Use this API to delete a schema. The schema must not be in use by any events else it cannot be deleted.
Token Permissions: [ `schema:delete:*` ]",
"operationId" : "deleteSchema",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the schema.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Schemas" ],
"summary" : "Update a schema",
"description" : "Update a schema.
Token Permissions: [ `schema:update:*` ]",
"operationId" : "updateSchema",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the schema.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The schema requires a name, an application domain and a schema type.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaObject"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Updated a schema. The newly saved schema is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/environments" : {
"get" : {
"tags" : [ "Environments" ],
"summary" : "Get a list of environments",
"description" : "Use this API to get a list of all environments.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEnvironments",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of environments to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "like",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of environments and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EnvironmentsResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/auditResults" : {
"get" : {
"tags" : [ "Audit Results" ],
"summary" : "Get a list of audit results",
"description" : "This provides a list of audit results for the given event mesh and/or event brokers.
Token Permissions: [ audit:read ]",
"operationId" : "listAuditResults",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of audit records to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "Match only audit records belonging to the given event brokers.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "eventMeshId",
"in" : "query",
"description" : "Match only audit records belonging to the given event mesh.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "auditEntityTypes",
"in" : "query",
"description" : "Match only audit records belonging to the given entity types.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "all", "kafkaConsumerGroup", "kafkaConsumerGroupAggregate", "kafkaTopic", "kafkaTopicAggregate", "schemaParent", "schemaVersion", "solaceQueue", "solaceQueueAggregate", "solaceTopic", "kafkaTopicSchemaVersion", "kafkaTopicSchemaParent" ]
},
"uniqueItems" : true
}
}, {
"name" : "statuses",
"in" : "query",
"description" : "Match only audit records with the given statuses.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "designerOnly", "match", "partialMatch", "runtimeOnly" ]
},
"uniqueItems" : true
}
}, {
"name" : "startsWith",
"in" : "query",
"description" : "Match only audit records with identifiers starting with the given value.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "contains",
"in" : "query",
"description" : "Match audit records with identifiers containing the given value.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n Sorting is supported for status and identifier.",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The list of audit records and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AuditResultsResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventVersions" : {
"get" : {
"tags" : [ "Events" ],
"summary" : "Get a list of event versions",
"description" : "Use this API to get a list of event versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventVersions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of event versions to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventIds",
"in" : "query",
"description" : "Match only event versions of these event IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only event versions with the given IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "messagingServiceIds",
"in" : "query",
"description" : "Match only event versions with the given messaging service IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "stateIds",
"in" : "query",
"description" : "Match only event versions with the given state IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of event versions and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventVersionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Events" ],
"summary" : "Create an event version",
"description" : "Create an event version
Token Permissions: [ `event:update:*` ]",
"operationId" : "createEventVersion",
"requestBody" : {
"description" : "App version request body description",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventVersion"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an event version. Returns the newly saved event version in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/schemaVersions" : {
"get" : {
"tags" : [ "Schemas" ],
"summary" : "Get a list of schema versions",
"description" : "Use this API to get a list of schema versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getSchemaVersions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of schema versions to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "schemaIds",
"in" : "query",
"description" : "Match only schema versions of these schema IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only schema versions with the given IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of schema versions and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaVersionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Schemas" ],
"summary" : "Create a schema version",
"description" : "Creates a schema version
Token Permissions: [ `schema:update:*` ]",
"operationId" : "createSchemaVersion",
"requestBody" : {
"description" : "schema version details",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaVersion"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a schema version. The newly saved schema version is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApis/{id}" : {
"get" : {
"tags" : [ "Event APIs" ],
"summary" : "Get an Event API",
"description" : "Use this API to get a single event API by its ID.
Token Permissions: [ `event_api:get:*` ]",
"operationId" : "getEventApi",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event API.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The event API.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event APIs" ],
"summary" : "Delete an Event API",
"description" : "Use this API to delete an event API.
Token Permissions: [ `event_api:delete:*` ]",
"operationId" : "deleteEventApi",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event API.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event APIs" ],
"summary" : "Update an Event API",
"description" : "Use this API to update an event API. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api:update:*` ]",
"operationId" : "updateEventApi",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event API to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event API.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApi"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated event API.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/consumers/{id}" : {
"get" : {
"tags" : [ "Consumers" ],
"summary" : "Get a consumer",
"description" : "Use this API to get a single consumer by its ID.
Token Permissions: [ `application:get:*` ]",
"operationId" : "getConsumer",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the consumer.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The consumer.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConsumerResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Consumers" ],
"summary" : "Delete a consumer",
"description" : "Use this API to delete a consumer.
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteConsumer",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the consumer",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Consumers" ],
"summary" : "Update a consumer",
"description" : "Use this API to update a consumer.
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateConsumer",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the consumer.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The consumer.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConsumerRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Updated a consumer. Returns the newly saved consumer in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConsumerResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiVersions" : {
"get" : {
"tags" : [ "Event APIs" ],
"summary" : "Get a List of Event API Versions",
"description" : "Use this API to get a list of event API versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventApiVersions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of results to return in one page of results.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get results from based on the page size.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventApiIds",
"in" : "query",
"description" : "Match only event API versions of these event API IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match event API versions with the given IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "include",
"in" : "query",
"description" : "A list of additional entities to include in the response.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "parent"
}, {
"name" : "stateId",
"in" : "query",
"description" : "Match event API versions with the given state ID.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of event API versions.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event APIs" ],
"summary" : "Create an Event API Version",
"description" : "Use this API to create an event API version.
Token Permissions: [ `event_api:update:*` ]",
"operationId" : "createEventApiVersion",
"requestBody" : {
"description" : "Event API version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersion"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an event API version. Returns the newly saved event API version in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProducts" : {
"get" : {
"tags" : [ "Event API Products" ],
"summary" : "Get a List of Event API Products",
"description" : "Use this API to get a list of Event API Products that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventApiProducts",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Event API Products to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "brokerType",
"in" : "query",
"description" : "Match only Event API Products with the given broken type.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name of the Event API Product to match on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only Event API Products with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationDomainId",
"in" : "query",
"description" : "Match only Event API Products in the given application domain.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only Event API Products in the given application domains.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "shared",
"in" : "query",
"description" : "Match only with shared or unshared Event API Products.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "The list of Event API Products and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event API Products" ],
"summary" : "Create an Event API Product",
"description" : "Use this API to create an Event API Product.
Token Permissions: [ `event_api_product:create:*` ]",
"operationId" : "createEventApiProduct",
"requestBody" : {
"description" : "The Event API Product.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProduct"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an Event API Product. The newly saved Event API Product is returned in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventMeshes/{id}" : {
"get" : {
"tags" : [ "Event Meshes" ],
"summary" : "Get a modeled event mesh",
"description" : "Get a single modeled event mesh by its unique identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `modeled_event_mesh:get:*` ]",
"operationId" : "getEventMesh",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the modeled event mesh.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMeshResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event Meshes" ],
"summary" : "Delete a modeled event mesh",
"description" : "Delete a modeled event mesh.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `modeled_event_mesh:delete:*` ]",
"operationId" : "deleteEventMesh",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the modeled event mesh.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "force",
"in" : "query",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event Meshes" ],
"summary" : "Update a modeled event mesh",
"description" : "Update a modeled event mesh in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `modeled_event_mesh:update:*` ]",
"operationId" : "updateEventMesh",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the modeled event mesh.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The JSON schema that defines the modeled event mesh.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMesh"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMeshResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServices" : {
"get" : {
"tags" : [ "Messaging Services" ],
"summary" : "Get a list of messaging services",
"description" : "Use this API to get a list of messaging services that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getMessagingServices",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of messaging services to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The IDs of the messaging services.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "messagingServiceType",
"in" : "query",
"description" : "Match only messaging services of the given type, options are: solace, kafka.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "runtimeAgentId",
"in" : "query",
"description" : "Match only messaging services in the given runtimeAgentId",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "eventMeshId",
"in" : "query",
"description" : "Match only messaging services in the given eventMeshId",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "eventManagementAgentId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The list of messaging services and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServicesResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Messaging Services" ],
"summary" : "Create a messaging service",
"description" : "Use this API to create a messaging service.
Token Permissions: [ `modeled_event_broker:create:*` **or** `messaging_service:write` ]",
"operationId" : "createMessagingService",
"requestBody" : {
"description" : "The messaging service.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingService"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a messaging service. The newly saved messaging service is returned in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/environments/{id}" : {
"get" : {
"tags" : [ "Environments" ],
"summary" : "Get an environment",
"description" : "Use this API to get a single environment by its ID.
Token Permissions: [ `ep_environment:get:*` ]",
"operationId" : "getEnvironment",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the environment.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The environment.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EnvironmentResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Environments" ],
"summary" : "Update environment runtime configuration",
"description" : "Update the runtime configuration attributes for an environment to enable or disable runtime configuration\nand to require Solace queue configuration and client profile name templates.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_environment:update:*` ]",
"operationId" : "updateEnvironment",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the environment.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The environment.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Environment"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated environment.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EnvironmentResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/enumVersions/{id}" : {
"delete" : {
"tags" : [ "Enums" ],
"summary" : "Delete an enumeration version",
"description" : "Use this API to delete an enumeration version. The version must not be in use by any events else it cannot be deleted. This also deletes the version's values.
Token Permissions: [ `ep_enum:update:*` ]",
"operationId" : "deleteEnumVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the enumeration version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned if the delete was successful."
},
"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" : "If the enumeration version did not exist."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Enums" ],
"summary" : "Update an enumeration version",
"description" : "Use this API to update an enumeration version. You only need to specify the fields that need to be updated.
Token Permissions: [ `ep_enum:update:*` ]",
"operationId" : "updateEnumVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the enumeration version to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The enumeration version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated enumeration version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applications/{id}" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "Get an application",
"description" : "Use this API to get a single application by its ID.
Token Permissions: [ `application:get:*` ]",
"operationId" : "getApplication",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The application.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Applications" ],
"summary" : "Delete an application",
"description" : "Use this API to delete an application.
Token Permissions: [ `application:delete:*` ]",
"operationId" : "deleteApplication",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Applications" ],
"summary" : "Update an application",
"description" : "Use this API to update an application. You only need to specify the fields that need to be updated.
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateApplication",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The application.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Application"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated application.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/topicDomains/{id}" : {
"get" : {
"tags" : [ "Topic Domains" ],
"summary" : "Get a topic domain",
"description" : "Use this API to get a single topic domain by its ID.
Token Permissions: [ `topic_domain:get:*` ]",
"operationId" : "getTopicDomain",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the topic domain.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The topic domain.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicDomainResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Topic Domains" ],
"summary" : "Delete a topic domain",
"description" : "Use this API to delete a topic domain.
Token Permissions: [ `topic_domain:delete:*` ]",
"operationId" : "deleteTopicDomain",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the topic domain",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned.",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/TopicDomainResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventMeshWarnings" : {
"get" : {
"tags" : [ "Event Meshes" ],
"summary" : "(EA) Get entities with warnings associated with the specified modeled event mesh",
"description" : "Get a list of entities associated with the specified modeled event mesh that have warnings that the user may want to act on.\nExamples of warnings include unconsumed events, unpublished events, and events with no topic address.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_runtime:read ]",
"operationId" : "getEventMeshWarnings",
"parameters" : [ {
"name" : "eventMeshId",
"in" : "query",
"description" : "The unique identifier of the modeled event mesh.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "minimizeData",
"in" : "query",
"description" : "When set to true, returns a minimized data set containing only entity ids and warnings.",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventMeshWarningResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/about/eventMeshes" : {
"get" : {
"tags" : [ "Event Meshes" ],
"summary" : "Get a list of basic information for all modeled event meshes",
"description" : "Get a list of the basic information for all modeled event meshes.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ modeled_event_mesh:get_info:* ]",
"operationId" : "getEventmeshInfo",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of modeled event meshes to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the modeled event meshes to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/EventMeshesInfoResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventAccessReviews" : {
"get" : {
"tags" : [ "Event Access Reviews" ],
"summary" : "(EA) Get a list of event access reviews",
"description" : "Use this API to get a list of event access reviews that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventAccessReviews",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of events to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1
}
}, {
"name" : "requestIds",
"in" : "query",
"description" : "The request ids to get reviews for",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The review ids to get",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "decision",
"in" : "query",
"description" : "Get reviews with the given decision",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "approved", "pending", "declined" ]
}
}, {
"name" : "userId",
"in" : "query",
"description" : "Get reviews created by the given userId",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of event access reviews.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewListResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event Access Reviews" ],
"summary" : "(EA) Create an event access review",
"description" : "Use this API to get a create an event access review.
Token Permissions: [ `event_access_review:create:*` ]",
"operationId" : "createEventAccessReview",
"requestBody" : {
"description" : "The review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Review"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an event access review. The newly saved event access review is returned in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationDomains" : {
"get" : {
"tags" : [ "Application Domains" ],
"summary" : "Get a list of the application domains",
"description" : "Use this API to get a list of application domains that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getApplicationDomains",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of application domains to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "name",
"in" : "query",
"description" : "Name to be used to match the application domain.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only application domains with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "include",
"in" : "query",
"description" : "Specify extra data to be included, options are: stats",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of application domains and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomainsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Application Domains" ],
"summary" : "Create an application domain",
"description" : "To help keep your event-driven architecture organized, use application domains to create namespaces for your applications, events and schemas.
Token Permissions: [ `application_domain:create:*` ]",
"operationId" : "createApplicationDomain",
"requestBody" : {
"description" : "Application domains have a name and topic domain.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomain"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created. The newly saved application domain is returned in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomainResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventVersions/{id}" : {
"get" : {
"tags" : [ "Events" ],
"summary" : "Get an event version",
"description" : "Use this API to get a single event version by its ID.
Token Permissions: [ `event:get:*` ]",
"operationId" : "getEventVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The event version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Events" ],
"summary" : "Delete an event version",
"description" : "Use this API to delete an event version.
Token Permissions: [ `event:update:*` ]",
"operationId" : "deleteEventVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event version",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Events" ],
"summary" : "Update an event version",
"description" : "Use this API to update an event version. You only need to specify the fields that need to be updated.
Token Permissions: [ `event:update:*` ]",
"operationId" : "updateEventVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event version to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated event version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EventVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/configurationTypes" : {
"get" : {
"tags" : [ "Configuration Types" ],
"summary" : "(Beta) Get a list of configuration types",
"description" : "Use this API to get a list of configuration types that match the given parameters.
Token Permissions: [ ep_configuration:read ]",
"operationId" : "getConfigurationTypes",
"parameters" : [ {
"name" : "ids",
"in" : "query",
"description" : "Match only configuration types with the given IDs separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "names",
"in" : "query",
"description" : "Match only configuration types with the given names separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "associatedEntityTypes",
"in" : "query",
"description" : "Match only configuration types with the given associated entity type values separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "brokerType",
"in" : "query",
"description" : "Match only configuration types with the given broker type.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "expand",
"in" : "query",
"description" : "Expand the response to include additional fields. Supported values: templateMetaSchema.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of configuration types and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationTypesResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/about/environments" : {
"get" : {
"tags" : [ "Environments" ],
"summary" : "Get a list of basic environment information",
"description" : "Get a list of the basic information for the specified environments.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ ep_environment:get_info:* ]",
"operationId" : "getEnvironmentInfo",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of environments to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the environments to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/EnvironmentInfoResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/about/applications" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "(EA) Get a list of basic information for all applications",
"description" : "Use this API to get a list of basic information for all applications.
Token Permissions: [ application:get_info:* ]",
"operationId" : "getApplicationInfo",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of items to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the applications to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationsInfoResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "Get a list of application versions",
"description" : "Use this API to get a list of application versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getApplicationVersions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of application versions to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "applicationIds",
"in" : "query",
"description" : "Match only application versions of these application IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match only application versions with the given IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationDomainIds",
"in" : "query",
"description" : "Match only application versions with the given application domain IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "messagingServiceIds",
"in" : "query",
"description" : "Match only application versions with the given messaging service IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "stateIds",
"in" : "query",
"description" : "Match only application versions with the given state IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of application versions and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Applications" ],
"summary" : "Create an application version",
"description" : "Create an application version
Token Permissions: [ `application:update:*` ]",
"operationId" : "createApplicationVersion",
"requestBody" : {
"description" : "App version request body description",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersion"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an application version. Returns the newly saved application version in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/schemaVersions/{id}" : {
"delete" : {
"tags" : [ "Schemas" ],
"summary" : "Delete a schema version",
"description" : "Use this API to delete a schema version.
Token Permissions: [ `schema:update:*` ]",
"operationId" : "deleteSchemaVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the schema version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Schemas" ],
"summary" : "Update a schema version",
"description" : "Use this API to update a schema version.
Token Permissions: [ `schema:update:*` ]",
"operationId" : "updateSchemaVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the schema version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The schema version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventAccessRequests" : {
"get" : {
"tags" : [ "Event Access Requests" ],
"summary" : "(EA) Get event access requests",
"description" : "Use this API to get a list of event access requests that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventAccessRequests",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of requests to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The request ids to get",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationIds",
"in" : "query",
"description" : "Get requests with given applicationIds",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "eventIds",
"in" : "query",
"description" : "Get requests with given eventIds",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "relationships",
"in" : "query",
"description" : "Get requests with the given relationships",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "consuming", "producing" ]
},
"uniqueItems" : true
}
}, {
"name" : "reviewStatuses",
"in" : "query",
"description" : "Get requests with the given review statuses",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "approved", "pending", "declined" ]
},
"uniqueItems" : true
}
}, {
"name" : "subscriptions",
"in" : "query",
"description" : "Get requests with the given subscriptions",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "createdBys",
"in" : "query",
"description" : "Get requests with the given createdBy user IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "excludeAutoApprovedEvents",
"in" : "query",
"description" : "If set to true, exclude requests for auto-approved events",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "canReview",
"in" : "query",
"description" : "If set to true, return requests that the user can review",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of event access requests.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventAccessRequestListResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event Access Requests" ],
"summary" : "(EA) Delete event access request(s)",
"description" : "Use this API to delete one or more event access requests. A Domain Manager/Editor for the application's domain can delete requests. Requests can be deleted regardless of review status (pending, approved, or declined). Note: Deleting an approved request only removes the approval record. Any deployed runtime access remains active.
Token Permissions: [ event_designer:access ]",
"operationId" : "deleteEventAccessRequests",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventAccessRequestDeletionRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "The event access request(s) were successfully deleted."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventManagementAgents" : {
"get" : {
"tags" : [ "Event Management Agents" ],
"summary" : "Get a list of EMAs",
"description" : "Use this API to get a list of EMAs that match the given parameters.
Token Permissions: [ event_management_agent:read ]",
"operationId" : "getEventManagementAgents",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of EMAs to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The IDs of the EMAs.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "createdBy",
"in" : "query",
"description" : "Match only EMAs created by this user",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "eventManagementAgentRegionId",
"in" : "query",
"description" : "Match only EMAs in the given EMA-Region",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Specify extra data to be included, options are: referencedByMessagingServiceIds.\n
Replacement: Use expand instead.\n
Reason: The change is to align with the API specification design.\n
Removal Date: 2024-11-03 18:00:00.000.\n",
"required" : false,
"deprecated" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "expand",
"in" : "query",
"description" : "Specify extra data to be included, options are: referencedByMessagingServiceIds.",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The list of EMAs and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventManagementAgentsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event Management Agents" ],
"summary" : "Create an EMA object",
"description" : "Use this API to create an EMA object.
Token Permissions: [ event_management_agent:write ]",
"operationId" : "createEventManagementAgent",
"requestBody" : {
"description" : "The EMA object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventManagementAgent"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an EMA. The newly saved EMA object is returned in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventManagementAgentResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProducts/{id}" : {
"get" : {
"tags" : [ "Event API Products" ],
"summary" : "Get an Event API Product",
"description" : "Use this API to get a single Event API Product by its ID.
Token Permissions: [ `event_api_product:get:*` ]",
"operationId" : "getEventApiProduct",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the Event API Product.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The Event API Product.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event API Products" ],
"summary" : "Delete an Event API Product",
"description" : "Use this API to delete an Event API Product.
Token Permissions: [ `event_api_product:delete:*` ]",
"operationId" : "deleteEventApiProduct",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the Event API Product.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event API Products" ],
"summary" : "Update an Event API Product",
"description" : "Use this API to update an Event API Product. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "updateEventApiProduct",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the Event API Product to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Event API Product.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProduct"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated Event API Product.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServiceScans" : {
"get" : {
"tags" : [ "Messaging Service Scans" ],
"summary" : "Get a list of messaging service scans",
"description" : "Use this API to get a list of messaging service scans that match the given parameters.
Token Permissions: [ messaging_service_scan:read ]",
"operationId" : "getMessagingServiceScans",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of messaging service scans to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The IDs of the messaging service scans.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "messagingServiceId",
"in" : "query",
"description" : "Match only messaging service scans in the given messagingService",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "eventMeshId",
"in" : "query",
"description" : "Match only messaging service scans in the given eventMeshId",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The list of messaging service scans and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceScansResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventPortalUsageStats" : {
"get" : {
"tags" : [ "Event Portal Usage Stats" ],
"summary" : "(EA) Get event portal usage stats",
"description" : "Use this API to get event portal usage stats
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventPortalUsageStats",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ResponseEventPortalUsageStats"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServices/{id}" : {
"get" : {
"tags" : [ "Messaging Services" ],
"summary" : "Get a messaging service",
"description" : "Use this API to get a single messaging service by its ID.
Token Permissions: [ `modeled_event_broker:get:*` **or** `messaging_service:read` ]",
"operationId" : "getMessagingService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The messaging service.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Messaging Services" ],
"summary" : "Delete a messaging service",
"description" : "Use this API to delete a messaging service.
Token Permissions: [ `modeled_event_broker:delete:*` **or** `messaging_service:write` ]",
"operationId" : "deleteMessagingService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "force",
"in" : "query",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Messaging Services" ],
"summary" : "Update a messaging service",
"description" : "Use this API to update a messaging service. You only need to specify the fields that need to be updated. However, if you want to update anything under subObjects (i.e. anything inside messagingServiceConnections object), you need to provide the original messagingServiceConnections with the updated fields instead of just providing the changed fields.
Token Permissions: [ `modeled_event_broker:update:*` **or** `messaging_service:write` ]",
"operationId" : "updateMessagingService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The messaging service.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingService"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated messaging service.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductVersions" : {
"get" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Get a List of Event API Product Versions",
"description" : "Use this API to get a list of Event API Product versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getEventApiProductVersions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of results to return in one page of results.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get results from based on the page size.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventApiProductIds",
"in" : "query",
"description" : "Match only Event API Product versions of these Event API Product IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Match Event API Product versions with the given IDs, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "include",
"in" : "query",
"description" : "A list of additional entities to include in the response.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "parent"
}, {
"name" : "stateId",
"in" : "query",
"description" : "Match Event API Product versions with the given state ID.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "messagingServiceId",
"in" : "query",
"description" : "Match Event API Product versions with the given messagingServiceId.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "clientAppId",
"in" : "query",
"description" : "Match Event API Product versions with the given clientAppId.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "shared",
"in" : "query",
"description" : "Match Event API Product versions with the parent objects shared setting.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "latest",
"in" : "query",
"description" : "Only return the latest version of Event API Products.",
"required" : false,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "customAttributes",
"in" : "query",
"description" : "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "color==red"
} ],
"responses" : {
"200" : {
"description" : "Get a list of Event API Product versions.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Create an Event API Product Version",
"description" : "Use this API to create an Event API Product version.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "createEventApiProductVersion",
"requestBody" : {
"description" : "Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersion"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created an Event API Product version. Returns the newly saved Event API Product version in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventAccessReviews/{id}" : {
"get" : {
"tags" : [ "Event Access Reviews" ],
"summary" : "(EA) Get event access review by id",
"description" : "Get event access review by id
Token Permissions: [ `event_access_review:get:*` ]",
"operationId" : "getEventAccessReview",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access review",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The event access review.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event Access Reviews" ],
"summary" : "(EA) Delete an event access review",
"description" : "Use this API to delete an event access review
Token Permissions: [ `event_access_review:delete:*` ]",
"operationId" : "deleteEventAccessReview",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access review",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event Access Reviews" ],
"summary" : "(EA) Update an event access review",
"description" : "Use this API to update an event access review.
Token Permissions: [ `event_access_review:update:*` ]",
"operationId" : "updateEventAccessReview",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access review to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event access review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Review"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated event access review.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/enumVersions/{id}/state" : {
"patch" : {
"tags" : [ "Enums" ],
"summary" : "Update the state of an enumeration version",
"description" : "Use this API to update the state of an enumeration version. You only need to specify the target stateId field.
Token Permissions: [ `ep_enum:update_state:*` ]",
"operationId" : "updateEnumVersionState",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the enumeration version to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The state object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VersionedObjectStateChangeRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated state of the enumeration version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationDomains/{id}" : {
"get" : {
"tags" : [ "Application Domains" ],
"summary" : "Get an application domain",
"description" : "Use this API to get a single application domain by its ID.
Token Permissions: [ `application_domain:get:*` ]",
"operationId" : "getApplicationDomain",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application domain.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Specify extra data to be included, options are: stats",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "The application domain.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomainResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Application Domains" ],
"summary" : "Delete an application domain",
"description" : "Use this API to delete an application domain. This action also deletes all applications, events, and schemas in the application domain. You cannot undo this operation.
Token Permissions: [ `application_domain:delete:*` ]",
"operationId" : "deleteApplicationDomain",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application domain.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Application Domains" ],
"summary" : "Update an application domain",
"description" : "Use this API to update an application domain. You only need to specify the fields that need to be updated.
Token Permissions: [ `application_domain:update:*` ]",
"operationId" : "updateApplicationDomain",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application domain.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The application domain.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomain"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated application domain.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomainResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/configurationTypes/{id}" : {
"get" : {
"tags" : [ "Configuration Types" ],
"summary" : "(Beta) Get a configuration type",
"description" : "Use this API to get a single configuration type by its ID.
Token Permissions: [ ep_configuration:read ]",
"operationId" : "getConfigurationType",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration type.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The configuration type.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationTypeResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventVersions/{id}/state" : {
"patch" : {
"tags" : [ "Events" ],
"summary" : "Update the state of an event version",
"description" : "Use this API to update the state of event version. You only need to specify the target stateId field
Token Permissions: [ `event:update_state:*` ]",
"operationId" : "updateEventVersionState",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event version to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The state object.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/VersionedObjectStateChangeRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated state of the event version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventAccessRequests/{id}" : {
"get" : {
"tags" : [ "Event Access Requests" ],
"summary" : "(EA) Get event access request by id",
"description" : "Get event access request by id
Token Permissions: [ `event_access_request:get:*` **or** `event_access_request:review:*` ]",
"operationId" : "getEventAccessRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access request.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get the event access request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventAccessRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event Access Requests" ],
"summary" : "(EA) Update an event access request",
"description" : "Use this API to update an event access request. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_access_request:update:*` ]",
"operationId" : "updateEventAccessRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access request to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event access request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventAccessRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated event access request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventAccessRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/enumVersions/{versionId}" : {
"get" : {
"tags" : [ "Enums" ],
"summary" : "Get an enumeration version",
"description" : "Use this API to get a single enumeration version by its ID.
Token Permissions: [ `ep_enum:get:*` ]",
"operationId" : "getEnumVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the enumeration version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The enumeration version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationDomains/import" : {
"post" : {
"tags" : [ "Application Domains" ],
"summary" : "(Beta) Create application domains and their entities from import",
"description" : "Create new application domains and their nested entities by importing application domains that have been previously exported from a Solace Cloud. Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `application_domain:import:*` ]",
"operationId" : "importApplicationDomains",
"requestBody" : {
"description" : "Application domain import file",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDomainImportDTO"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Successfully registered import job with location identified in the response header"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/schemaVersions/{id}/state" : {
"patch" : {
"tags" : [ "Schemas" ],
"summary" : "Update the state of a schema version",
"description" : "Use this API to update the state of a schema version.
Token Permissions: [ `schema:update_state:*` ]",
"operationId" : "updateSchemaVersionState",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the schema version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The state change object.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/VersionedObjectStateChangeRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated state of the schema version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/about/modeledEventBrokers" : {
"get" : {
"tags" : [ "Modeled Event Broker" ],
"summary" : "Get a list of basic information for all model event brokers",
"description" : "Get a list of basic information for all model event brokers.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ modeled_event_broker:get_info:* ]",
"operationId" : "getMessagingServiceInfo",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of model event brokers to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the model event brokers to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ModeledEventBrokerInfoResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/customAttributeDefinitions" : {
"get" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Get a list of custom attribute definitions",
"description" : "Use this API to get a list of custom attribute definitions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getCustomAttributeDefinitions",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of custom attribute definitions to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "associatedEntityTypes",
"in" : "query",
"description" : "Match only custom attribute definitions with the given associated entity type names separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of custom attribute definitions and the accompanying metadata.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Create a custom attribute definition",
"description" : "Use this API to create a custom attribute definition.
Token Permissions: [ custom_attribute:write ]",
"operationId" : "createCustomAttributeDefinition",
"requestBody" : {
"description" : "The custom attribute definition.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinition"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a custom attribute definition. Returns the newly saved custom attribute definition in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventManagementAgents/{id}" : {
"get" : {
"tags" : [ "Event Management Agents" ],
"summary" : "Get an EMA object",
"description" : "Use this API to get a single EMA by its ID.
Token Permissions: [ event_management_agent:read ]",
"operationId" : "getEventManagementAgent",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the EMA object.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Specify extra data to be included, options are: referencedByMessagingServiceIds.\n
Replacement: Use expand instead.\n
Reason: The change is to align with the API specification design.\n
Removal Date: 2024-11-03 18:00:00.000.\n",
"required" : false,
"deprecated" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "expand",
"in" : "query",
"description" : "Specify extra data to be included, options are: referencedByMessagingServiceIds.",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The EMA object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventManagementAgentResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event Management Agents" ],
"summary" : "Delete an EMA object",
"description" : "Use this API to delete an EMA.
Token Permissions: [ event_management_agent:write ]",
"operationId" : "deleteEventManagementAgent",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the EMA object.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event Management Agents" ],
"summary" : "Update an EMA object",
"description" : "Use this API to update an EMA. You only need to specify the fields that need to be updated.
Token Permissions: [ event_management_agent:write ]",
"operationId" : "updateEventManagementAgent",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the EMA object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The EMA object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventManagementAgent"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated EMA object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventManagementAgentResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/schemaVersions/{versionId}" : {
"get" : {
"tags" : [ "Schemas" ],
"summary" : "Get a schema version",
"description" : "Use this API to get a single schema version by its ID.
Token Permissions: [ `schema:get:*` ]",
"operationId" : "getSchemaVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the schema version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The schema version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServiceScans/{id}" : {
"get" : {
"tags" : [ "Messaging Service Scans" ],
"summary" : "Get a messaging service scan",
"description" : "Use this API to get a single messaging service scan by its ID.
Token Permissions: [ messaging_service_scan:read ]",
"operationId" : "getMessagingServiceScan",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service scan.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The messaging service scan.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceScanResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Messaging Service Scans" ],
"summary" : "Delete a messaging service scan",
"description" : "Use this API to delete a messaging service scan.
Token Permissions: [ messaging_service_scan:write ]",
"operationId" : "deleteMessagingServiceScan",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service scan.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationPromotionRequests" : {
"get" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Get application promotion requests",
"description" : "Use this API to get a list of application promotion requests that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId" : "getListApplicationPromotionRequests",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of requests to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The request ids to get",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationVersionIds",
"in" : "query",
"description" : "Get requests with given application version IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "applicationIds",
"in" : "query",
"description" : "Get requests with given application IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "Get requests with given messaging service IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "environmentIds",
"in" : "query",
"description" : "Get requests with the given environment IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "createdBys",
"in" : "query",
"description" : "Get requests with the given createdBy user IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "requestStatuses",
"in" : "query",
"description" : "Get requests with the given request statuses",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "reviewStatuses",
"in" : "query",
"description" : "Get requests with the given review statuses",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "applicationNameContains",
"in" : "query",
"description" : "Filter requests by application names that contain this string",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of application promotion requests.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionListResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Create an application promotion request",
"description" : "Use this API to create a new application promotion request.
Token Permissions: [ `promotion_request:create:*` **and** `ep_environment:get:*` ]",
"operationId" : "createApplicationPromotionRequest",
"requestBody" : {
"description" : "The application promotion request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "The created application promotion request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiVersions/{versionId}" : {
"get" : {
"tags" : [ "Event APIs" ],
"summary" : "Get an Event API Version",
"description" : "Use this API to get a single event API version by its ID.
Token Permissions: [ `event_api:get:*` ]",
"operationId" : "getEventApiVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the event API version.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "include",
"in" : "query",
"description" : "A list of additional entities to include in the response.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "parent"
} ],
"responses" : {
"200" : {
"description" : "The event API version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event APIs" ],
"summary" : "Delete an Event API Version",
"description" : "Use this API to delete an event API version by event API version ID.
Token Permissions: [ `event_api:update:*` ]",
"operationId" : "deleteEventApiVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the event API version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event APIs" ],
"summary" : "Update an Event API by Event API Version ID",
"description" : "Use this API to update an event API version by event API version ID.You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api:update:*` ]",
"operationId" : "updateEventApiVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the event API version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event API version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated event API version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/auditResults/{auditResultId}" : {
"get" : {
"tags" : [ "Audit Results" ],
"summary" : "Get the details of a single audit result",
"description" : "This provides the details of a single audit result, given its id.
Token Permissions: [ audit:read ]",
"operationId" : "getAuditResultDetail",
"parameters" : [ {
"name" : "auditResultId",
"in" : "path",
"description" : "The ID of the audit.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The audit detail.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AuditResultDetailResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/customAttributeDefinitions/{id}" : {
"get" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Get a custom attribute definition",
"description" : "Use this API to get a single custom attribute definition by its ID.
Token Permissions: [ event_designer:access ]",
"operationId" : "getCustomAttributeDefinition",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the custom attribute definition.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The custom attribute definition.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Delete a custom attribute definition",
"description" : "Use this API to delete a custom attribute definition.
Token Permissions: [ custom_attribute:write ]",
"operationId" : "deleteCustomAttributeDefinition",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the custom attribute definition",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Update a custom attribute definition",
"description" : "Use this API to update a custom attribute definition. You can only update the associated entity types.
Token Permissions: [ custom_attribute:write ]",
"operationId" : "updateCustomAttributeDefinition",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the custom attribute definition to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The custom attribute definition.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinition"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated custom attribute definition.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{versionId}" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "Get an application version",
"description" : "Use this API to get a single application version by its ID.
Token Permissions: [ `application:get:*` ]",
"operationId" : "getApplicationVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the application version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The application version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Applications" ],
"summary" : "Delete an application version",
"description" : "Use this API to delete an application version.
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteApplicationVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the application version",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Applications" ],
"summary" : "Update an application version",
"description" : "Use this API to update an application version. You only need to specify the fields that need to be updated.
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateApplicationVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the application version to update.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "include",
"in" : "query",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "relationsBrokerType",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The application version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated application version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersionResponse"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/ErrorResponse"
}, {
"$ref" : "#/components/schemas/InvalidStateReference"
} ]
}
}
}
},
"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"
}
}
}
}
}
}
},
"/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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventAccessRequests/{id}/decline" : {
"post" : {
"tags" : [ "Event Access Requests" ],
"summary" : "(EA) Update an event access request to be declined",
"description" : "Use this API to decline an event access request. A comment can be provided
Token Permissions: [ `event_access_request:review:*` ]",
"operationId" : "declineEventAccessRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access request to decline.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event access review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApproveDeclineRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The declining review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventAccessRequests/{id}/approve" : {
"post" : {
"tags" : [ "Event Access Requests" ],
"summary" : "(EA) Update an event access request to be approved",
"description" : "Use this API to approve an event access request. A comment can be provided
Token Permissions: [ `event_access_request:review:*` ]",
"operationId" : "approveEventAccessRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event access request to approve.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The event access review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApproveDeclineRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The approving review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/changeApplicationDomainOperations" : {
"post" : {
"tags" : [ "Application Domain Operations" ],
"summary" : "Create change application domain operation",
"description" : "Use this API to execute a change application domain operation.
Token Permissions: [ `application_domain:move_contents:*` ]",
"operationId" : "createChangeApplicationDomainOperation",
"requestBody" : {
"description" : "The change application domain operation",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ChangeAppDomainEntitiesDTO"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Successfully executed a change application domain operation."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationPromotionRequests/{id}" : {
"get" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Get application promotion request by id",
"description" : "Get application promotion request by id
Token Permissions: [ `promotion_request:get:*` ]",
"operationId" : "getApplicationPromotionRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application promotion request.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get the application promotion request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Delete an application promotion request",
"description" : "Use this API to delete an application promotion request.
Token Permissions: [ `promotion_request:delete:*` ]",
"operationId" : "deleteApplicationPromotionRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application promotion request to delete.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "The application promotion request was successfully deleted."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/configurationTemplate/solaceQueues" : {
"get" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Get a list of Solace queue configuration templates",
"description" : "Get a list of Solace queue configuration templates that match the specified parameters.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceQueueConfigurationTemplates",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace queue configuration templates to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the Solace queue configuration templates to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "name",
"in" : "query",
"description" : "The name of the Solace queue configuration template to match.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of solace queue configuration templates and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplatesResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Create a Solace queue configuration template",
"description" : "Create a Solace queue configuration template to provide queue properties to Solace event brokers.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:create:*` ]",
"operationId" : "createSolaceQueueConfigurationTemplate",
"requestBody" : {
"description" : "The JSON schema that defines the Solace queue configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplate"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "The created solace queue configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplateResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationPromotionRequestReviews" : {
"get" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Get reviews for application promotion requests",
"description" : "Use this API to get reviews for application promotion requests.",
"operationId" : "getApplicationPromotionRequestReviews",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of reviews to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1
}
}, {
"name" : "requestIds",
"in" : "query",
"description" : "The application promotion request IDs to filter by",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "Get reviews with the given IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "createdBys",
"in" : "query",
"description" : "Get reviews with the given created by user IDs",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "reviewDecisions",
"in" : "query",
"description" : "Get reviews with the given review decisions",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of reviews for application promotion requests.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestReviewListResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Create a review for an application promotion request",
"description" : "Use this API to create a review for an application promotion request. Users cannot review their own promotion requests.
Token Permissions: [ `promotion_request_review:create:*` ]",
"operationId" : "createApplicationPromotionRequestReview",
"requestBody" : {
"description" : "The application promotion request review",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestReview"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "The created application promotion request review.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestReviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiVersions/{versionId}/state" : {
"patch" : {
"tags" : [ "Event APIs" ],
"summary" : "Update the State of an Event API Version by Event API Version ID",
"description" : "Use this API to update the state of an event API version. You only need to specify the state ID field with the desired state ID.
Token Permissions: [ `event_api:update_state:*` ]",
"operationId" : "updateEventApiVersionState",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the event API version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Event API version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated state of the event API version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceQueues" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of queue configurations",
"description" : "Get a list of Solace event queue configurations for a consumer in an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceQueueConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace event queue configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve queue configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the queue configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve queue configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create a queue configuration",
"description" : "Create a Solace event queue configuration for a consumer in an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceQueueConfiguration",
"requestBody" : {
"description" : "The queue configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductVersions/{versionId}" : {
"get" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Get an Event API Product Version",
"description" : "Use this API to get a single Event API Product version by its ID.
Token Permissions: [ `event_api_product:get:*` ]",
"operationId" : "getEventApiProductVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the Event API Product version.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "include",
"in" : "query",
"description" : "A list of additional entities to include in the response.",
"required" : false,
"schema" : {
"type" : "string"
},
"example" : "parent"
}, {
"name" : "clientAppId",
"in" : "query",
"description" : "Match Event API Product versions with the given clientAppId.",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Delete an Event API Product Version by ID",
"description" : "Use this API to delete an Event API Product version by ID.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "deleteEventApiProductVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the Event API Product version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Update an Event API Product Version by Version ID",
"description" : "Use this API to update an Event API Product version. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "updateEventApiProductVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the Event API Product version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersionResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServiceScans/{scanId}/logs" : {
"get" : {
"tags" : [ "Messaging Service Scan Logs" ],
"summary" : "Get a list of messaging service scan logs",
"description" : "Use this API to get a list of messaging service scan logs that match the given parameters.
Token Permissions: [ messaging_service_scan:read ]",
"operationId" : "getMessagingServiceScansLogs",
"parameters" : [ {
"name" : "scanId",
"in" : "path",
"description" : "The ID of the messaging service scan we want logs for.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The number of messaging service scan logs to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The list of messaging service scan logs and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceScanLogListResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventVersions/{id}/messagingServices" : {
"put" : {
"tags" : [ "Events" ],
"summary" : "Replace messaging service association for an event version",
"description" : "Use this API to replace the messaging service association for an event version.
Token Permissions: [ event_runtime:write ]",
"operationId" : "updateMsgSvcAssociationForEventVersion",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the event version",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The messaging service association object",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceAssociationDTO"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated messaging service associations.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceAssociationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationPromotionRequests/previews" : {
"post" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Create a preview of an application promotion",
"description" : "Generates a *fresh* preview of the resulting changes in an application's event broker resources based on the specified application version ID and target event broker ID. It shows what would happen if the promotion were executed *now*. The preview is provided in the data/requested section of the response.
Token Permissions: [ event_designer:access ]",
"operationId" : "createApplicationPromotionPreviewByVersion",
"requestBody" : {
"description" : "The application version and event broker to preview the promotion for.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationPromotionPreviewRequestDTO"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The promotion preview has been successfully generated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDeploymentPreviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{versionId}/state" : {
"patch" : {
"tags" : [ "Applications" ],
"summary" : "Update the state of an application version",
"description" : "Use this API to update the state of an application version. You only need to specify the target stateId field.
Token Permissions: [ `application:update_state:*` ]",
"operationId" : "updateApplicationVersionState",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the application version to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The state change object.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/VersionedObjectStateChangeRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated state of the application version.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/changeApplicationDomainOperations/{id}" : {
"get" : {
"tags" : [ "Application Domain Operations" ],
"summary" : "Get a change application domain operation's details",
"description" : "Use this API to retrieve a single change application domain operation by its ID.
Token Permissions: [ event_designer:access ]",
"operationId" : "getChangeApplicationDomainOperation",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the change application domain operation.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"202" : {
"description" : "The change application domain operation.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/OperationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/configurationTemplate/solaceQueues/{id}" : {
"get" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Get a specific Solace queue configuration template",
"description" : "Get a Solace queue configuration template by its identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:get:*` ]",
"operationId" : "getSolaceQueueConfigurationTemplate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the Solace queue configuration template.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The solace queue configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplateResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Delete a Solace queue configuration template",
"description" : "Delete a Solace queue configuration template.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:delete:*` ]",
"operationId" : "deleteSolaceQueueConfigurationTemplate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the Solace queue configuration template.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Update a Solace queue configuration template",
"description" : "Update a Solace queue configuration template.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:update:*` ]",
"operationId" : "updateSolaceQueueConfigurationTemplate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the Solace queue configuration template.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The JSON schema that defines the Solace queue configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplate"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated solace queue configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplateResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServices/{id}/removeAssociation" : {
"put" : {
"tags" : [ "Messaging Services" ],
"summary" : "Remove an association between an messaging service and the requested entity",
"description" : "Use this API to remove the association between a messaging service and either of EVENT_MESH or EVENT_MANAGEMENT_AGENT.
Token Permissions: [ `modeled_event_broker:update:*` **or** `messaging_service:write` ]",
"operationId" : "removeAssociationMessagingService",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The association object with the value matching either EVENT_MESH or EVENT_MANAGEMENT_AGENT.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceRemoveAssociation"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated messaging service, e.g. if the API request body had {\"association\": \"EVENT_MESH\"} then the resulting object would not have eventMeshId attribute.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceQueues/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a specific queue configuration",
"description" : "Get a specific Solace event queue configuration for a consumer in an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceQueueConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the queue configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete a queue configuration",
"description" : "Delete a Solace event queue configuration for a consumer in an application. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceQueueConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the queue configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/runtimeManagement/applicationDeployments" : {
"post" : {
"tags" : [ "Application Deployments" ],
"summary" : "Create an application deployment",
"description" : "Create an application deployment to an event broker in a modeled event mesh. This action has two variants:\n\n1. `deploy` creates and updates an application's resources on an event broker in a modeled event mesh.\n\n2. `undeploy` detaches an application from an model event broker and cleans up all related resources.\n\nOnly one version of an application can be deployed on a model event broker at the same time.\n\nDeploying a different version of the same application behaves as an upgrade or downgrade of the application to the newly deployed version.\n\nFor environments with configuration push enabled and a connected operational event broker, deployments trigger configuration push jobs\non the operational event broker.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `modeled_event_broker:deploy:*` **and** `application:update:*` ]",
"operationId" : "createApplicationDeployment",
"requestBody" : {
"description" : "The application deployment request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDeployment"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDeploymentResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationPromotionRequests/{id}/promote" : {
"post" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Initiate promotion of an approved application promotion request",
"description" : "Promote a previously approved application promotion request. The promotion will be processed only if the request has an approved review.
Token Permissions: [ event_designer:access ]",
"operationId" : "promoteApplicationPromotionRequest",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the application promotion request to promote.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The promotion has been successfully submitted.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDeploymentResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductVersions/{versionId}/state" : {
"patch" : {
"tags" : [ "Event API Products" ],
"summary" : "Update the State of an Event API Product Version by ID",
"description" : "Use this API to update the state of an Event API Product version. You only need to specify the state ID field with the desired state ID.
Token Permissions: [ `event_api_product:update_state:*` ]",
"operationId" : "updateEventApiProductVersionState",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the Event API Product version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersion"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated state of the Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductVersions/{versionId}/publish" : {
"patch" : {
"tags" : [ "Event API Products" ],
"summary" : "Update an Event API Product Version To Be Published",
"description" : "Use this API to publish Event API Product version. Cannot unset once it is published.
Token Permissions: [ `event_api_product:update_state:*` ]",
"operationId" : "publishEventApiProductVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the Event API Product version.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventApiProductVersion"
}
}
}
},
"responses" : {
"200" : {
"description" : "Updated the state of the Event API Product version to Published.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StateChangeRequestResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientUsernames" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of client username configurations",
"description" : "Get a list of client username configurations for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceClientUsernameConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of client username configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve client username configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the client username configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve client username configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create a client username configuration",
"description" : "Create a client username configuration for event broker connections in an application in Event Portal.\n\nClient usernames are used by client applications to authenticate with Solace event brokers. A client username configuration\ndefines the credentials that your runtime application uses to connect to an event broker when the application is promoted\nto an environment in Event Portal. You associate a client profile and an ACL profile with an application by assigning the client\nprofile to the client username that the application uses to connect to the event broker.\n\n## Prerequisites\n\n- The application must already exist in Event Portal.\n- The API token must have appropriate token permissions.\n- The event broker must be configured and available.\n\n## Validation Rules\n\nThe request body schema enforces the following validation rules:\n\n**Client Username:**\n- Must be unique within the Message VPN\n- Can contain up to 189 printable ASCII characters (range 0x20 - 0x7e)\n- Case-sensitive\n- Must not contain question mark (?) or asterisk (*) characters\n\nPattern: `^[^\\?*\\x00-\\x1F\\x7F-\\xFF]+$`\n\n**Password:**\n- Must contain 1 to 128 non-null characters\n- Must not contain the following special characters: :()\";'<>,`&|\n- Encrypted using one-way encryption before being saved\n\nPattern: ```^[^:()\";'<>,`\\&|]+$```\n\n**Important Notes:**\n- If internal authentication is enabled but no password is assigned to a client username, authentication will fail.\n- Changing a password does not affect connections that were already authenticated using the old password.\n- Client usernames are specific to a Message VPN and may be used to make multiple client connections, which allows\n applications to horizontally scale without additional configuration on the event broker.\n\nFor more information, see:\n- [Client Usernames on Operational Event Brokers](https://docs.solace.com/Cloud/client-profiles.htm)\n- [Creating Runtime Configuration using the Event Portal UI\n](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-standard.htm#adding-runtime-configuration-to-a-standard-application)\n- [Configuring Event Brokers in Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-config.htm)\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceClientUsernameConfiguration",
"requestBody" : {
"description" : "The client username configuration for Solace event brokers",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration",
"example" : {
"contextId" : "eventbrokerID123",
"contextType" : "EVENT_BROKER",
"entityId" : "applicationID123",
"value" : {
"clientUsername" : "myapp-client-user",
"password" : "SecureP@ssw0rd"
}
}
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration",
"example" : {
"data" : {
"createdTime" : "2026-02-11T18:53:40.681Z",
"updatedTime" : "2026-02-11T18:53:40.681Z",
"createdBy" : "rmsyat7v6ac",
"changedBy" : "rmsyat7v6ac",
"id" : "dxr11w32g4h",
"contextType" : "EVENT_BROKER",
"contextId" : "73763gw33t9",
"configurationTypeId" : "solaceClientUsername",
"entityType" : "application",
"entityId" : "49u1vd8yx1o",
"identifier" : "myapp-client-username",
"resolvedValue" : {
"password" : "",
"clientUsername" : "myapp-client-username"
},
"value" : {
"password" : "",
"clientUsername" : "myapp-client-username"
},
"refreshResolvedValue" : false,
"type" : "configuration",
"workInProgress" : false
}
}
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventManagementAgents/{id}/configuration/raw" : {
"get" : {
"tags" : [ "Event Management Agents" ],
"summary" : "Get the raw configs in string format for an EMA object",
"description" : "Use this API to get the raw configs for a single EMA by its ID.
Token Permissions: [ event_management_agent:read ]",
"operationId" : "getEventManagementAgentConfigRaw",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the EMA object.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "configFileType",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string",
"default" : "connected",
"enum" : [ "connected", "standalone" ]
}
} ],
"responses" : {
"200" : {
"description" : "The EMA config in yaml structure.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServiceScans/{scanId}/dataCollection" : {
"get" : {
"tags" : [ "Messaging Service Scan Data" ],
"summary" : "Get a list of messaging service scan data",
"description" : "Use this API to get a list of messaging service scan data that match the given parameters.
Token Permissions: [ messaging_service_scan:read ]",
"operationId" : "getMessagingServiceScansData",
"parameters" : [ {
"name" : "scanId",
"in" : "path",
"description" : "The ID of the messaging service scan we want data for.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The number of messaging service scan data to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The name of the field to sort on.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The IDs of the messaging service scan data.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "collectionTypes",
"in" : "query",
"description" : "Match only scan data whose dataCollectionType matches the given list.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "brokerConfiguration", "clusterConfiguration", "consumerGroups", "consumerGroupConfiguration", "overrideTopicConfiguration", "queueConfiguration", "queueListing", "schema", "subscriptionConfiguration", "topicConfiguration", "topicListing" ]
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "The list of messaging service scan data and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceScanDataListResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiVersions/{eventApiVersionId}/asyncApi" : {
"get" : {
"tags" : [ "Event APIs" ],
"summary" : "Get the AsyncAPI Specification for an Event API Version",
"description" : "Use this API to get the AsyncAPI specification for an event API version annotated with Event Portal metadata.\nDeprecation Date: 2025-01-20\nRemoval Date: 2026-01-20\nReason: Replaced by /eventApiVersions/{eventApiVersionId}/exports/asyncAPI
Token Permissions: [ `event_api:generate_async_api:*` ]",
"operationId" : "getAsyncApiForEventApiVersion",
"parameters" : [ {
"name" : "eventApiVersionId",
"in" : "path",
"description" : "The ID of the event API version.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "showVersioning",
"in" : "query",
"description" : "Include versions in each AsyncAPI object's name when only one version is present",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : false
}
}, {
"name" : "format",
"in" : "query",
"description" : "The format in which to get the AsyncAPI specification. Possible values are yaml and json.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "json",
"enum" : [ "json", "yaml" ]
}
}, {
"name" : "includedExtensions",
"in" : "query",
"description" : "The event portal database keys to include for each AsyncAPI object.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "all",
"enum" : [ "all", "parent", "version", "none" ]
}
}, {
"name" : "asyncApiVersion",
"in" : "query",
"description" : "The version of AsyncAPI to use.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "2.5.0",
"enum" : [ "2.0.0", "2.2.0", "2.5.0" ]
}
}, {
"name" : "eventApiProductVersionId",
"in" : "query",
"description" : "The ID of the event API Product Version to use for generating bindings.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "query",
"description" : "The ID of the plan to use for generating bindings.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "gatewayMessagingServiceIds",
"in" : "query",
"description" : "The list IDs of gateway messaging services for generating bindings.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
} ],
"responses" : {
"200" : {
"description" : "The AsyncAPI specification for the event API version.",
"content" : {
"application/json" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"ynlqV\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n },\n \"channels\": {\n \"solace/cloud/{category_0_1_0}/color\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"aak9yd6ccsb\",\n \"x-ep-event-version-id\": \"kqa6oduarqp\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.1\",\n \"x-ep-event-name\": \"RegistrationEventX\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n \"parameters\": {\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"solace/cloud/{category_0_1_0}/{category_0_2_0}\": {\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"0mht953vzmc\",\n \"x-ep-event-version-id\": \"lo38jbd8bud\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.2\",\n \"x-ep-event-name\": \"RegistrationEventY\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"parameters\": {\n \"category_0_2_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.2.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"4gjsah95kts\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n }\n },\n \"asyncapi\": \"2.5.0\",\n \"info\": {\n \"x-ep-event-api-version\": \"0.0.1\",\n \"x-ep-event-api-id\": \"pghiko8xqgo\",\n \"x-ep-displayname\": \"my event api version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myEventApi\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-event-api-version-id\": \"gl1kllq6hb7\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-shared\": \"true\"\n }\n}"
},
"text/plain" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"ynlqV\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n },\n \"channels\": {\n \"solace/cloud/{category_0_1_0}/color\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"aak9yd6ccsb\",\n \"x-ep-event-version-id\": \"kqa6oduarqp\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.1\",\n \"x-ep-event-name\": \"RegistrationEventX\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n \"parameters\": {\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"solace/cloud/{category_0_1_0}/{category_0_2_0}\": {\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"0mht953vzmc\",\n \"x-ep-event-version-id\": \"lo38jbd8bud\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.2\",\n \"x-ep-event-name\": \"RegistrationEventY\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"parameters\": {\n \"category_0_2_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.2.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"4gjsah95kts\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n }\n },\n \"asyncapi\": \"2.5.0\",\n \"info\": {\n \"x-ep-event-api-version\": \"0.0.1\",\n \"x-ep-event-api-id\": \"pghiko8xqgo\",\n \"x-ep-displayname\": \"my event api version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myEventApi\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-event-api-version-id\": \"gl1kllq6hb7\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-shared\": \"true\"\n }\n}"
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationPromotionRequestReviews/{reviewId}" : {
"delete" : {
"tags" : [ "Application Promotion Requests" ],
"summary" : "(EA) Delete a review for an application promotion request",
"description" : "Use this API to delete a review for an application promotion request. Only the author of a review can delete it.
Token Permissions: [ `promotion_request_review:delete:*` ]",
"operationId" : "deleteApplicationPromotionRequestReview",
"parameters" : [ {
"name" : "reviewId",
"in" : "path",
"description" : "The ID of the review to delete.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "The review was successfully deleted."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/configurationTemplate/solaceClientProfileNames" : {
"get" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Get a list of client profile name configuration templates",
"description" : "Get a list of client profile name configuration templates that match the specified parameters.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceClientProfileNameConfigurationTemplates",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of client profile name configuration templates to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the client profile name configuration templates to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "name",
"in" : "query",
"description" : "The name of the client profile name configuration template to match.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of solace client profile name configuration templates and the accompanying metadata.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceClientProfileNameConfigurationTemplatesResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Create a client profile name configuration template",
"description" : "Create a client profile name configuration template to provide the client profile name for an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:create:*` ]",
"operationId" : "createSolaceClientProfileNameConfigurationTemplate",
"requestBody" : {
"description" : "The JSON schema that defines the client profile name configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceClientProfileName"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "The created solace client profile name configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceClientProfileNameConfigurationTemplateResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/runtimeManagement/applicationDeploymentPreviews" : {
"post" : {
"tags" : [ "Application Deployments" ],
"summary" : "(EA) Create a preview of the application deployment",
"description" : "Create a preview of the resulting changes in an application's event broker resources for the specified deployment action.\nThe preview is provided in the data/requested section of the response.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application_deployment_preview:create:*` **and** `application:get:*` ]",
"operationId" : "createApplicationChangeRequestPreview",
"requestBody" : {
"description" : "The application deployment request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDeployment"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationDeploymentPreviewResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPoints" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point configurations",
"description" : "Get a list of Solace rest delivery point configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point configuration",
"description" : "Create a Solace rest delivery point configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointConfiguration",
"requestBody" : {
"description" : "The rest delivery point configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientProfileNames" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of client profile name configurations",
"description" : "Get a list of client profile name configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceClientProfileNameConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of client profile name configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve client profile name configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the client profile name configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve client profile name configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create a client profile name configuration",
"description" : "Create a client profile name configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceClientProfileNameConfiguration",
"requestBody" : {
"description" : "The client profile name configuration for a Solace event broker.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServices/{messagingServiceId}/scanStart" : {
"put" : {
"tags" : [ "Messaging Services" ],
"summary" : "Initiate a scan request to run against a messaging service",
"description" : "Use this API to make a scan request on a messaging service.
Token Permissions: [ `modeled_event_broker:update:*` **or** `messaging_service:write` ]",
"operationId" : "scanStartMessagingService",
"parameters" : [ {
"name" : "messagingServiceId",
"in" : "path",
"description" : "The ID of the messaging service.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The messaging service.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceOperation"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Requested a scan on the messaging service. The operation object with ID set as ID of the created scan Object is returned in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceOperationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceAuthorizationGroups" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of LDAP authorization group configurations",
"description" : "Get a list of LDAP authorization group configurations for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceAuthorizationGroups",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of LDAP authorization group configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve authorization group configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the authorization group configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve authorization group configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create an LDAP authorization group configuration",
"description" : "Create an LDAP authorization group configuration for event broker connections in an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceAuthorizationGroup",
"requestBody" : {
"description" : "The LDAP authorization group configuration for a Solace event broker.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientUsernames/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a specific client username configuration",
"description" : "Get a specific client username configuration for event broker connections from an application in Event Portal.\n\nUse this endpoint to retrieve the details of a client username configuration, including the client username, associated\nevent broker, and the application (entity) it belongs to. This is useful for:\n- Verifying configuration details before promoting an application to an environment\n- Auditing existing client username configurations\n- Retrieving configuration IDs for update or delete operations\n\n**Note:** For security reasons, password values are not returned in the response. Only the configuration metadata\nand client username are included.\n\nFor more information about client usernames, see:\n- [Client Usernames on Operational Event Brokers](https://docs.solace.com/Cloud/client-profiles.htm)\n- [Creating Runtime Configuration using the Event Portal UI\n](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-standard.htm#adding-runtime-configuration-to-a-standard-application)\n- [Configuring Event Brokers in Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-config.htm)\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceClientUsernameConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client username configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete a client username configuration",
"description" : "Delete a client username configuration for event broker connections from an application in Event Portal. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceClientUsernameConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client username configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{versionId}/messagingServices" : {
"put" : {
"tags" : [ "Applications" ],
"summary" : "Replace messaging service association for an application version",
"description" : "Use this API to replace the messaging service association for an application version.
Token Permissions: [ event_runtime:write ]",
"operationId" : "updateMsgSvcAssociationForAppVersion",
"parameters" : [ {
"name" : "versionId",
"in" : "path",
"description" : "The ID of the application version",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The messaging service association object",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceAssociationDTO"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated messaging service associations.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceAssociationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductMemAssociations/{memAssociationId}" : {
"delete" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Version by Association ID",
"description" : "Use this API to disassociate an Event API Product version and gateway messaging service by association ID.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "disassociateGatewayMessagingServiceFromEventApiProductVersionById",
"parameters" : [ {
"name" : "memAssociationId",
"in" : "path",
"description" : "The association ID to perform the disassociation for.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/messagingServiceScans/{scanId}/dataCollection/{id}" : {
"get" : {
"tags" : [ "Messaging Service Scan Data" ],
"summary" : "Get a messaging service scan data",
"description" : "Use this API to get a single messaging service scan data by its ID.
Token Permissions: [ messaging_service_scan:read ]",
"operationId" : "getMessagingServiceScanData",
"parameters" : [ {
"name" : "scanId",
"in" : "path",
"description" : "The ID of the messaging service scan.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The ID of the messaging service scan data.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The messaging service scan data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MessagingServiceScanDataResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/configurationTemplate/solaceClientProfileNames/{id}" : {
"get" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Get a specific client profile name configuration template",
"description" : "Get a client profile name configuration template by its identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:get:*` ]",
"operationId" : "getSolaceClientProfileNameConfigurationTemplate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client profile name configuration template.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The solace client profile name configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceClientProfileNameConfigurationTemplateResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Delete a client profile name configuration template",
"description" : "Delete a client profile name configuration template.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:delete:*` ]",
"operationId" : "deleteSolaceClientProfileNameConfigurationTemplate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client profile name configuration template.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Configuration Templates" ],
"summary" : "(EA) Update a client profile name configuration template",
"description" : "Update a client profile name configuration template.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:update:*` ]",
"operationId" : "updateSolaceClientProfileNameConfigurationTemplate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client profile name configuration template.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The JSON schema that defines the client profile name configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceClientProfileName"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated solace client profile name configuration template.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SolaceClientProfileNameConfigurationTemplateResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{applicationVersionId}/asyncApi" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "Get the AsyncAPI specification for an application version",
"description" : "Use this API to get the AsyncAPI specification for an application version annotated with Event Portal metadata.\nDeprecation Date: 2025-01-20\nRemoval Date: 2026-01-20\nReason: Replaced by /applicationVersions/{applicationVersionId}/exports/asyncAPI
Token Permissions: [ application:generate_async_api:* ]",
"operationId" : "getAsyncApiForApplicationVersion",
"parameters" : [ {
"name" : "applicationVersionId",
"in" : "path",
"description" : "The ID of the application version.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "format",
"in" : "query",
"description" : "The format in which to get the AsyncAPI specification. Possible values are yaml and json.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "json",
"enum" : [ "json", "yaml" ]
}
}, {
"name" : "showVersioning",
"in" : "query",
"description" : "Include versions in each AsyncAPI object's name when only one version is present",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : false
}
}, {
"name" : "includedExtensions",
"in" : "query",
"description" : "The event portal database keys to include for each AsyncAPI object.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "all",
"enum" : [ "all", "parent", "version", "none" ]
}
}, {
"name" : "asyncApiVersion",
"in" : "query",
"description" : "The version of AsyncAPI to use.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "2.5.0",
"enum" : [ "2.0.0", "2.2.0", "2.5.0" ]
}
}, {
"name" : "environmentOptions",
"in" : "query",
"description" : "Determines whether bindings are applied to declared subscribed events or\npublished subscribed events in the event mesh or both.\n
Replacement: Use expand instead.\n
Reason: The change is to allow for increased flexibility of the API.\n
Removal Date: 2025-09-20 18:00:00.000.\n",
"required" : false,
"deprecated" : true,
"schema" : {
"type" : "string",
"default" : "include_attracted_events_only",
"enum" : [ "include_declared_and_attracted_events", "include_attracted_events_only" ]
}
}, {
"name" : "messagingServiceId",
"in" : "query",
"description" : "Applies bindings from attracted events that are published in this messaging service's modeled event mesh.\n
Replacement: Use contextId with contextType instead.\n
Reason: The change is to allow for increased flexibility of the API.\n
Removal Date: 2025-09-20 18:00:00.000.\n",
"required" : false,
"deprecated" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "expand",
"in" : "query",
"description" : "A comma separated list of sections of the asyncapi document to include.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "declaredSubscribedEvents", "attractedEvents", "servers", "serverBindings", "declaredSubscribedEventBindings", "attractedEventBindings" ]
},
"example" : "declaredSubscribedEvents"
}, {
"name" : "contextId",
"in" : "query",
"description" : "Applies bindings from subscribed events that are published in this event broker or event mesh.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "contextType",
"in" : "query",
"description" : "The context of which events are attracted from.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "eventBroker", "eventMesh" ]
}
} ],
"responses" : {
"200" : {
"description" : "The AsyncAPI specification for the application version.",
"content" : {
"application/json" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"GZYU7_0_0_2\": {\n \"x-ep-schema-version\": \"0.0.2\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-version-id\": \"iifjj2tntyz\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"Age\": \"2\",\n \"x-ep-schema-version-displayname\": \"3mUFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"GZYU7_0_0_1\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"z8gmecsxs7c\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"1pR5c\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"messages\": {\n \"RegistrationEvent_0_1_0\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"channels\": {\n \"corp/billing/accoun#ts\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"1v08b82msv8\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_2\"\n },\n \"x-ep-event-version\": \"0.2.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n }\n }\n },\n \"asyncapi\": \"2.0.0\",\n \"info\": {\n \"x-ep-application-version\": \"0.0.1\",\n \"x-ep-application-version-id\": \"9i8d1cikx8o\",\n \"x-ep-application-id\": \"7aegxzxtraw\",\n \"x-ep-displayname\": \"my application version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myApplication\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n}"
},
"text/plain" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"GZYU7_0_0_2\": {\n \"x-ep-schema-version\": \"0.0.2\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-version-id\": \"iifjj2tntyz\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"Age\": \"2\",\n \"x-ep-schema-version-displayname\": \"3mUFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"GZYU7_0_0_1\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"z8gmecsxs7c\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"1pR5c\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"messages\": {\n \"RegistrationEvent_0_1_0\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"channels\": {\n \"corp/billing/accoun#ts\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"1v08b82msv8\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_2\"\n },\n \"x-ep-event-version\": \"0.2.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n }\n }\n },\n \"asyncapi\": \"2.0.0\",\n \"info\": {\n \"x-ep-application-version\": \"0.0.1\",\n \"x-ep-application-version-id\": \"9i8d1cikx8o\",\n \"x-ep-application-id\": \"7aegxzxtraw\",\n \"x-ep-displayname\": \"my application version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myApplication\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n}"
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPoints/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point configuration",
"description" : "Get a specific Solace rest delivery point configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point configuration",
"description" : "Update a Solace rest delivery point configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the rest delivery point configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point configuration",
"description" : "Delete a Solace rest delivery point configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientProfileNames/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a specific client profile name configuration",
"description" : "Get a specific client profile name configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceClientProfileNameConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client profile name configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete a client profile name configuration",
"description" : "Delete a client profile name configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceClientProfileNameConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client profile name configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAwsS3s" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Aws S3 configurations",
"description" : "Get a list of Solace rest delivery point Aws S3 configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointAwsConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Aws S3 configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Aws S3 configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Aws S3 configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Aws S3 configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Aws S3 configuration",
"description" : "Create a Solace rest delivery point Aws S3 configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointAwsConfiguration",
"requestBody" : {
"description" : "The rest delivery point Aws S3 configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceAuthorizationGroups/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a specific LDAP authorization group configuration",
"description" : "Get a specific LDAP authorization group configuration for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceAuthorizationGroup",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the LDAP authorization group configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete an LDAP authorization group configuration",
"description" : "Delete an LDAP authorization group configuration for event broker connections from an application in Event Portal.\nYou can’t undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceAuthorizationGroup",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the LDAP authorization group configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientUsernameReferences" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of client username reference configurations",
"description" : "Get a list of client username reference configurations for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceClientUsernameReferenceConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of client username Reference configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve client username reference configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the client username reference configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve client username configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create a client username reference configuration",
"description" : "Create an client username configuration for event broker connections in an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceClientUsernameReferenceConfiguration",
"requestBody" : {
"description" : "The client username reference configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiVersions/{eventApiVersionId}/exports/asyncApi" : {
"get" : {
"tags" : [ "Event APIs" ],
"summary" : "Get the AsyncAPI Specification for an Event API Version",
"description" : "Use this API to get the AsyncAPI specification for an event API version annotated with Event Portal metadata.
Token Permissions: [ `event_api:generate_async_api:*` ]",
"operationId" : "getCompleteAsyncApiForEventApiVersion",
"parameters" : [ {
"name" : "eventApiVersionId",
"in" : "path",
"description" : "The ID of the event API version.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "format",
"in" : "query",
"description" : "The format in which to get the AsyncAPI specification. Possible values are yaml and json.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "json",
"enum" : [ "json", "yaml" ]
}
}, {
"name" : "includedExtensions",
"in" : "query",
"description" : "The event portal database keys to include for each AsyncAPI object.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "all",
"enum" : [ "all", "parent", "version", "none" ]
}
}, {
"name" : "asyncApiVersion",
"in" : "query",
"description" : "The version of AsyncAPI to use.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "2.5.0",
"enum" : [ "2.0.0", "2.2.0", "2.5.0" ]
}
}, {
"name" : "eventApiProductVersionId",
"in" : "query",
"description" : "The ID of the event API Product Version to use for generating bindings.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "query",
"description" : "The ID of the plan to use for generating bindings.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "gatewayMessagingServiceIds",
"in" : "query",
"description" : "The list IDs of gateway messaging services for generating bindings.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}, {
"name" : "namingStrategies",
"in" : "query",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "applicationDomainPrefix", "majorVersionSuffix" ]
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "The AsyncAPI specification for the event API version.",
"content" : {
"application/json" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"ynlqV\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n },\n \"channels\": {\n \"solace/cloud/{category_0_1_0}/color\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"aak9yd6ccsb\",\n \"x-ep-event-version-id\": \"kqa6oduarqp\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.1\",\n \"x-ep-event-name\": \"RegistrationEventX\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n \"parameters\": {\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"solace/cloud/{category_0_1_0}/{category_0_2_0}\": {\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"0mht953vzmc\",\n \"x-ep-event-version-id\": \"lo38jbd8bud\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.2\",\n \"x-ep-event-name\": \"RegistrationEventY\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"parameters\": {\n \"category_0_2_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.2.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"4gjsah95kts\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n }\n },\n \"asyncapi\": \"2.5.0\",\n \"info\": {\n \"x-ep-event-api-version\": \"0.0.1\",\n \"x-ep-event-api-id\": \"pghiko8xqgo\",\n \"x-ep-displayname\": \"my event api version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myEventApi\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-event-api-version-id\": \"gl1kllq6hb7\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-shared\": \"true\"\n }\n}"
},
"text/plain" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"ynlqV\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n },\n \"channels\": {\n \"solace/cloud/{category_0_1_0}/color\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"aak9yd6ccsb\",\n \"x-ep-event-version-id\": \"kqa6oduarqp\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.1\",\n \"x-ep-event-name\": \"RegistrationEventX\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n \"parameters\": {\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"solace/cloud/{category_0_1_0}/{category_0_2_0}\": {\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"0mht953vzmc\",\n \"x-ep-event-version-id\": \"lo38jbd8bud\",\n \"payload\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"d024effaos6\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"ynlqV\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"ndZll\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"m6h3ic4f5l1\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"x-ep-event-version\": \"0.0.2\",\n \"x-ep-event-name\": \"RegistrationEventY\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"parameters\": {\n \"category_0_2_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.2.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"4gjsah95kts\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"category_0_1_0\": {\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\"\n ]\n },\n \"x-ep-enum-version-displayname\": \"Big Sur\",\n \"x-ep-enum-version\": \"0.1.0\",\n \"x-ep-enum-name\": \"w8yaL\",\n \"x-ep-enum-state-id\": \"1\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-enum-version-id\": \"71jco7kfh3r\",\n \"x-ep-enum-id\": \"aakggw2fnc7\",\n \"x-ep-shared\": \"true\",\n \"x-ep-parameter-name\": \"category\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n }\n },\n \"asyncapi\": \"2.5.0\",\n \"info\": {\n \"x-ep-event-api-version\": \"0.0.1\",\n \"x-ep-event-api-id\": \"pghiko8xqgo\",\n \"x-ep-displayname\": \"my event api version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myEventApi\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-event-api-version-id\": \"gl1kllq6hb7\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-shared\": \"true\"\n }\n}"
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientCertificateUsernames" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of client certificate username configurations",
"description" : "Get a list of client certificate username configurations for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceClientCertificateUsernameConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of client certificate username configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve client certificate username configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the client certificate username configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve client certificate username configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create a client certificate username configuration",
"description" : "Create an client certificate username configuration for event broker connections in an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceClientCertificateUsernameConfiguration",
"requestBody" : {
"description" : "The client certificate username configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAwsS3s/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Aws S3 configuration",
"description" : "Get a specific Solace rest delivery point Aws S3 configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointAwsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Aws S3 configuration",
"description" : "Update a Solace rest delivery point Aws S3 configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointAwsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Aws S3 configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Aws S3 configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Aws S3 configuration",
"description" : "Delete a Solace rest delivery point Aws S3 configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointAwsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Aws S3 configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/microIntegrationFlowConfigurations" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a list of micro integration flow configurations",
"description" : "Get a list of micro integration flow configurations for applications in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getMicroIntegrationFlowConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of micro integration flow configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve micro integration flow configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the micro integration flow configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve micro integration flow configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Create a micro integration flow configuration",
"description" : "Create a micro integration flow configuration for an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createMicroIntegrationFlowConfiguration",
"requestBody" : {
"description" : "The micro integration flow configuration.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/runtimeManagement/applications/{id}/configurationPushJobs" : {
"get" : {
"tags" : [ "Application Configuration Push Job" ],
"summary" : "Get a list of configuration push jobs by application identifier",
"description" : "Get a list of configuration push jobs that match the specified application identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "listApplicationConfigPushJobs",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the application.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The number of configuration push jobs to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "changeRecordIds",
"in" : "query",
"description" : "The unique identifiers of the change record, separated by commas, to retrieve configuration push jobs from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "statuses",
"in" : "query",
"description" : "The statuses, separated by commas, of the configuration push jobs to retrieve.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationConfigPushJobsResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientUsernameReferences/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a specific client username reference configuration",
"description" : "Get a specific client username reference configuration for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceClientUsernameReferenceConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client username reference configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete a client username reference configuration",
"description" : "Delete an client username configuration for event broker connections from an application in Event Portal. You can’t undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceClientUsernameReferenceConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client username reference configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointQueueBindings" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point queue binding configurations",
"description" : "Get a list of Solace rest delivery point queue binding configurations for a consumer in an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointQueueBindingConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point queue binding configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point queue binding configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point queue binding configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point queue binding configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point queue binding configuration",
"description" : "Create a Solace rest delivery point queue binding configuration for a consumer in an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointQueueBindingConfiguration",
"requestBody" : {
"description" : "The rest delivery point queue binding configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{applicationVersionId}/exports/asyncApi" : {
"get" : {
"tags" : [ "Applications" ],
"summary" : "Get the AsyncAPI specification for an application version",
"description" : "Use this API to get the AsyncAPI specification for an application version annotated with Event Portal metadata.
Token Permissions: [ application:generate_async_api:* ]",
"operationId" : "getCompleteAsyncApiForApplicationVersion",
"parameters" : [ {
"name" : "applicationVersionId",
"in" : "path",
"description" : "The ID of the application version.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "format",
"in" : "query",
"description" : "The format in which to get the AsyncAPI specification. Possible values are yaml and json.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "json",
"enum" : [ "json", "yaml" ]
}
}, {
"name" : "includedExtensions",
"in" : "query",
"description" : "The event portal database keys to include for each AsyncAPI object.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "all",
"enum" : [ "all", "parent", "version", "none" ]
}
}, {
"name" : "asyncApiVersion",
"in" : "query",
"description" : "The version of AsyncAPI to use.",
"required" : false,
"schema" : {
"type" : "string",
"default" : "2.5.0",
"enum" : [ "2.0.0", "2.2.0", "2.5.0" ]
}
}, {
"name" : "expand",
"in" : "query",
"description" : "A comma separated list of sections of the asyncapi document to include.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "declaredSubscribedEvents", "attractedEvents", "servers", "serverBindings", "declaredSubscribedEventBindings", "attractedEventBindings" ]
},
"example" : "declaredSubscribedEvents"
}, {
"name" : "contextId",
"in" : "query",
"description" : "Applies bindings from subscribed events that are published in this event broker or event mesh.",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "contextType",
"in" : "query",
"description" : "The context of which events are attracted from.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "eventBroker", "eventMesh" ]
}
}, {
"name" : "namingStrategies",
"in" : "query",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "applicationDomainPrefix", "majorVersionSuffix" ]
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "The AsyncAPI specification for the application version.",
"content" : {
"application/json" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"GZYU7_0_0_2\": {\n \"x-ep-schema-version\": \"0.0.2\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-version-id\": \"iifjj2tntyz\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"Age\": \"2\",\n \"x-ep-schema-version-displayname\": \"3mUFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"GZYU7_0_0_1\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"z8gmecsxs7c\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"1pR5c\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"messages\": {\n \"RegistrationEvent_0_1_0\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"channels\": {\n \"corp/billing/accoun#ts\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"1v08b82msv8\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_2\"\n },\n \"x-ep-event-version\": \"0.2.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n }\n }\n },\n \"asyncapi\": \"2.0.0\",\n \"info\": {\n \"x-ep-application-version\": \"0.0.1\",\n \"x-ep-application-version-id\": \"9i8d1cikx8o\",\n \"x-ep-application-id\": \"7aegxzxtraw\",\n \"x-ep-displayname\": \"my application version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myApplication\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n}"
},
"text/plain" : {
"schema" : {
"type" : "string"
},
"example" : "{\n \"components\": {\n \"schemas\": {\n \"GZYU7_0_0_2\": {\n \"x-ep-schema-version\": \"0.0.2\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-version-id\": \"iifjj2tntyz\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"Age\": \"2\",\n \"x-ep-schema-version-displayname\": \"3mUFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n \"GZYU7_0_0_1\": {\n \"x-ep-schema-version\": \"0.0.1\",\n \"x-ep-schema-version-id\": \"z8gmecsxs7c\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"x-ep-schema-state-name\": \"DRAFT\",\n \"x-ep-schema-name\": \"GZYU7\",\n \"title\": \"Person\",\n \"type\": \"object\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"x-ep-schema-version-displayname\": \"1pR5c\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\",\n \"x-ep-schema-state-id\": \"1\",\n \"x-ep-schema-id\": \"diw618f6hit\",\n \"properties\": {\n \"firstName\": {\n \"description\": \"The person's first name.\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"description\": \"The person's last name.\",\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years which must be equal to or greater than zero.\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"$id\": \"https://example.com/person.schema.json\"\n }\n },\n \"messages\": {\n \"RegistrationEvent_0_1_0\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n }\n },\n \"channels\": {\n \"corp/billing/accoun#ts\": {\n \"subscribe\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"yn8evv7wfve\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_1\"\n },\n \"x-ep-event-version\": \"0.1.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n },\n \"publish\": {\n \"message\": {\n \"x-ep-event-id\": \"8k62hfhhaqx\",\n \"x-ep-event-version-id\": \"1v08b82msv8\",\n \"payload\": {\n \"$ref\": \"#/components/schemas/GZYU7_0_0_2\"\n },\n \"x-ep-event-version\": \"0.2.0\",\n \"x-ep-event-name\": \"RegistrationEvent\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"schemaFormat\": \"application/vnd.aai.asyncapi+json;version=2.0.0\",\n \"contentType\": \"application/json\",\n \"x-ep-event-state-id\": \"1\",\n \"x-ep-event-state-name\": \"DRAFT\",\n \"x-ep-shared\": \"false\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n },\n }\n }\n },\n \"asyncapi\": \"2.0.0\",\n \"info\": {\n \"x-ep-application-version\": \"0.0.1\",\n \"x-ep-application-version-id\": \"9i8d1cikx8o\",\n \"x-ep-application-id\": \"7aegxzxtraw\",\n \"x-ep-displayname\": \"my application version\",\n \"x-ep-state-name\": \"DRAFT\",\n \"title\": \"myApplication\",\n \"x-ep-application-domain-id\": \"defaultDomain\",\n \"version\": \"0.0.1\",\n \"x-ep-state-id\": \"1\",\n \"x-ep-application-domain-name\": \"defaultDomainName\"\n }\n}"
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceClientCertificateUsernames/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Get a specific client certificate username configuration",
"description" : "Get a specific client certificate username configuration for event broker connections from an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceClientCertificateUsernameConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client certificate username configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete a client certificate username configuration",
"description" : "Delete an client certificate username configuration for event broker connections from an application in Event Portal.\nYou can’t undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceClientCertificateUsernameConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the client certificate username configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureFunctions" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Azure Functions configurations",
"description" : "Get a list of Solace rest delivery point Azure Functions configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointAzureFunctionsConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Azure Functions configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Azure Functions configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Azure Functions configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Azure Functions configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Azure Functions configuration",
"description" : "Create a Solace rest delivery point Azure Functions configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointAzureFunctionsConfiguration",
"requestBody" : {
"description" : "The rest delivery point Azure Functions configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureEventHubs" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Azure Event Hubs configurations",
"description" : "Get a list of Solace rest delivery point Azure Event Hubs configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointAzureEventHubsConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Azure Event Hubs configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Azure Event Hubs configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Azure Event Hubs configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Azure Event Hubs configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Azure Event Hubs configuration",
"description" : "Create a Solace rest delivery point Azure Event Hubs configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointAzureEventHubsConfiguration",
"requestBody" : {
"description" : "The rest delivery point Azure Event Hubs configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAwsApiGateways" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point AWS API Gateway configurations",
"description" : "Get a list of Solace rest delivery point AWS API Gateway configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointAwsApiGatewayConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point AWS API Gateway configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point AWS API Gateway configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point AWS API Gateway configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point AWS API Gateway configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point AWS API Gateway configuration",
"description" : "Create a Solace rest delivery point AWS API Gateway configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointAwsApiGatewayConfiguration",
"requestBody" : {
"description" : "The rest delivery point AWS API Gateway configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointGoogleCloudRuns" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Google Cloud Run configurations",
"description" : "Get a list of Solace rest delivery point Google Cloud Run configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointGoogleCloudRunConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Google Cloud Run configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Google Cloud Run configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Google Cloud Run configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Google Cloud Run configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Google Cloud Run configuration",
"description" : "Create a Solace rest delivery point Google Cloud Run configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointGoogleCloudRunConfiguration",
"requestBody" : {
"description" : "The rest delivery point Google Cloud Run configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/microIntegrationFlowConfigurations/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(EA) Get a specific micro integration flow configuration",
"description" : "Get a specific micro integration flow configuration for an application in Event Portal.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getMicroIntegrationFlowConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the micro integration flow configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "Delete a micro integration flow configuration",
"description" : "Delete a micro integration flow configuration for an application in Event Portal.\nYou can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteMicroIntegrationFlowConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the micro integration flow configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/runtimeManagement/applicationConfigurationPushJobs/{jobId}/run" : {
"post" : {
"tags" : [ "Application Configuration Push Job" ],
"summary" : "(Beta) Run a configuration push job",
"description" : "Run an existing configuration push job by its identifier. The job's target environment must have the `onDemand` config push mode.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application_configuration_push_job:run:*` ]",
"operationId" : "runApplicationConfigPushJob",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The unique identifier of the configuration push job.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationConfigPushJobResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{applicationVersionId}/eventAccessRequests" : {
"get" : {
"tags" : [ "Application Version Event Access Requests" ],
"summary" : "(EA) Get event access requests by application version id",
"description" : "Get event access requests by application version id
Token Permissions: [ `application:get:*` ]",
"operationId" : "getApplicationVersionEventAccessRequests",
"parameters" : [ {
"name" : "applicationVersionId",
"in" : "path",
"description" : "The application version id to get requests for",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "reviewStatuses",
"in" : "query",
"description" : "Get requests with the given review statuses",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of existing event access requests for an application version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersionEventAccessRequestsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Application Version Event Access Requests" ],
"summary" : "(EA) Create missing event access requests for application version id and send notifications to reviewers",
"description" : "Create missing event access requests for application version id and send notifications to reviewers
Token Permissions: [ `application:update:*` **and** `event_access_request:create:*` ]",
"operationId" : "createApplicationVersionEventAccessRequests",
"parameters" : [ {
"name" : "applicationVersionId",
"in" : "path",
"description" : "The application version id to create and send requests for",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"201" : {
"description" : "Created a list of event access requests. Returns the newly saved event access requests in the response body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EventAccessRequestListResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureServiceBuses" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Azure Service Bus configurations",
"description" : "Get a list of Solace rest delivery point Azure Service Bus configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointAzureServiceBusConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Azure Service Bus configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Azure Service Bus configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Azure Service Bus configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Azure Service Bus configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Azure Service Bus configuration",
"description" : "Create a Solace rest delivery point Azure Service Bus configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointAzureServiceBusConfiguration",
"requestBody" : {
"description" : "The rest delivery point Azure Service Bus configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointQueueBindings/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point queue binding configuration",
"description" : "Get a specific Solace rest delivery point queue binding configuration for a consumer in an application.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointQueueBindingConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point queue binding configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a queue binding configuration",
"description" : "Update a Solace event queue binding configuration for a consumer in a rest delivery point.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceQueueBindingConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the queue configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The queue binding configuration object.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The updated configuration object.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point queue binding configuration",
"description" : "Delete a Solace rest delivery point queue binding configuration for a consumer in an application. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointQueueBindingConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point queue binding configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/runtimeManagement/applicationConfigurationPushJobs/{jobId}/status" : {
"put" : {
"tags" : [ "Application Configuration Push Job" ],
"summary" : "(Beta) Update the status of a configuration push job",
"description" : "Update the status of an existing configuration push job by its identifier.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application_configuration_push_job:update_status:*` ]",
"operationId" : "patchApplicationConfigPushJobStatus",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The unique identifier of the configuration push job.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigPushJobStatusUpdateRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationConfigPushJobResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureFunctions/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Azure Functions configuration",
"description" : "Get a specific Solace rest delivery point Azure Functions configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointAzureFunctionsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Azure Functions configuration",
"description" : "Update a Solace rest delivery point AzureFunctions configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointAzureFunctionsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Azure Functions configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Azure Functions configuration",
"description" : "Delete a Solace rest delivery point Azure Functions configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointAzureFunctionsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Azure Functions configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureEventHubs/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Azure Event Hubs configuration",
"description" : "Get a specific Solace rest delivery point Azure Event Hubs configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointAzureEventHubsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Azure Event Hubs configuration",
"description" : "Update a Solace rest delivery point AzureEventHubs configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointAzureEventHubsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Azure Event Hubs configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Azure Event Hubs configuration",
"description" : "Delete a Solace rest delivery point Azure Event Hubs configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointAzureEventHubsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Azure Event Hubs configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAwsApiGateways/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point AWS API Gateway configuration",
"description" : "Get a specific Solace rest delivery point AWS API Gateway configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointAwsApiGatewayConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point AWS API Gateway configuration",
"description" : "Update a Solace rest delivery point AWS API Gateway configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointAwsApiGatewayConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point AWS API Gateway configuration for Solace event brokers.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point AWS API Gateway configuration",
"description" : "Delete a Solace rest delivery point AWS API Gateway configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointAwsApiGatewayConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point AWS API Gateway configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointGoogleCloudStorages" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Google Cloud Storage configurations",
"description" : "Get a list of Solace rest delivery point Google Cloud Storage configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointGoogleCloudStorageConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Google Cloud Storage configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Google Cloud Storage configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Google Cloud Storage configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Google Cloud Storage configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Google Cloud Storage configuration",
"description" : "Create a Solace rest delivery point Google Cloud Storage configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointGoogleCloudStorageConfiguration",
"requestBody" : {
"description" : "The rest delivery point Google Cloud Storage configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointGoogleCloudRuns/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Google Cloud Run configuration",
"description" : "Get a specific Solace rest delivery point Google Cloud Run configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointGoogleCloudRunConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Google Cloud Run configuration",
"description" : "Update a Solace rest delivery point GoogleCloudRun configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointGoogleCloudRunConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Google Cloud Run configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Google Cloud Run configuration",
"description" : "Delete a Solace rest delivery point Google Cloud Run configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointGoogleCloudRunConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Google Cloud Run configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductVersions/{eventApiProductVersionId}/memAssociations" : {
"post" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Create an Association Between a Gateway Messaging Service and an Event API Product Version",
"description" : "Use this API to associate an Event API Product version and gateway messaging service.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "associateGatewayMessagingServiceToEAPVersion",
"parameters" : [ {
"name" : "eventApiProductVersionId",
"in" : "path",
"description" : "The ID of the Event API Product version to associate.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Gateway messaging service Id and supported Protocols.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GatewayMessagingService"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Associated GatewayMessagingService to Event API Product version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GatewayMessagingServiceResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointGoogleCloudFunctions" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Google Cloud Functions configurations",
"description" : "Get a list of Solace rest delivery point Google Cloud Functions configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointGoogleCloudFunctionsConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Google Cloud Functions configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Google Cloud Functions configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Google Cloud Functions configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Google Cloud Functions configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Google Cloud Functions configuration",
"description" : "Create a Solace rest delivery point Google Cloud Functions configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointGoogleCloudFunctionsConfiguration",
"requestBody" : {
"description" : "The rest delivery point Google Cloud Functions configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationDomains/{applicationDomainId}/customAttributeDefinitions" : {
"get" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Get a list the custom attribute definitions of provided application domain",
"description" : "Use this API to get a list of custom attribute definitions that match the given parameters.
Token Permissions: [ `custom_attribute:get:*` ]",
"operationId" : "getCustomAttributeDefinitionsByApplicationDomain",
"parameters" : [ {
"name" : "applicationDomainId",
"in" : "path",
"description" : "Match only custom attribute definitions with the given application domain Id ",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The number of custom attribute definitions to get per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to get.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of custom attribute definitions of a given application domain id.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Create a custom attribute definition for provided application domain",
"description" : "Use this API to create a custom attribute definition for provided application domain.
Token Permissions: [ `custom_attribute:create:*` ]",
"operationId" : "createCustomAttributeDefinitionByApplicationDomain",
"parameters" : [ {
"name" : "applicationDomainId",
"in" : "path",
"description" : "The ID of the application domain",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The custom attribute definition.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinition"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created a custom attribute definition in provided application domain and Returns the newly saved custom attribute definition in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Delete a custom attribute definition of provided application domain",
"description" : "Use this API to delete a custom attribute definition by given application domain.
Token Permissions: [ `custom_attribute:delete:*` ]",
"operationId" : "deleteCustomAttributeDefinitionByApplicationDomain",
"parameters" : [ {
"name" : "applicationDomainId",
"in" : "path",
"description" : "The ID of the application domain",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureServiceBuses/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Azure Service Bus configuration",
"description" : "Get a specific Solace rest delivery point Azure Service Bus configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointAzureServiceBusConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Azure Service Bus configuration",
"description" : "Update a Solace rest delivery point AzureServiceBus configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointAzureServiceBusConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Azure Service Bus configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Azure Service Bus configuration",
"description" : "Delete a Solace rest delivery point Azure Service Bus configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointAzureServiceBusConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Azure Service Bus configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationVersions/{applicationVersionId}/eventAccessRequestPreview" : {
"get" : {
"tags" : [ "Application Version Event Access Requests" ],
"summary" : "(EA) Get expected event access requests by application version id",
"description" : "Get expected event access requests by application version id
Token Permissions: [ `application:get:*` ]",
"operationId" : "getApplicationVersionEventAccessRequestPreview",
"parameters" : [ {
"name" : "applicationVersionId",
"in" : "path",
"description" : "The application version id to get requests for",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Get a list of existing event access requests and missing event access requests for an application version.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationVersionEventAccessRequestsResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointGoogleCloudStorages/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Google Cloud Storage configuration",
"description" : "Get a specific Solace rest delivery point Google Cloud Storage configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointGoogleCloudStorageConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Google Cloud Storage configuration",
"description" : "Update a Solace rest delivery point GoogleCloudStorage configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointGoogleCloudStorageConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Google Cloud Storage configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Google Cloud Storage configuration",
"description" : "Delete a Solace rest delivery point Google Cloud Storage configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointGoogleCloudStorageConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Google Cloud Storage configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointGoogleCloudFunctions/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Google Cloud Functions configuration",
"description" : "Get a specific Solace rest delivery point Google Cloud Functions configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointGoogleCloudFunctionsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a rest delivery point Google Cloud Functions configuration",
"description" : "Update a Solace rest delivery point GoogleCloudFunctions configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointGoogleCloudFunctionsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Google Cloud Functions configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Google Cloud Functions configuration",
"description" : "Delete a Solace rest delivery point Google Cloud Functions configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointGoogleCloudFunctionsConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Google Cloud Functions configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureDataLakeStorageGen2s" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a list of rest delivery point Azure Data Lake Storage Gen2 configurations",
"description" : "Get a list of Solace rest delivery point Azure Data Lake Storage Gen2 configurations for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ event_designer:access ]",
"operationId" : "getSolaceRestDeliveryPointAzureDataLakeStorageGenConfigurations",
"parameters" : [ {
"name" : "pageSize",
"in" : "query",
"description" : "The number of Solace rest delivery point Azure Data Lake Storage Gen2 configurations to return per page.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 100,
"minimum" : 1
}
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number to retrieve.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 1,
"minimum" : 1
}
}, {
"name" : "eventBrokerIds",
"in" : "query",
"description" : "The unique identifiers of the event brokers, separated by commas, to retrieve rest delivery point Azure Data Lake Storage Gen2 configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "ids",
"in" : "query",
"description" : "The unique identifiers of the rest delivery point Azure Data Lake Storage Gen2 configurations to retrieve, separated by commas.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "entityIds",
"in" : "query",
"description" : "The unique identifiers of designer entities, separated by commas, to retrieve rest delivery point Azure Data Lake Storage Gen2 configurations from.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.\nDefine the sort order using the following string: `fieldname:asc/desc` where:\n\n- `fieldname` — The field name of the query parameter to sort by.\n- `asc` — Sort the selected field name in ascending order.\n- `desc` — Sort the selected field name in descending order.\n\nIf the direction is not specified, the default is ascending.\n\nYou can use multiple query parameters to refine the sorting order.\n",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationsResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"post" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Create a rest delivery point Azure Data Lake Storage Gen2 configuration",
"description" : "Create a Solace rest delivery point Azure Data Lake Storage Gen2 configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "createSolaceRestDeliveryPointAzureDataLakeStorageGenConfiguration",
"requestBody" : {
"description" : "The rest delivery point Azure Data Lake Storage Gen2 configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/designer/configuration/solaceRestDeliveryPointAzureDataLakeStorageGen2s/{id}" : {
"get" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Get a specific rest delivery point Azure Data Lake Storage Gen2 configuration",
"description" : "Get a specific Solace rest delivery point Azure Data Lake Storage Gen2 configuration for an application version.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId" : "getSolaceRestDeliveryPointAzureDataLakeStorageGenConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"put" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Update a Azure Data Lake Storage Gen2 configuration",
"description" : "Update a Solace rest delivery point Azure Data Lake Storage Gen2 configuration for an application version.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "updateSolaceRestDeliveryPointAzureDataLakeStorageGenConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The ID of the configuration object to update.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The rest delivery point Azure Data Lake Storage Gen2 configuration for Solace event brokers.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/Configuration"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Designer Configurations" ],
"summary" : "(Beta) Delete a rest delivery point Azure Data Lake Storage Gen2 configuration",
"description" : "Delete a Solace rest delivery point Azure Data Lake Storage Gen2 configuration for an application version. You can't undo this operation.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:update:*` ]",
"operationId" : "deleteSolaceRestDeliveryPointAzureDataLakeStorageGenConfiguration",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the rest delivery point Azure Data Lake Storage Gen2 configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/runtimeManagement/applicationConfigurationPushJobs/{jobId}/decryptedConfigurations" : {
"get" : {
"tags" : [ "Application Configuration Push Job" ],
"summary" : "(Beta) Get a configuration push job's runtime configurations for self-managed configuration push",
"description" : "Get an existing configuration push job's runtime configurations, the configurations are returned in HCL format by default.\nThe job's target environment must not have the `disabled` config push mode.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application_configuration_push_job:*:*` ]",
"operationId" : "getConfigurationPushJobConfigurations",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The unique identifier of the configuration push job.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "format",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string",
"default" : "hcl"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationConfigPushJobConfigurationResponse"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/eventApiProductVersions/{eventApiProductVersionId}/memAssociations/{memAssociationId}" : {
"delete" : {
"tags" : [ "Event API Products" ],
"summary" : "(Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Version",
"description" : "Use this API to disassociate an Event API Product version and gateway messaging service.
Token Permissions: [ `event_api_product:update:*` ]",
"operationId" : "disassociateGatewayMessagingServiceToEAPVersion",
"parameters" : [ {
"name" : "eventApiProductVersionId",
"in" : "path",
"description" : "The ID of the Event API Product version to disassociate.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "memAssociationId",
"in" : "path",
"description" : "The MEM association ID to dissociate from.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
}
},
"/api/v2/architecture/applicationDomains/{applicationDomainId}/customAttributeDefinitions/{customAttributeId}" : {
"delete" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Delete a custom attribute definition of provided application domain",
"description" : "Use this API to delete a custom attribute definition of given application domain.
Token Permissions: [ `custom_attribute:delete:*` ]",
"operationId" : "deleteCustomAttributeDefinitionOfApplicationDomain",
"parameters" : [ {
"name" : "applicationDomainId",
"in" : "path",
"description" : "The ID of the application domain",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributeId",
"in" : "path",
"description" : "The ID of the custom attribute definition",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No content is returned."
},
"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"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Custom Attribute Definitions" ],
"summary" : "Update a custom attribute definition for provided application domain",
"description" : "Use this API to update a custom attribute definition for provided application domain.
Token Permissions: [ `custom_attribute:update:*` ]",
"operationId" : "updateCustomAttributeDefinitionByApplicationDomain",
"parameters" : [ {
"name" : "applicationDomainId",
"in" : "path",
"description" : "The ID of the application domain",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "customAttributeId",
"in" : "path",
"description" : "The ID of the custom attribute definition",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The custom attribute definition.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinition"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Updated a custom attribute definition in provided application domain and Returns the newly saved custom attribute definition in the response body.",
"content" : {
"application/json;charset=UTF-8" : {
"schema" : {
"$ref" : "#/components/schemas/CustomAttributeDefinitionResponse"
}
}
}
},
"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",
"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" ]
},
"ApplicationConfigPushJobConfigurationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationConfigurationPushJobConfiguration"
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationConfigPushJobResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationConfigurationPushJob"
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationConfigPushJobsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationConfigurationPushJob"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationConfigurationPushJob" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The unique identifier of the application configuration push job.",
"example" : "xyz23mwec2g"
},
"eventBrokerId" : {
"type" : "string",
"description" : "The unique identifier of the modeled event broker the application configuration push job is for.",
"example" : "acb2j5k3mly"
},
"applicationId" : {
"type" : "string",
"description" : "The unique identifier of the application the application configuration push job is for.",
"example" : "8pg75d6fp0e"
},
"sourceType" : {
"type" : "string",
"description" : "The type of the source the application configuration push job is created from.",
"enum" : [ "changeRecord" ],
"example" : "changeRecord"
},
"sourceId" : {
"type" : "string",
"description" : "The unique identifier of the source the application configuration push job is created from.",
"example" : "mca5sf9k3ut"
},
"requestMetadata" : {
"type" : "object",
"additionalProperties" : { },
"description" : "The request metadata in JSON format.",
"example" : "'object': { 'field': 'description' }"
},
"status" : {
"type" : "string",
"description" : "The status of the application configuration push job.",
"enum" : [ "pending", "cancelled", "in_progress", "error", "validation_error", "success" ]
},
"createdTime" : {
"type" : "string",
"description" : "The time the entity was created.",
"example" : "2021-12-31T20:30:57.920Z",
"readOnly" : true
},
"errorDescription" : {
"type" : "string",
"description" : "The error description of the failed application configuration push job.",
"example" : "The event broker configuration operation timed out."
},
"updatedTime" : {
"type" : "string",
"description" : "The time the entity was last updated.",
"example" : "2021-12-31T20:30:57.920Z",
"readOnly" : true
},
"result" : {
"type" : "object",
"additionalProperties" : { },
"description" : "The result metadata of the job in JSON format.",
"example" : "'object': { 'field': 'description' }"
},
"removal" : {
"type" : "boolean"
},
"type" : {
"type" : "string"
},
"isRemoval" : {
"type" : "boolean",
"description" : "Specifies whether the configuration push job is for the removal of an application from an event broker.",
"example" : true
}
}
},
"ApplicationConfigurationPushJobConfiguration" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"hclConfigurations" : {
"type" : "string"
},
"environmentVariables" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"type" : {
"type" : "string"
}
}
},
"ApplicationDeployment" : {
"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
},
"applicationVersionId" : {
"type" : "string",
"description" : "The unique identifier of the application version to deploy.",
"example" : "xyz23mwec2g",
"minLength" : 1
},
"action" : {
"type" : "string",
"description" : "The deployment action to perform for the application version.",
"enum" : [ "deploy", "undeploy" ]
},
"eventBrokerId" : {
"type" : "string",
"description" : "The unique identifier of the model event broker to deploy to.",
"example" : "acb2j5k3mly",
"minLength" : 1
}
},
"required" : [ "action", "applicationVersionId", "eventBrokerId" ]
},
"ApplicationDeploymentPreviewDTO" : {
"type" : "object",
"properties" : {
"requested" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PreviewEntityConfigurationDTO"
}
},
"existing" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PreviewEntityConfigurationDTO"
}
}
}
},
"ApplicationDeploymentPreviewResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationDeploymentPreviewDTO"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationDeploymentResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationDeploymentResultDTO"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationDeploymentResultDTO" : {
"type" : "object",
"properties" : {
"changeRecordId" : {
"type" : "string",
"description" : "The unique identifier of the changeRecord created for the deployment. For environments with configuration push enabled, this id correlates with the resulting configuration push job."
}
}
},
"ApplicationDomain" : {
"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" : 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,
"minLength" : 0
},
"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" ]
},
"ApplicationDomainDesignMetadata" : {
"type" : "object",
"properties" : {
"applicationDomainId" : {
"type" : "string",
"description" : "System-generated application domain ID",
"example" : "abc123"
}
}
},
"ApplicationDomainDesignSpec" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Display name for the application domain",
"example" : "Customer MDM"
},
"description" : {
"type" : "string",
"description" : "Description of the application domain"
},
"customColour" : {
"type" : "string",
"description" : "Custom color for UI display",
"example" : "#FF5733"
},
"topicDomains" : {
"type" : "array",
"description" : "Topic domains associated with this application domain",
"items" : {
"$ref" : "#/components/schemas/TopicDomainSpec"
}
},
"uniqueTopicAddressEnforcementEnabled" : {
"type" : "boolean",
"description" : "Enable unique topic address enforcement"
},
"topicDomainEnforcementEnabled" : {
"type" : "boolean",
"description" : "Enable topic domain enforcement"
},
"deletionProtected" : {
"type" : "boolean",
"description" : "Protect domain from deletion"
},
"nonDraftDescriptionsEditable" : {
"type" : "boolean",
"description" : "Allow non-draft descriptions to be editable"
}
},
"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"
}
}
}
},
"ApplicationDomainImportDTO" : {
"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"
}
},
"validationMessages" : {
"$ref" : "#/components/schemas/ValidationMessagesDTO"
}
}
},
"ApplicationDomainResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationDomain"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"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"
}
}
},
"ApplicationDomainsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationDomain"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationInfo" : {
"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
},
"name" : {
"type" : "string",
"example" : "My First Application",
"maxLength" : 255,
"minLength" : 1
},
"applicationDomainId" : {
"type" : "string",
"example" : "acb2j5k3mly"
},
"applicationType" : {
"type" : "string",
"example" : "standard",
"maxLength" : 255,
"minLength" : 1
},
"brokerType" : {
"type" : "string",
"enum" : [ "kafka", "solace" ],
"example" : "solace",
"maxLength" : 255,
"minLength" : 1
},
"type" : {
"type" : "string"
}
}
},
"ApplicationPromotionListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequest"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationPromotionPreviewRequestDTO" : {
"type" : "object",
"properties" : {
"applicationVersionId" : {
"type" : "string",
"minLength" : 1
},
"eventBrokerId" : {
"type" : "string",
"minLength" : 1
},
"action" : {
"type" : "string",
"description" : "The action to be performed on the application",
"enum" : [ "promote", "remove" ],
"example" : "promote"
}
},
"required" : [ "action", "applicationVersionId", "eventBrokerId" ]
},
"ApplicationPromotionRequest" : {
"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" : 12345678,
"readOnly" : true
},
"description" : {
"type" : "string",
"example" : "Description of the promotion request"
},
"applicationVersionId" : {
"type" : "string",
"example" : 12345678
},
"applicationId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"eventBrokerId" : {
"type" : "string",
"example" : 12345678
},
"reviewStatus" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"requestStatus" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"promotedTime" : {
"type" : "string",
"description" : "The time the request was promoted",
"example" : "2024-04-15T10:00:00.000Z",
"readOnly" : true
},
"action" : {
"type" : "string",
"description" : "The action to be performed on the application",
"enum" : [ "promote", "remove" ],
"example" : "promote"
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "action", "applicationVersionId", "eventBrokerId", "requestStatus", "reviewStatus" ]
},
"ApplicationPromotionRequestResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequest"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationPromotionRequestReview" : {
"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" : 12345678,
"readOnly" : true
},
"requestId" : {
"type" : "string",
"description" : "ID of the application promotion request this review is for",
"example" : 12345678
},
"comment" : {
"type" : "string",
"example" : "This application promotion looks good!"
},
"reviewDecision" : {
"type" : "string",
"description" : "Review decision: 'approved' or 'declined'",
"example" : "approved"
},
"requestPayloadSnapshot" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PreviewEntityConfigurationDTO"
}
},
"existingPayloadSnapshot" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PreviewEntityConfigurationDTO"
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "requestId", "reviewDecision" ]
},
"ApplicationPromotionRequestReviewListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestReview"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationPromotionRequestReviewResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationPromotionRequestReview"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Application"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationVersion" : {
"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
},
"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" ]
},
"ApplicationVersionEventAccessRequests" : {
"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" : 12345678,
"readOnly" : true
},
"eventAccessRequests" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventAccessRequest"
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"ApplicationVersionEventAccessRequestsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationVersionEventAccessRequests"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationVersionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ApplicationVersion"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ApplicationVersionToApplicationVersionAssocation" : {
"type" : "object",
"properties" : {
"sourceId" : {
"type" : "string"
},
"destinationId" : {
"type" : "string"
}
}
},
"ApplicationVersionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationVersion"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationsInfoResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationInfo"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApplicationsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Application"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ApproveDeclineRequest" : {
"type" : "object",
"properties" : {
"comments" : {
"type" : "string",
"example" : "Approved"
}
}
},
"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
}
}
},
"AuditRelationDTO" : {
"type" : "object",
"properties" : {
"auditEntityType" : {
"type" : "string"
},
"auditId" : {
"type" : "string"
},
"identifier" : {
"type" : "string"
},
"status" : {
"type" : "string"
}
}
},
"AuditResult" : {
"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" : 12345678,
"readOnly" : true
},
"eventBrokerId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"auditEntityType" : {
"type" : "string",
"example" : "solaceQueue",
"readOnly" : true
},
"eventBrokerName" : {
"type" : "string",
"example" : "My Solace Service",
"readOnly" : true
},
"identifier" : {
"type" : "string",
"example" : "orderEventQueue",
"readOnly" : true
},
"status" : {
"type" : "string",
"example" : "partialMatch",
"readOnly" : true
},
"schemaType" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
}
},
"AuditResultDetail" : {
"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" : 12345678,
"readOnly" : true
},
"parentId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"versionId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"entityId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"scanId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"status" : {
"type" : "string",
"example" : "partialMatch",
"readOnly" : true
},
"identifier" : {
"type" : "string",
"example" : "orderEventQueue",
"readOnly" : true
},
"relations" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuditRelationDTO",
"readOnly" : true
}
},
"type" : {
"type" : "string"
}
}
},
"AuditResultDetailResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/AuditResultDetail"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"AuditResultsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuditResult"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ChangeAppDomainEntitiesDTO" : {
"type" : "object",
"properties" : {
"targetAppDomainId" : {
"type" : "string"
},
"entities" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TargetEntitiesRequestDTO"
},
"uniqueItems" : true
}
}
},
"ConfigPushJobStatusUpdateRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "pending", "cancelled", "in_progress", "error", "validation_error", "success" ]
},
"errorDescription" : {
"type" : "string",
"description" : "Optional error description for error status transitions"
}
},
"required" : [ "status" ]
},
"Configuration" : {
"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",
"description" : "The unique identifier of the configuration.",
"example" : "xyz23mwec2g",
"readOnly" : true
},
"contextType" : {
"type" : "string",
"description" : "The type of the context that the configuration is for.",
"enum" : [ "EVENT_BROKER" ],
"example" : "EVENT_BROKER",
"oneOf" : [ {
"type" : "string",
"enum" : [ "EVENT_BROKER" ]
} ]
},
"contextId" : {
"type" : "string",
"description" : "The unique identifier of the event broker that the client username configuration will be created on.",
"example" : "acb2j5k3mly"
},
"configurationTypeId" : {
"type" : "string",
"description" : "See Get a list of configuration types for detail.",
"example" : "solaceClientUsername",
"readOnly" : true
},
"entityType" : {
"type" : "string",
"description" : "The type of the designer entity the configuration is for.",
"enum" : [ "address", "application", "applicationVersion", "audit", "consumer", "eventVersion", "schema", "schemaVersion", "subscription" ],
"example" : "consumer",
"readOnly" : true
},
"entityId" : {
"type" : "string",
"description" : "The unique identifier of the entity in Designer (such as an application or consumer) that the configuration is for.\nFor client username configurations, this is the ID of the application that uses the provided credentials\nto connect to the event broker.\n",
"example" : "acb2j5k3mly"
},
"identifier" : {
"type" : "string",
"description" : "The audit identifier of the designer entity the configuration is for.",
"example" : "abc|123",
"readOnly" : true
},
"templateId" : {
"type" : "string",
"description" : "The unique identifier of the configuration template.",
"example" : "acb2j5k3mly"
},
"resolvedValue" : {
"type" : "object",
"additionalProperties" : { },
"description" : "The final merged configuration value computed by combining the user-provided value with the configuration template.\n\nThis field is read-only and automatically generated by the system. When a configuration has both a template\n(referenced by templateId) and user-provided values (in the value field), the system merges them to create\nthe resolvedValue. User-provided values take precedence and override template defaults.\n\nThe resolvedValue represents the actual configuration that will be applied when the application is promoted\nto an environment. If no template is used, this field will match the user-provided value field.\n",
"example" : "'object': { 'field': 'value' }",
"readOnly" : true
},
"value" : {
"type" : "object",
"additionalProperties" : { },
"description" : "The configuration value in JSON format. The structure depends on the configuration type.",
"example" : {
"clientUsername" : "myapp-client-user",
"password" : "SecureP@ssw0rd"
}
},
"workInProgress" : {
"type" : "boolean",
"default" : false,
"description" : "Set to true to mark this configuration as Work In Progress.\nWhen set to true, required fields (such as clientUsername and password for client username configurations)\nwill not be validated for presence, allowing you to save incomplete configurations.\nThis setting is useful when you want to create a configuration incrementally or save a draft.\n",
"example" : true
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "contextId", "contextType", "entityId" ]
},
"ConfigurationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Configuration"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ConfigurationType" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "xyz23mwec2g",
"readOnly" : true
},
"brokerType" : {
"type" : "string",
"example" : "solace",
"maxLength" : 255,
"minLength" : 1
},
"associatedEntityTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : [ "eventVersion", "applicationVersion", "consumer" ]
}
},
"valueSchema" : {
"type" : "object",
"additionalProperties" : { },
"description" : "JSON schema definition of the configuration type",
"example" : "'object': { 'field': 'description' }"
},
"templateMetaSchema" : {
"type" : "object",
"additionalProperties" : { },
"description" : "JSON meta-schema for validating user-authored templates. Only returned when expand=templateMetaSchema is requested."
},
"type" : {
"type" : "string"
}
},
"required" : [ "brokerType" ]
},
"ConfigurationTypeResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ConfigurationType"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ConfigurationTypesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConfigurationType"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ConfigurationsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Configuration"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"Consumer" : {
"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
},
"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" ]
},
"ConsumerRequest" : {
"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
},
"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" ]
},
"ConsumerResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Consumer"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ConsumersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Consumer"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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" ]
},
"CustomAttributeDefinitionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/CustomAttributeDefinition"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"CustomAttributeDefinitionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomAttributeDefinition"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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"
}
}
},
"DeploymentPreviewError" : {
"type" : "object",
"properties" : {
"conflictType" : {
"type" : "string",
"enum" : [ "clientUsername", "authorizationGroupName", "queueName", "aclProfileName" ]
},
"configurationTypeId" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"subType" : {
"type" : "string"
}
}
},
"EnumDesignRef" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The refId of the referenced enum design",
"example" : "mdm-region"
},
"version" : {
"type" : "string",
"description" : "The version of the referenced enum design",
"example" : "1.0.0"
}
},
"required" : [ "id", "version" ],
"title" : "EnumDesignRef"
},
"Environment" : {
"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" : "xyz123abc",
"readOnly" : true
},
"name" : {
"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" : "Staging environment",
"readOnly" : true
},
"description" : {
"type" : "string",
"deprecated" : true,
"description" : "*Deprecation Date: 2025-01-17
Removal Date: 2026-01-17
Reason: Environment description should be fetched from Platform APIs.*
",
"example" : "The description of my environment",
"readOnly" : true
},
"revision" : {
"type" : "integer",
"format" : "int32",
"deprecated" : true,
"description" : "*Deprecation Date: 2025-01-17
Removal Date: 2026-01-17
Reason: Environment revision should be fetched from Platform APIs.*
",
"readOnly" : true
},
"numberOfEventMeshes" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"configPush" : {
"type" : "string",
"description" : "The configuration push mode where 'disabled' indicates that configuration changes will not be pushed to event broker on deployment. 'auto' indicates that configuration changes will be automatically pushed to event broker on deployment. 'onDemand' indicates that configuration changes will be pushed to event broker only when requested by the user. 'selfManaged' indicates that the user is responsible for pushing configuration changes to event broker.",
"enum" : [ "auto", "disabled", "onDemand", "selfManaged" ],
"example" : "auto | disabled | onDemand | selfManaged"
},
"enforcedConfigurationTemplateTypeIds" : {
"type" : "array",
"description" : "The configuration template type ids required by this environment for deployment to an event broker.",
"example" : "[solaceClientProfileName, solaceQueue]",
"items" : {
"type" : "string"
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"EnvironmentInfo" : {
"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",
"description" : "The unique identifier of the environment.",
"example" : "xyz123abc",
"readOnly" : true
},
"name" : {
"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" : "Staging environment",
"readOnly" : true
},
"allowedActions" : {
"type" : "array",
"description" : "The types of environment information a user is permitted to retrieve. Users with 'get_info' may use the 'about/environments' API. Users with any other action may use the standard '/environments' API.",
"example" : "[get, get_info, update]",
"items" : {
"type" : "string"
},
"readOnly" : true,
"uniqueItems" : true
},
"type" : {
"type" : "string",
"enum" : [ "environmentInfo" ],
"readOnly" : true
}
}
},
"EnvironmentInfoResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EnvironmentInfo"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EnvironmentResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Environment"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EnvironmentsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Environment"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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",
"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" ]
},
"EventAccessRequest" : {
"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" : 12345678,
"readOnly" : true
},
"comments" : {
"type" : "string",
"example" : "Comments on the request"
},
"reviewStatus" : {
"type" : "string",
"enum" : [ "approved", "pending", "declined" ],
"example" : "approved, declined, pending",
"readOnly" : true
},
"applicationId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"eventId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"subscription" : {
"type" : "string",
"example" : "topic/address",
"readOnly" : true
},
"publishTopic" : {
"type" : "string",
"example" : "topic/address",
"readOnly" : true
},
"relationship" : {
"type" : "string",
"enum" : [ "consuming", "producing" ],
"example" : "CONSUMING",
"readOnly" : true
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "applicationId", "eventId" ]
},
"EventAccessRequestDeletionRequest" : {
"type" : "object",
"properties" : {
"ids" : {
"type" : "array",
"items" : {
"type" : "string"
},
"uniqueItems" : true
}
}
},
"EventAccessRequestListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventAccessRequest"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventAccessRequestResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventAccessRequest"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventApi" : {
"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",
"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",
"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" ]
},
"EventApiProductResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventApiProduct"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventApiProductVersion" : {
"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
},
"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" ]
},
"EventApiProductVersionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventApiProductVersion"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventApiProductVersionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventApiProductVersion"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventApiProductsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventApiProduct"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventApiResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventApi"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventApiVersion" : {
"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
},
"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" ]
},
"EventApiVersionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventApiVersion"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventApiVersionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventApiVersion"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventApisResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventApi"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventDesignMetadata" : {
"type" : "object",
"properties" : {
"eventId" : {
"type" : "string",
"description" : "System-generated event ID",
"example" : "xyz789"
},
"eventVersionId" : {
"type" : "string",
"description" : "System-generated event version ID",
"example" : "def456"
},
"stateId" : {
"type" : "string",
"description" : "State ID of the event version",
"example" : 1
}
}
},
"EventDesignSpec" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Display name for the event",
"example" : "Raw Customer Master Data Event"
},
"applicationDomain" : {
"type" : "string",
"description" : "The application domain this event belongs to",
"example" : "customer-mdm"
},
"version" : {
"type" : "string",
"description" : "Version of this event design",
"example" : "1.0.0"
},
"description" : {
"type" : "string",
"description" : "Description of the event"
},
"shared" : {
"type" : "boolean",
"description" : "Whether this event is shared across application domains",
"example" : true
},
"customColour" : {
"type" : "string",
"description" : "Custom color for UI display",
"example" : "accent1"
},
"topic" : {
"$ref" : "#/components/schemas/TopicAddress",
"description" : "Topic address configuration"
}
},
"required" : [ "applicationDomain", "name", "version" ]
},
"EventManagementAgent" : {
"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",
"description" : "Primary key set by the server.",
"example" : "sdagkjlh32x",
"readOnly" : true
},
"name" : {
"type" : "string",
"description" : "The name of the EMA.",
"example" : "primary event management agent"
},
"region" : {
"type" : "string",
"description" : "The region in which the EMA belongs to, extracted from the EventManagementAgentRegion.",
"example" : "North America",
"readOnly" : true
},
"referencedByMessagingServiceIds" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "The list of messagingServiceIds user provides in GET APIs to filter the results.",
"example" : [ "1kjdsf32", "9875ksdf" ],
"readOnly" : true
}
},
"orgId" : {
"type" : "string",
"description" : "Used by admin APIs to get a list of EMAs against the given orgId.",
"example" : "897xd32",
"readOnly" : true
},
"status" : {
"type" : "string",
"description" : "The connection status of EP to the actual EMA which this object represents.",
"example" : "Connected",
"readOnly" : true
},
"lastConnectedTime" : {
"type" : "string",
"description" : "The timestamp of last heartbeat received from the EMA.",
"example" : "2021-12-31T20:30:57.920Z",
"readOnly" : true
},
"version" : {
"type" : "string",
"description" : "The version of the current connected EMA.",
"example" : "1.1.2",
"readOnly" : true
},
"runtimeAgentMode" : {
"type" : "string",
"description" : "The mode that the EMA operates in. scanWithEventPortal is equivalent to Connected, and uploadScanFile is equivalent to Offline.",
"enum" : [ "scanWithEventPortal", "uploadScanFile" ],
"example" : "scanWithEventPortal",
"readOnly" : true
},
"updateRequired" : {
"type" : "boolean",
"description" : "Determines whether the EMA needs an upgrade.",
"example" : true,
"readOnly" : true
},
"eventManagementAgentRegionId" : {
"type" : "string",
"description" : "The ID of the associated EventManagementAgentRegion.",
"example" : "sdfkjh3242ds"
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"EventManagementAgentResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventManagementAgent"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventManagementAgentsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventManagementAgent"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventMesh" : {
"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",
"description" : "Primary key set by the server.",
"example" : 12345,
"readOnly" : true
},
"name" : {
"type" : "string",
"description" : "The name of the modeled event mesh.",
"example" : "Inventory",
"maxLength" : 40,
"minLength" : 1
},
"environmentId" : {
"type" : "string",
"description" : "The environmentId of the modeled event mesh.",
"example" : 67890,
"maxLength" : 255,
"minLength" : 1
},
"description" : {
"type" : "string",
"description" : "The description of the modeled event mesh.",
"example" : "The Inventory Event Mesh applications.",
"maxLength" : 10000,
"minLength" : 1
},
"brokerType" : {
"type" : "string",
"description" : "The type of the event broker used in the modeled event mesh.",
"enum" : [ "kafka", "solace" ]
},
"type" : {
"type" : "string",
"description" : "The type of this payload, eventMesh.",
"readOnly" : true
}
},
"required" : [ "environmentId" ]
},
"EventMeshInfoDTO" : {
"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
},
"name" : {
"type" : "string",
"description" : "The name of the modeled event mesh.",
"example" : "Inventory",
"maxLength" : 40,
"minLength" : 1
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the modeled event mesh.",
"example" : 12345,
"readOnly" : true
},
"description" : {
"type" : "string",
"description" : "The description of the modeled event mesh.",
"example" : "The Inventory Event Meshapplications.",
"maxLength" : 10000,
"minLength" : 1
},
"environmentId" : {
"type" : "string",
"description" : "The unique identifier of the environment that contains the modeled event mesh.",
"example" : 67890,
"maxLength" : 255,
"minLength" : 1
},
"brokerType" : {
"type" : "string",
"description" : "The type of the broker used in the modeled event mesh.",
"enum" : [ "kafka", "solace" ]
},
"allowedActions" : {
"type" : "array",
"description" : "The types of modeled event mesh information a user is permitted to retrieve. Users with the 'get_info' action can use the 'about/modeledEventMeshes' API. Users with any other action can use the standard '/eventMeshes' API.",
"example" : "[get, get_info]",
"items" : {
"type" : "string"
},
"readOnly" : true,
"uniqueItems" : true
},
"type" : {
"type" : "string"
}
}
},
"EventMeshResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventMesh"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventMeshWarningResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventMeshWarnings"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventMeshWarnings" : {
"type" : "object",
"properties" : {
"eventMesh" : {
"$ref" : "#/components/schemas/EventMesh"
},
"applicationVersions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApplicationVersion"
}
},
"eventVersions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventVersion"
}
}
}
},
"EventMeshesInfoResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventMeshInfoDTO"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventMeshesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventMesh"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventPortalUsageStats" : {
"type" : "object",
"properties" : {
"schemaCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"domainScopedCustomAttributeCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"orgScopedCustomAttributeCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"eventCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"selfManagedEventManagementAgentCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"applicationCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"applicationDomainCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"eventApiCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"subscriptionCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"consumerCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"enumCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"enumValueCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"sumUniqueEventsInEachEnvironmentCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"sumUniqueSchemasInEachEnvironmentCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"sumUniqueApplicationsInEachEnvironmentCount" : {
"type" : "integer",
"format" : "int32",
"readOnly" : true
},
"environmentIdToUniqueEventsCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int32"
},
"readOnly" : true
},
"environmentIdToUniqueApplicationsCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int32"
},
"readOnly" : true
},
"environmentIdToUniqueSchemasCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int32"
},
"readOnly" : true
}
}
},
"EventResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Event"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventVersion" : {
"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
},
"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" ]
},
"EventVersionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventVersion"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"EventVersionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EventVersion"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"EventsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Event"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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
}
}
},
"GatewayMessagingService" : {
"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"
},
"messagingServiceId" : {
"type" : "string"
},
"eventApiProductVersionId" : {
"type" : "string"
},
"supportedProtocols" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "smfc", "smf", "smfs", "amqp", "amqps", "mqtt", "mqtts", "mqttws", "mqttwss", "secure-mqtt", "secure-mqttws", "rest", "rests" ]
}
},
"type" : {
"type" : "string"
}
}
},
"GatewayMessagingServiceResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/GatewayMessagingService"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"ImportActionError" : {
"type" : "object",
"properties" : {
"errorType" : {
"type" : "string"
},
"auditIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"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"
}
}
} ]
},
"MessagingService" : {
"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",
"description" : "Primary key set by the server.",
"example" : "asdkl234x",
"readOnly" : true
},
"eventMeshId" : {
"type" : "string",
"description" : "The eventMeshId associated to the messaging service.",
"example" : "67890x23vh"
},
"runtimeAgentId" : {
"type" : "string",
"description" : "The runtimeAgentId associated to the messaging service.",
"example" : "vh1234y14"
},
"solaceCloudMessagingServiceId" : {
"type" : "string",
"description" : "The solaceCloudMessagingServiceId associated to the messaging service.",
"example" : "abcd1234x"
},
"datacenterId" : {
"type" : "string",
"description" : "The datacenterId associated to the messaging service.",
"example" : "dasglk213x"
},
"messagingServiceType" : {
"type" : "string",
"description" : "The type of the messaging service.",
"enum" : [ "solace", "kafka" ],
"example" : "solace"
},
"name" : {
"type" : "string",
"description" : "The name of the messaging service.",
"example" : "first messagingService"
},
"messagingServiceConnections" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingServiceConnection"
}
},
"eventManagementAgentId" : {
"type" : "string"
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"MessagingServiceAssociationDTO" : {
"type" : "object",
"properties" : {
"messagingServiceIds" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : [ "5h2km5khkj", "h5mk26hkm2" ]
}
}
}
},
"MessagingServiceAssociationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/MessagingServiceAssociationDTO"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"MessagingServiceAuthentication" : {
"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",
"description" : "Primary key set by the server.",
"example" : "kjsfg32ds",
"readOnly" : true
},
"messagingServiceConnectionId" : {
"type" : "string",
"description" : "The ID of the connection object associated to the authentication object.",
"example" : "sdafgj23",
"readOnly" : true
},
"name" : {
"type" : "string",
"description" : "The name of the authentication object.",
"example" : "https auth details"
},
"authenticationType" : {
"type" : "string",
"description" : "The type of the authentication object.",
"example" : "basicAuthentication"
},
"authenticationDetails" : {
"type" : "object",
"additionalProperties" : { },
"description" : "A JSON map containing a map of extra details for the authentication.",
"example" : {
"broker owner" : "Solace PE team"
}
},
"messagingServiceCredentials" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingServiceCredentials"
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "authenticationType", "name" ]
},
"MessagingServiceConnection" : {
"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",
"description" : "Primary key set by the server.",
"example" : "5432dfg3",
"readOnly" : true
},
"messagingServiceId" : {
"type" : "string",
"description" : "The messagingServiceId associated to the connection object.",
"example" : "sdkjhg21948",
"readOnly" : true
},
"name" : {
"type" : "string",
"description" : "The name of the connection object.",
"example" : "my https connection"
},
"url" : {
"type" : "string",
"description" : "The url of the connection object.",
"example" : "https://abcd.messaging.solace.cloud:943"
},
"protocol" : {
"type" : "string",
"description" : "The protocol of the connection object.",
"example" : "https"
},
"protocolVersion" : {
"type" : "string",
"description" : "The protocolVersion of the connection object.",
"example" : 2.0
},
"bindings" : {
"type" : "object",
"additionalProperties" : { },
"description" : "A JSON map containing a map of connection-specific values. ",
"example" : {
"msgVpn" : "myVPN"
}
},
"messagingServiceAuthentications" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingServiceAuthentication"
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"MessagingServiceCredentials" : {
"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",
"description" : "Primary key set by the server.",
"example" : "lkjdsfgew2",
"readOnly" : true
},
"messagingServiceAuthenticationId" : {
"type" : "string",
"description" : "The ID of the authentication object associated to the credentials object.",
"example" : "sdafgj23",
"readOnly" : true
},
"name" : {
"type" : "string",
"description" : "The name of the credentials object.",
"example" : "basic auth credentials"
},
"credentials" : {
"type" : "object",
"additionalProperties" : { },
"description" : "A JSON map containing the credentials information.",
"example" : {
"username" : "User1",
"password" : "secretPass"
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "credentials", "name" ]
},
"MessagingServiceOperation" : {
"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",
"description" : "Primary key set by the server.",
"example" : "kljhwe32",
"readOnly" : true
},
"scanTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "The list of scanTypes to be scanned.",
"enum" : [ "KAFKA_ALL", "CONFLUENT_SCHEMA_REGISTRY_SCHEMA", "SOLACE_ALL" ],
"example" : [ "KAFKA_ALL", "CONFLUENT_SCHEMA_REGISTRY_SCHEMA" ]
},
"minItems" : 1
},
"destinations" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "The list of destinations for EMA to send results to.",
"enum" : [ "EVENT_PORTAL", "FILE_WRITER" ],
"example" : [ "EVENT_PORTAL", "FILE_WRITER" ]
}
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "scanTypes" ]
},
"MessagingServiceOperationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/MessagingServiceOperation"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"MessagingServiceRemoveAssociation" : {
"type" : "object",
"properties" : {
"association" : {
"type" : "string",
"description" : "The target association to be removed from the messaging service.",
"enum" : [ "RUNTIME_AGENT", "EVENT_MESH", "EVENT_MANAGEMENT_AGENT" ],
"example" : "EVENT_MANAGEMENT_AGENT"
}
}
},
"MessagingServiceResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/MessagingService"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"MessagingServiceScan" : {
"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",
"description" : "Primary key set by the server.",
"example" : 12345,
"readOnly" : true
},
"status" : {
"type" : "string",
"description" : "The status of the messaging service scan.",
"example" : "FAILED",
"readOnly" : true
},
"statusDescription" : {
"type" : "string",
"description" : "The description of the messaging service scan status.",
"example" : "Scan failed because some scanTypes failed to complete.",
"readOnly" : true
},
"messagingServiceId" : {
"type" : "string",
"description" : "The messagingServiceId of the scan.",
"example" : "67890x23vh",
"readOnly" : true
},
"messagingServiceName" : {
"type" : "string",
"description" : "The messagingServiceName of the scan.",
"example" : "first solace messagingService",
"readOnly" : true
},
"scanTypes" : {
"type" : "string",
"description" : "The scanTypes that were requested for the scan.",
"example" : "KAFKA_ALL",
"readOnly" : true
},
"destinations" : {
"type" : "string",
"description" : "The destinations which EMA will send the scan results.",
"example" : "EVENT_PORTAL,FILE_WRITER",
"readOnly" : true
},
"isUsedByAudit" : {
"type" : "boolean",
"description" : "Whether the scan is used by audit.",
"example" : false,
"readOnly" : true
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"MessagingServiceScanData" : {
"type" : "object",
"properties" : {
"createdTime" : {
"type" : "string",
"description" : "The time the entity was created",
"example" : "2021-12-31T20:30:57.920Z",
"readOnly" : true
},
"id" : {
"type" : "string",
"description" : "Primary key set by the server.",
"example" : 12345,
"readOnly" : true
},
"scanId" : {
"type" : "string",
"description" : "The ID of the scan.",
"example" : "67890x23vh",
"readOnly" : true
},
"dataCollectionType" : {
"type" : "string",
"description" : "The type of dataCollection this object holds scan data for.",
"enum" : [ "brokerConfiguration", "clusterConfiguration", "consumerGroups", "consumerGroupConfiguration", "overrideTopicConfiguration", "queueConfiguration", "queueListing", "schema", "subscriptionConfiguration", "topicConfiguration", "topicListing" ],
"example" : "consumerGroups",
"readOnly" : true
},
"data" : {
"type" : "string",
"description" : "The scan data in JSON format.",
"example" : {
"name" : "some solace queue name"
},
"readOnly" : true
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"MessagingServiceScanDataListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingServiceScanData"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"MessagingServiceScanDataResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/MessagingServiceScanData"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"MessagingServiceScanLog" : {
"type" : "object",
"properties" : {
"createdTime" : {
"type" : "string",
"description" : "The time the entity was created",
"example" : "2021-12-31T20:30:57.920Z",
"readOnly" : true
},
"id" : {
"type" : "string",
"description" : "Primary key set by the server.",
"example" : 12345,
"readOnly" : true
},
"scanId" : {
"type" : "string",
"description" : "The ID of the scan.",
"example" : "67890x23vh",
"readOnly" : true
},
"log" : {
"type" : "string",
"description" : "The log message.",
"example" : "The Scan Is Done.",
"readOnly" : true
},
"logLevel" : {
"type" : "string",
"description" : "The level of the log message.",
"example" : "INFO",
"readOnly" : true
},
"type" : {
"type" : "string",
"readOnly" : true
}
}
},
"MessagingServiceScanLogListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingServiceScanLog"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"MessagingServiceScanResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/MessagingServiceScan"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"MessagingServiceScansResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingServiceScan"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"MessagingServicesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MessagingService"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ModeledEventBrokerInfoDTO" : {
"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
},
"name" : {
"type" : "string",
"description" : "The name of the modeled event broker.",
"example" : "first broker"
},
"eventMeshId" : {
"type" : "string",
"description" : "The unique identifier of the modeled event mesh that contains the modeled event broker.",
"example" : "67890x23vh"
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the modeled event broker.",
"example" : "asdkl234x",
"readOnly" : true
},
"allowedActions" : {
"type" : "array",
"description" : "The types of modeled event broker information a user is permitted to retrieve. A user with 'get_info' action can use the 'about/modeledEventBrokers' API. Users with any other action can use the standard '/messagingServices' API.",
"example" : "[get, get_info]",
"items" : {
"type" : "string"
},
"readOnly" : true,
"uniqueItems" : true
},
"type" : {
"type" : "string",
"enum" : [ "modeledEventBrokerInfo" ],
"readOnly" : true
}
}
},
"ModeledEventBrokerInfoResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ModeledEventBrokerInfoDTO"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"OperationDTO" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"operationType" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"createdTime" : {
"type" : "string"
},
"completedTime" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "pending", "cancelled", "in_progress", "error", "validation_error", "success" ]
},
"results" : { },
"error" : { }
}
},
"OperationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/OperationDTO"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"Pagination" : {
"type" : "object",
"properties" : {
"pageNumber" : {
"type" : "integer",
"format" : "int32"
},
"count" : {
"type" : "integer",
"format" : "int32"
},
"pageSize" : {
"type" : "integer",
"format" : "int32"
},
"nextPage" : {
"type" : "integer",
"format" : "int32"
},
"totalPages" : {
"type" : "integer",
"format" : "int32"
}
}
},
"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
}
}
},
"PreviewEntityConfigurationDTO" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Type of the runtime entity",
"enum" : [ "solaceQueue", "solaceAcl", "solaceRestDeliveryPoint", "solaceRestDeliveryPointQueueBinding", "solaceAuthorizationGroup", "solaceAccess", "solaceClientUsername", "solaceClientCertificateUsername" ]
},
"identifier" : {
"type" : "string",
"description" : "Identifier of the runtime entity"
},
"value" : {
"type" : "object",
"additionalProperties" : { },
"description" : "Configuration values for the runtime entity"
},
"errors" : {
"type" : "array",
"description" : "Errors related to the runtime entity that will prevent deployment",
"items" : {
"$ref" : "#/components/schemas/DeploymentPreviewError"
}
}
}
},
"Resource" : {
"type" : "object",
"discriminator" : {
"propertyName" : "kind"
},
"properties" : {
"apiVersion" : {
"type" : "string",
"description" : "Schema version (paired with kind to determine spec schema)",
"example" : "studio/v0"
},
"id" : {
"type" : "string",
"description" : "User-controlled identifier",
"example" : "mdm-raw-customer-event"
},
"spec" : { },
"kind" : {
"type" : "string",
"description" : "Resource kind. Defines the schema of spec."
},
"type" : {
"type" : "string",
"description" : "Resource type",
"example" : "resource",
"readOnly" : true
}
},
"required" : [ "id", "kind" ]
},
"ResponseEventPortalUsageStats" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/EventPortalUsageStats"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"Review" : {
"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" : 12345678,
"readOnly" : true
},
"requestId" : {
"type" : "string",
"example" : 12345678,
"readOnly" : true
},
"decision" : {
"type" : "string",
"enum" : [ "approved", "pending", "declined" ],
"example" : "Approved"
},
"comments" : {
"type" : "string",
"example" : "Approved"
},
"type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [ "decision" ]
},
"ReviewListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Review"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"ReviewResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Review"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"RuntimeImportValidationException" : {
"type" : "object",
"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']"
},
"importActionErrors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImportActionError"
}
},
"errorType" : {
"type" : "string"
}
}
},
"SchemaObject" : {
"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" : 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" ]
},
"SchemaResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/SchemaObject"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"SchemaVersion" : {
"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" : 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"
}
}
},
"SchemaVersionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/SchemaVersion"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"SchemaVersionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SchemaVersion"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"SchemasResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SchemaObject"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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
}
}
},
"SolaceClientProfileName" : {
"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
},
"name" : {
"type" : "string",
"example" : "My Client Profile Name Template",
"maxLength" : 255,
"minLength" : 1
},
"description" : {
"type" : "string",
"example" : "This is a client profile name template to be used when deploying to environments",
"maxLength" : 10000
},
"configurationTypeId" : {
"type" : "string",
"description" : "See Get a list of configuration types for detail.",
"example" : "solaceClientProfileName",
"readOnly" : true
},
"value" : {
"type" : "object",
"additionalProperties" : { },
"description" : "The configuration template in JSON format",
"example" : "'object': { 'clientProfileName': 'name' }"
},
"associatedApplicationVersionIds" : {
"type" : "array",
"description" : "The list of application version IDs associated with this Solace Client Profile Name Configuration template",
"example" : "['applicationVersionId1', 'applicationVersionId2']",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"environmentIds" : {
"type" : "array",
"description" : "The list of environment IDs associated with this Solace Client Profile Name Configuration template",
"example" : "['environmentId1']",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"type" : {
"type" : "string"
}
}
},
"SolaceClientProfileNameConfigurationTemplateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/SolaceClientProfileName"
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"SolaceClientProfileNameConfigurationTemplatesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SolaceClientProfileName"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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
}
}
},
"SolaceQueueConfigurationTemplate" : {
"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
},
"name" : {
"type" : "string",
"example" : "My First Configuration Template",
"maxLength" : 255,
"minLength" : 1
},
"description" : {
"type" : "string",
"example" : "This is a configuration template to be used when deploying to environments",
"maxLength" : 10000
},
"configurationTypeId" : {
"type" : "string",
"description" : "See Get a list of configuration types for detail.",
"example" : "solaceQueue",
"readOnly" : true
},
"value" : {
"type" : "object",
"additionalProperties" : { },
"description" : "The configuration template in JSON format",
"example" : "'object': { 'field': 'description' }"
},
"associatedConsumerIds" : {
"type" : "array",
"description" : "The list of consumer IDs associated with this Solace Queue Configuration template",
"example" : "['consumerId1', 'consumerId2']",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"environmentIds" : {
"type" : "array",
"description" : "The list of environment IDs associated with this Solace Queue Configuration template",
"example" : "['environmentId1']",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"type" : {
"type" : "string"
}
}
},
"SolaceQueueConfigurationTemplateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplate"
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"SolaceQueueConfigurationTemplatesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SolaceQueueConfigurationTemplate"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"StateChangeRequestResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/VersionedObjectStateChangeRequest"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"StateDTO" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"stateOrder" : {
"type" : "integer",
"format" : "int32"
},
"type" : {
"type" : "string"
}
}
},
"StatesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StateDTO"
}
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"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
}
}
},
"TargetEntitiesRequestDTO" : {
"type" : "object",
"properties" : {
"selectedEntityIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"entityType" : {
"type" : "string",
"enum" : [ "application", "schema", "event" ]
}
}
},
"TopicAddress" : {
"type" : "object",
"properties" : {
"address" : {
"type" : "string",
"description" : "The topic address pattern",
"example" : "acme/customer/mdm/raw/v1/{region}/{action}"
}
},
"required" : [ "address" ],
"title" : "TopicAddress"
},
"TopicAddressEnum" : {
"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
},
"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" ]
},
"TopicAddressEnumResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/TopicAddressEnum"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"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",
"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" ]
},
"TopicAddressEnumVersionResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersion"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"TopicAddressEnumVersionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TopicAddressEnumVersion"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"TopicAddressEnumsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TopicAddressEnum"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"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" ]
},
"TopicDomainResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/TopicDomain"
},
"meta" : {
"type" : "object",
"additionalProperties" : { }
}
}
},
"TopicDomainSpec" : {
"type" : "object",
"properties" : {
"address" : {
"type" : "string",
"description" : "The topic domain address pattern with optional {variable} placeholders",
"example" : "customer/mdm"
},
"variables" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/EnumDesignRef"
},
"description" : "Variable bindings to enum references. Variables not listed are unbounded."
}
},
"required" : [ "address" ]
},
"TopicDomainsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TopicDomain"
}
},
"meta" : {
"$ref" : "#/components/schemas/meta"
}
}
},
"TopicFilter" : {
"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
},
"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"
}
}
}
},
"VersionedObjectStateChangeRequest" : {
"type" : "object",
"properties" : {
"stateId" : {
"type" : "string",
"example" : 1
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"pagination" : {
"$ref" : "#/components/schemas/Pagination"
}
}
}
},
"securitySchemes" : {
"APIToken" : {
"type" : "http",
"scheme" : "bearer",
"bearerFormat" : "JWT"
}
}
}
}