{ "openapi": "3.0.1", "info": { "title": "TMF 633 Service Catalog Management", "description": "## TMF API Reference: TMF633 - Service Catalog Management### Release : 18.5-December 2018 Service Catalog API is one of Catalog Management API Family. Service Catalog API goal is to provide a catalog of services. ### Resource - serviceCatalog ### Operations Service Catalog API performs the following operations on the resource : - Retrieve an entity or a collection of entities depending on filter criteria - Partial update of an entity (including updating rules) - Create an entity (including default values and creation rules) - Delete an entity (for administration purposes) - Manage notification of events", "license": { "name": "Apache 2.0", "url": "https://osl.etsi.org" }, "version": "4.0.0" }, "externalDocs": { "description": "TMF API Tables", "url": "https://www.tmforum.org/oda/open-apis/table" }, "servers": [ { "url": "https://portal.openslice.eu/tmf-api", "description": "Generated server url" } ], "security": [ { "security_auth": [] } ], "tags": [ { "name": "serviceSpecification", "description": "the serviceSpecification API" }, { "name": "serviceCategory", "description": "the serviceCategory API" }, { "name": "listener", "description": "the listener API" }, { "name": "exportJob", "description": "the exportJob API" }, { "name": "importJob", "description": "the importJob API" }, { "name": "serviceCatalog", "description": "the serviceCatalog API" }, { "name": "hub", "description": "the hub API" }, { "name": "serviceCandidate", "description": "the serviceCandidate API" } ], "paths": { "/serviceCatalogManagement/v4/serviceSpecification": { "get": { "tags": [ "serviceSpecification" ], "summary": "List or find ServiceSpecification objects", "description": "This operation list or find ServiceSpecification entities", "operationId": "listServiceSpecification", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "post": { "tags": [ "serviceSpecification" ], "summary": "Creates a ServiceSpecification", "description": "This operation creates a ServiceSpecification entity.", "operationId": "createServiceSpecification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecificationCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}/attachment": { "post": { "tags": [ "serviceSpecification" ], "summary": "Adds an attachment to a ServiceSpecification", "description": "This operation adds an attachment to a ServiceSpecification and updates partially a ServiceSpecification entity", "operationId": "addAttachmentToServiceSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "afile" ], "type": "object", "properties": { "afile": { "type": "string", "description": "The Attachment file to be added", "format": "binary" } } } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } } } } }, "/serviceCatalogManagement/v4/serviceCategory": { "get": { "tags": [ "serviceCategory" ], "summary": "List or find ServiceCategory objects", "description": "This operation list or find ServiceCategory entities", "operationId": "listServiceCategory", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "413": { "description": "Not modifed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCategory" } } } } } } }, "post": { "tags": [ "serviceCategory" ], "summary": "Creates a ServiceCategory", "description": "This operation creates a ServiceCategory entity.", "operationId": "createServiceCategory", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategoryCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } } } } }, "/serviceCatalogManagement/v4/serviceCatalog": { "get": { "tags": [ "serviceCatalog" ], "summary": "List or find ServiceCatalog objects", "description": "This operation list or find ServiceCatalog entities", "operationId": "listServiceCatalog", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCatalog" } } } } } } }, "post": { "tags": [ "serviceCatalog" ], "summary": "Creates a ServiceCatalog", "description": "This operation creates a ServiceCatalog entity.", "operationId": "createServiceCatalog", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalogCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } } } } }, "/serviceCatalogManagement/v4/serviceCandidate": { "get": { "tags": [ "serviceCandidate" ], "summary": "List or find ServiceCandidate objects", "description": "This operation list or find ServiceCandidate entities", "operationId": "listServiceCandidate", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCandidate" } } } } } } }, "post": { "tags": [ "serviceCandidate" ], "summary": "Creates a ServiceCandidate", "description": "This operation creates a ServiceCandidate entity.", "operationId": "createServiceCandidate", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidateCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceSpecificationDeleteNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceSpecificationDeleteNotification", "description": "Example of a client listener for receiving the notification ServiceSpecificationDeleteNotification", "operationId": "listenToServiceSpecificationDeleteNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecificationDeleteNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceSpecificationCreateNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceSpecificationCreateNotification", "description": "Example of a client listener for receiving the notification ServiceSpecificationCreateNotification", "operationId": "listenToServiceSpecificationCreateNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecificationCreateNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceSpecificationChangeNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceSpecificationChangeNotification", "description": "Example of a client listener for receiving the notification ServiceSpecificationChangeNotification", "operationId": "listenToServiceSpecificationChangeNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecificationChangeNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCategoryDeleteNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCategoryDeleteNotification", "description": "Example of a client listener for receiving the notification ServiceCategoryDeleteNotification", "operationId": "listenToServiceCategoryDeleteNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategoryDeleteNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCategoryCreateNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCategoryCreateNotification", "description": "Example of a client listener for receiving the notification ServiceCategoryCreateNotification", "operationId": "listenToServiceCategoryCreateNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategoryCreateNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCategoryChangeNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCategoryChangeNotification", "description": "Example of a client listener for receiving the notification ServiceCategoryChangeNotification", "operationId": "listenToServiceCategoryChangeNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategoryChangeNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCatalogDeleteNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCatalogDeleteNotification", "description": "Example of a client listener for receiving the notification ServiceCatalogDeleteNotification", "operationId": "listenToServiceCatalogDeleteNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalogDeleteNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCatalogCreateNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCatalogCreateNotification", "description": "Example of a client listener for receiving the notification ServiceCatalogCreateNotification", "operationId": "listenToServiceCatalogCreateNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalogCreateNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCatalogChangeNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCatalogChangeNotification", "description": "Example of a client listener for receiving the notification ServiceCatalogChangeNotification", "operationId": "listenToServiceCatalogChangeNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalogChangeNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCatalogBatchNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCatalogBatchNotification", "description": "Example of a client listener for receiving the notification ServiceCatalogBatchNotification", "operationId": "listenToServiceCatalogBatchNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalogBatchNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCandidateDeleteNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCandidateDeleteNotification", "description": "Example of a client listener for receiving the notification ServiceCandidateDeleteNotification", "operationId": "listenToServiceCandidateDeleteNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidateDeleteNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCandidateCreateNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCandidateCreateNotification", "description": "Example of a client listener for receiving the notification ServiceCandidateCreateNotification", "operationId": "listenToServiceCandidateCreateNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidateCreateNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/listener/serviceCandidateChangeNotification": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceCandidateChangeNotification", "description": "Example of a client listener for receiving the notification ServiceCandidateChangeNotification", "operationId": "listenToServiceCandidateChangeNotification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidateChangeNotification" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/importJob": { "get": { "tags": [ "importJob" ], "summary": "List or find ImportJob objects", "description": "This operation list or find ImportJob entities", "operationId": "listImportJob", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } } } } } } }, "post": { "tags": [ "importJob" ], "summary": "Creates a ImportJob", "description": "This operation creates a ImportJob entity.", "operationId": "createImportJob", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJobCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } } } } }, "/serviceCatalogManagement/v4/hub": { "get": { "tags": [ "hub", "events subscription" ], "summary": "Get all registered listeners", "description": "Retrieves all registered event subscriptions", "operationId": "getListeners", "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscription" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscription" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscription" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscription" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "post": { "tags": [ "hub", "events subscription" ], "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "registerListener", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscriptionInput" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Subscribed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceCatalogManagement/v4/exportJob": { "get": { "tags": [ "exportJob" ], "summary": "List or find ExportJob objects", "description": "This operation list or find ExportJob entities", "operationId": "listExportJob", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportJob" } } } } } } }, "post": { "tags": [ "exportJob" ], "summary": "Creates a ExportJob", "description": "This operation creates a ExportJob entity.", "operationId": "createExportJob", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJobCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}": { "get": { "tags": [ "serviceSpecification" ], "summary": "Retrieves a ServiceSpecification by ID", "description": "This operation retrieves a ServiceSpecification entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } }, "delete": { "tags": [ "serviceSpecification" ], "summary": "Deletes a ServiceSpecification", "description": "This operation deletes a ServiceSpecification entity.", "operationId": "deleteServiceSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "serviceSpecification" ], "summary": "Updates partially a ServiceSpecification", "description": "This operation updates partially a ServiceSpecification entity.", "operationId": "patchServiceSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecificationUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceCategory/{id}": { "get": { "tags": [ "serviceCategory" ], "summary": "Retrieves a ServiceCategory by ID", "description": "This operation retrieves a ServiceCategory entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCategory", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } } } }, "delete": { "tags": [ "serviceCategory" ], "summary": "Deletes a ServiceCategory", "description": "This operation deletes a ServiceCategory entity.", "operationId": "deleteServiceCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCategory", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "serviceCategory" ], "summary": "Updates partially a ServiceCategory", "description": "This operation updates partially a ServiceCategory entity.", "operationId": "patchServiceCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCategory", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategoryUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCategory" } } } } } } }, "/serviceCatalogManagement/v4/serviceCatalog/{id}": { "get": { "tags": [ "serviceCatalog" ], "summary": "Retrieves a ServiceCatalog by ID", "description": "This operation retrieves a ServiceCatalog entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceCatalog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCatalog", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } } } }, "delete": { "tags": [ "serviceCatalog" ], "summary": "Deletes a ServiceCatalog", "description": "This operation deletes a ServiceCatalog entity.", "operationId": "deleteServiceCatalog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCatalog", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "serviceCatalog" ], "summary": "Updates partially a ServiceCatalog", "description": "This operation updates partially a ServiceCatalog entity.", "operationId": "patchServiceCatalog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCatalog", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalogUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCatalog" } } } } } } }, "/serviceCatalogManagement/v4/serviceCandidate/{id}": { "get": { "tags": [ "serviceCandidate" ], "summary": "Retrieves a ServiceCandidate by ID", "description": "This operation retrieves a ServiceCandidate entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceCandidate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCandidate", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } } } }, "delete": { "tags": [ "serviceCandidate" ], "summary": "Deletes a ServiceCandidate", "description": "This operation deletes a ServiceCandidate entity.", "operationId": "deleteServiceCandidate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCandidate", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "serviceCandidate" ], "summary": "Updates partially a ServiceCandidate", "description": "This operation updates partially a ServiceCandidate entity.", "operationId": "patchServiceCandidate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceCandidate", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidateUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceCandidate" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}/sd": { "get": { "tags": [ "serviceSpecification" ], "summary": "Retrieves a ServiceDescriptor by ServiceSpecification ID", "description": "This operation retrieves a Service Descriptor entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceSpecificationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceDescriptor" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}/relationship_graph": { "get": { "tags": [ "serviceSpecification" ], "summary": "Get a SVG image with specification relationship graph", "description": "This operation returns a SVG image with specification relationship graph", "operationId": "getImageSpecificationRelationshipGraph", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "302": { "description": "Success" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}/clone": { "get": { "tags": [ "serviceSpecification" ], "summary": "Clones a ServiceSpecification", "description": "This operation clones a ServiceSpecification entity. The response is the cloned spec", "operationId": "cloneServiceSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification to clone", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Cloned", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}/attachment/{attid}": { "get": { "tags": [ "serviceSpecification" ], "summary": "Get an attachment", "description": "This operation gets an attachment", "operationId": "getAttachment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } }, { "name": "attid", "in": "path", "description": "Identifier of the Attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "409": { "description": "Conflict", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "405": { "description": "Method Not allowed", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/{id}/attachment/{attid}/{afilename}": { "get": { "tags": [ "serviceSpecification" ], "summary": "Get an attachment with filename", "description": "This operation gets an attachment", "operationId": "getAttachmentWithFilename", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceSpecification", "required": true, "schema": { "type": "string" } }, { "name": "attid", "in": "path", "description": "Identifier of the Attachment", "required": true, "schema": { "type": "string" } }, { "name": "afilename", "in": "path", "description": "Identifier of the Filename", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "409": { "description": "Conflict", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "405": { "description": "Method Not allowed", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/specFromTestSpec/{id}": { "get": { "tags": [ "serviceSpecification" ], "summary": "Creates a ServiceSpecification from an ServiceTestSpecification id. It retreives the ServicTestSpecification from the ServiceTestSpecification catalog", "description": "This operation creates a ServiceSpecification from a ServiceTestSpecification id. It retreives the ServiceTestSpecification from the ServiceTestSpecification catalog. The response is the Service Spec", "operationId": "createServiceSpecificationFromServiceTestSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTestSpecification id from the ServiceTestSpecification catalog", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/specFromResourceSpec/{id}": { "get": { "tags": [ "serviceSpecification" ], "summary": "Creates a Resource Facing ServiceSpecification from a ResourceSpecification id. It retreives the ResourceSpecification from the ResourceSpecification catalog", "description": "This operation creates a Resource Facing ServiceSpecification from a ResourceSpecification id. It retreives the ResourceSpecification from the ResourceSpecification catalog. The response is the Service Spec", "operationId": "createServiceSpecificationFromResourceSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ResourceSpecification id from the ResourceSpecification catalog", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/specFromNSDID/{id}": { "get": { "tags": [ "serviceSpecification" ], "summary": "Creates a ServiceSpecification from an NSD id. It retreives the NSD from the NSD/VNF catalog", "description": "This operation creates a ServiceSpecification from an NSD id. It retreives the NSD from the NSD/VNF catalog. The response is the cloned spec", "operationId": "createServiceSpecificationFromNSDID", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the NSD id from the NSD/VNF catalog", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/cloneVINNI": { "get": { "tags": [ "serviceSpecification" ], "summary": "Clones a VINNI ServiceSpecification", "description": "This operation clones a ServiceSpecification 5G-VINNI entity. The response is the cloned spec", "operationId": "cloneVINNIServiceSpecification", "parameters": [ { "name": "serviceName", "in": "query", "description": "A name of the cloned VINNI Template", "required": true, "schema": { "type": "string" } }, { "name": "addServiceTopology", "in": "query", "description": "If true adds a Service Topology Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceRequirements", "in": "query", "description": "If true adds a Service Requirements Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceExposureLevel1", "in": "query", "description": "If true adds a Service Exposure Level1 Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceExposureLevel2", "in": "query", "description": "If true adds a Service Exposure Level2 Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceExposureLevel3", "in": "query", "description": "If true adds a Service Exposure Level3 Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceExposureLevel4", "in": "query", "description": "If true adds a Service Exposure Level4 Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceMonitoring", "in": "query", "description": "If true adds a Service Monitoring Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceTesting", "in": "query", "description": "If true adds a Service Testing Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceVNF", "in": "query", "description": "If true adds a Service 3rd party VNF Spec in the Bundle", "required": true, "schema": { "type": "boolean" } }, { "name": "addServiceNSD", "in": "query", "description": "If true adds a Service 3rd party NSD Spec in the Bundle", "required": true, "schema": { "type": "boolean" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Cloned", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/serviceSpecification/cloneGST": { "get": { "tags": [ "serviceSpecification" ], "summary": "Clones a GST ServiceSpecification", "description": "This operation clones a ServiceSpecification GST entity. The response is the cloned spec", "operationId": "cloneGSTServiceSpecification", "parameters": [ { "name": "serviceName", "in": "query", "description": "A name of the cloned GST", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "200": { "description": "Cloned", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceSpecification" } } } } } } }, "/serviceCatalogManagement/v4/importJob/{id}": { "get": { "tags": [ "importJob" ], "summary": "Retrieves a ImportJob by ID", "description": "This operation retrieves a ImportJob entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveImportJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ImportJob", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ImportJob" } } } } } }, "delete": { "tags": [ "importJob" ], "summary": "Deletes a ImportJob", "description": "This operation deletes a ImportJob entity.", "operationId": "deleteImportJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ImportJob", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } } }, "/serviceCatalogManagement/v4/exportJob/{id}": { "get": { "tags": [ "exportJob" ], "summary": "Retrieves a ExportJob by ID", "description": "This operation retrieves a ExportJob entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveExportJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ExportJob", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ExportJob" } } } } } }, "delete": { "tags": [ "exportJob" ], "summary": "Deletes a ExportJob", "description": "This operation deletes a ExportJob entity.", "operationId": "deleteExportJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ExportJob", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } } }, "/serviceCatalogManagement/v4/hub/{id}": { "delete": { "tags": [ "hub", "events subscription" ], "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "unregisterListener", "parameters": [ { "name": "id", "in": "path", "description": "The id of the registered listener", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "400": { "description": "Bad request" }, "204": { "description": "Deleted" }, "405": { "description": "Method not allowed" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "401": { "description": "Unauthorized" } } } } }, "components": { "schemas": { "Any": { "type": "object", "properties": { "value": { "type": "string" }, "alias": { "type": "string" } }, "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" }, "AttachmentRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "url": { "type": "string", "description": "Link to the attachment media/content" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures" }, "RelatedParty": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "role": { "type": "string", "description": "Role of the related party." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" }, "extendedInfo": { "type": "string" } }, "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." }, "ResourceSpecificationRef": { "type": "object", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "version": { "type": "string", "description": "Resource specification version" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" } }, "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification." }, "ServiceLevelSpecificationRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" } }, "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level Objectives. In addition, certain consequences are associated with not meeting the Service Level Objectives. Service Level Agreements are expressed in terms of Service Level Specifications." }, "ServiceSpecCharRelationship": { "type": "object", "properties": { "uuid": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "relationshipType": { "type": "string", "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "role": { "type": "string", "description": "The association role for this service specification" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics." }, "ServiceSpecCharacteristic": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "configurable": { "type": "boolean", "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" }, "description": { "type": "string", "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" }, "extensible": { "type": "boolean", "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." }, "isUnique": { "type": "boolean", "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality": { "type": "integer", "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.", "format": "int32" }, "minCardinality": { "type": "integer", "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.", "format": "int32" }, "regex": { "type": "string", "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "serviceSpecCharRelationship": { "uniqueItems": true, "type": "array", "description": "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", "items": { "$ref": "#/components/schemas/ServiceSpecCharRelationship" } }, "serviceSpecCharacteristicValue": { "uniqueItems": true, "type": "array", "description": "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", "items": { "$ref": "#/components/schemas/ServiceSpecCharacteristicValue" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@valueSchemaLocation": { "type": "string", "description": "This (optional) field provides a link to the schema describing the value type." }, "id": { "type": "string" } }, "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service." }, "ServiceSpecCharacteristicValue": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "isDefault": { "type": "boolean", "description": "Indicates if the value is the default value for a characteristic" }, "rangeInterval": { "type": "string", "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "regex": { "type": "string", "description": "A regular expression constraint for given value" }, "unitOfMeasure": { "type": "string", "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." }, "valueFrom": { "type": "integer", "description": "The low range value that a characteristic can take on", "format": "int32" }, "valueTo": { "type": "integer", "description": "The upper range value that a characteristic can take on", "format": "int32" }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "value": { "$ref": "#/components/schemas/Any" } }, "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on." }, "ServiceSpecRelationship": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string" }, "relationshipType": { "type": "string", "description": "Type of relationship such as migration, substitution, dependency, exclusivity" }, "role": { "type": "string", "description": "The association role for this service specification" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications." }, "ServiceSpecificationCreate": { "type": "object", "properties": { "description": { "type": "string", "description": "A narrative that explains in detail what the service specification is" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of the service specification" }, "name": { "type": "string", "description": "Name of the service specification" }, "version": { "type": "string", "description": "Service specification version" }, "attachment": { "type": "array", "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRef" } }, "relatedParty": { "type": "array", "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceSpecification": { "type": "array", "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", "items": { "$ref": "#/components/schemas/ResourceSpecificationRef" } }, "serviceLevelSpecification": { "type": "array", "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", "items": { "$ref": "#/components/schemas/ServiceLevelSpecificationRef" } }, "serviceSpecCharacteristic": { "type": "array", "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", "items": { "$ref": "#/components/schemas/ServiceSpecCharacteristic" } }, "serviceSpecRelationship": { "type": "array", "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", "items": { "$ref": "#/components/schemas/ServiceSpecRelationship" } }, "targetServiceSchema": { "$ref": "#/components/schemas/TargetServiceSchema" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "description": "The ServiceSpecification to be created" }, "TargetServiceSchema": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" } }, "description": "The reference object to the schema and type of target service which is described by service specification" }, "TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "ServiceSpecification": { "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." }, "attachment": { "uniqueItems": true, "type": "array", "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRef" } }, "relatedParty": { "uniqueItems": true, "type": "array", "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceSpecification": { "uniqueItems": true, "type": "array", "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", "items": { "$ref": "#/components/schemas/ResourceSpecificationRef" } }, "serviceLevelSpecification": { "uniqueItems": true, "type": "array", "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", "items": { "$ref": "#/components/schemas/ServiceLevelSpecificationRef" } }, "serviceSpecCharacteristic": { "uniqueItems": true, "type": "array", "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", "items": { "$ref": "#/components/schemas/ServiceSpecCharacteristic" } }, "serviceSpecRelationship": { "uniqueItems": true, "type": "array", "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", "items": { "$ref": "#/components/schemas/ServiceSpecRelationship" } }, "targetServiceSchema": { "$ref": "#/components/schemas/TargetServiceSchema" }, "id": { "type": "string" } }, "description": "ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics." }, "Attachment": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier for this particular attachment" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Complements the description of an element (for instance a product) through video, pictures..." }, "Quantity": { "type": "object", "properties": { "amount": { "type": "number", "description": "Numeric value in a given unit", "format": "float" }, "units": { "type": "string", "description": "Unit" } }, "description": "An amount in a given unit" }, "ServiceCandidateRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "version": { "type": "string", "description": "Version of the service candidate" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" } }, "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." }, "ServiceCategoryCreate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the category" }, "isRoot": { "type": "boolean", "description": "If true, this Boolean indicates that the category is a root of categories" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the category" }, "parentId": { "type": "string", "description": "Unique identifier of the parent category" }, "version": { "type": "string", "description": "ServiceCategory version" }, "category": { "type": "array", "description": "List of child categories in the tree for in this category", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "serviceCandidate": { "type": "array", "description": "List of service candidates associated with this category", "items": { "$ref": "#/components/schemas/ServiceCandidateRef" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "description": "The ServiceCategory to be created" }, "ServiceCategoryRef": { "type": "object", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" } }, "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories." }, "ServiceCategory": { "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "isRoot": { "type": "boolean", "description": "If true, this Boolean indicates that the category is a root of categories" }, "parentId": { "type": "string", "description": "Unique identifier of the parent category" }, "category": { "type": "array", "description": "List of child categories in the tree for in this category", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "serviceCandidate": { "type": "array", "description": "List of service candidates associated with this category", "items": { "$ref": "#/components/schemas/ServiceCandidateRef" } }, "id": { "type": "string" } }, "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories." }, "ServiceCatalogCreate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the service catalog" }, "version": { "type": "string", "description": "ServiceCatalog version" }, "category": { "type": "array", "description": "List of service categories associated with this catalog", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "relatedParty": { "type": "array", "description": "List of parties or party roles related to this category", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "description": "The ServiceCatalog to be created" }, "ServiceCatalog": { "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "relatedParty": { "type": "array", "description": "List of parties or party roles related to this category", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "id": { "type": "string" }, "category": { "type": "array", "description": "List of service categories associated with this catalog", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } } }, "description": "The root entity for service catalog management. A service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). A service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog. A ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none." }, "ServiceCandidateCreate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of this REST resource" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of the service candidate." }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "the version of service candidate" }, "category": { "type": "array", "description": "List of categories for this candidate", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecificationRef" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "description": "The ServiceCandidate to be created" }, "ServiceSpecificationRef": { "type": "object", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "version": { "type": "string", "description": "Service specification version" }, "targetServiceSchema": { "$ref": "#/components/schemas/TargetServiceSchema" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" } }, "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification." }, "ServiceCandidate": { "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecificationRef" }, "id": { "type": "string" }, "category": { "type": "array", "description": "The category specification implied by this candidate", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } } }, "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A ServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications." }, "ServiceSpecificationDeleteEvent": { "type": "object", "properties": { "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecification" } }, "description": "The event data structure" }, "ServiceSpecificationDeleteNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceSpecificationDeleteEvent" } }, "description": "The event data" }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "ServiceSpecificationCreateEvent": { "type": "object", "properties": { "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecification" } }, "description": "The event data structure" }, "ServiceSpecificationCreateNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceSpecificationCreateEvent" } }, "description": "The event data" }, "ServiceSpecificationChangeEvent": { "type": "object", "properties": { "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecification" } }, "description": "The event data structure" }, "ServiceSpecificationChangeNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceSpecificationChangeEvent" } }, "description": "The event data" }, "ServiceCategoryDeleteEvent": { "type": "object", "properties": { "serviceCategory": { "$ref": "#/components/schemas/ServiceCategory" } }, "description": "The event data structure" }, "ServiceCategoryDeleteNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCategoryDeleteEvent" } }, "description": "The event data" }, "ServiceCategoryCreateEvent": { "type": "object", "properties": { "serviceCategory": { "$ref": "#/components/schemas/ServiceCategory" } }, "description": "The event data structure" }, "ServiceCategoryCreateNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCategoryCreateEvent" } }, "description": "The event data" }, "ServiceCategoryChangeEvent": { "type": "object", "properties": { "serviceCategory": { "$ref": "#/components/schemas/ServiceCategory" } }, "description": "The event data structure" }, "ServiceCategoryChangeNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCategoryChangeEvent" } }, "description": "The event data" }, "ServiceCatalogDeleteEvent": { "type": "object", "properties": { "serviceCatalog": { "$ref": "#/components/schemas/ServiceCatalog" } }, "description": "The event data structure" }, "ServiceCatalogDeleteNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCatalogDeleteEvent" } }, "description": "The event data" }, "ServiceCatalogCreateEvent": { "type": "object", "properties": { "serviceCatalog": { "$ref": "#/components/schemas/ServiceCatalog" } }, "description": "The event data structure" }, "ServiceCatalogCreateNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCatalogCreateEvent" } }, "description": "The event data" }, "ServiceCatalogChangeEvent": { "type": "object", "properties": { "serviceCatalog": { "$ref": "#/components/schemas/ServiceCatalog" } }, "description": "The event data structure" }, "ServiceCatalogChangeNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCatalogChangeEvent" } }, "description": "The event data" }, "ServiceCatalogBatchEvent": { "type": "object", "properties": { "serviceCatalog": { "$ref": "#/components/schemas/ServiceCatalog" } }, "description": "The event data structure" }, "ServiceCatalogBatchNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCatalogBatchEvent" } }, "description": "The event data" }, "ServiceCandidateDeleteEvent": { "type": "object", "properties": { "serviceCandidate": { "$ref": "#/components/schemas/ServiceCandidate" } }, "description": "The event data structure" }, "ServiceCandidateDeleteNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCandidateDeleteEvent" } }, "description": "The event data" }, "ServiceCandidateCreateEvent": { "type": "object", "properties": { "serviceCandidate": { "$ref": "#/components/schemas/ServiceCandidate" } }, "description": "The event data structure" }, "ServiceCandidateCreateNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCandidateCreateEvent" } }, "description": "The event data" }, "ServiceCandidateChangeEvent": { "type": "object", "properties": { "serviceCandidate": { "$ref": "#/components/schemas/ServiceCandidate" } }, "description": "The event data structure" }, "ServiceCandidateChangeNotification": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification" }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification" }, "resourcePath": { "type": "string", "description": "The path identifying the resource object concerned by this notification" }, "event": { "$ref": "#/components/schemas/ServiceCandidateChangeEvent" } }, "description": "The event data" }, "ImportJobCreate": { "required": [ "url" ], "type": "object", "properties": { "completionDate": { "type": "string", "format": "date-time" }, "contentType": { "type": "string", "description": "Indicates the format of the imported data" }, "creationDate": { "type": "string", "format": "date-time" }, "errorLog": { "type": "string", "description": "Reason for failure if status is failed" }, "path": { "type": "string", "description": "URL of the root resource where the content of the file specified by the import job must be applied" }, "status": { "type": "string", "description": "Status of the import job (not started, running, succeeded, failed)" }, "url": { "type": "string", "description": "URL of the file containing the data to be imported" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The ImportJob to be created" }, "ImportJob": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the import job" }, "href": { "type": "string", "description": "Reference of the import job" }, "completionDate": { "type": "string", "format": "date-time" }, "contentType": { "type": "string", "description": "Indicates the format of the imported data" }, "creationDate": { "type": "string", "format": "date-time" }, "errorLog": { "type": "string", "description": "Reason for failure if status is failed" }, "path": { "type": "string", "description": "URL of the root resource where the content of the file specified by the import job must be applied" }, "status": { "type": "string", "description": "Status of the import job (not started, running, succeeded, failed)" }, "url": { "type": "string", "description": "URL of the file containing the data to be imported" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Represents a task used to import resources from a file" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Data containing the callback endpoint to deliver the information" }, "ExportJobCreate": { "required": [ "url" ], "type": "object", "properties": { "completionDate": { "type": "string", "format": "date-time" }, "contentType": { "type": "string", "description": "The format of the exported data" }, "creationDate": { "type": "string", "format": "date-time" }, "errorLog": { "type": "string", "description": "Reason for failure" }, "path": { "type": "string", "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" }, "query": { "type": "string", "description": "Used to scope the exported data" }, "status": { "type": "string", "description": "Status of the export job (not started, running, succeeded, failed)" }, "url": { "type": "string", "description": "URL of the file containing the data to be exported" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The ExportJob to be created" }, "ExportJob": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the export job" }, "href": { "type": "string", "description": "Reference of the export job" }, "completionDate": { "type": "string", "format": "date-time" }, "contentType": { "type": "string", "description": "The format of the exported data" }, "creationDate": { "type": "string", "format": "date-time" }, "errorLog": { "type": "string", "description": "Reason for failure" }, "path": { "type": "string", "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" }, "query": { "type": "string", "description": "Used to scope the exported data" }, "status": { "type": "string", "description": "Status of the export job (not started, running, succeeded, failed)" }, "url": { "type": "string", "description": "URL of the file containing the data to be exported" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Represents a task used to export resources to a file" }, "ServiceSpecificationUpdate": { "type": "object", "properties": { "description": { "type": "string", "description": "A narrative that explains in detail what the service specification is" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of the service specification" }, "name": { "type": "string", "description": "Name of the service specification" }, "version": { "type": "string", "description": "Service specification version" }, "attachment": { "type": "array", "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRef" } }, "relatedParty": { "type": "array", "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceSpecification": { "type": "array", "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", "items": { "$ref": "#/components/schemas/ResourceSpecificationRef" } }, "serviceLevelSpecification": { "type": "array", "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", "items": { "$ref": "#/components/schemas/ServiceLevelSpecificationRef" } }, "serviceSpecCharacteristic": { "type": "array", "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", "items": { "$ref": "#/components/schemas/ServiceSpecCharacteristic" } }, "serviceSpecRelationship": { "type": "array", "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", "items": { "$ref": "#/components/schemas/ServiceSpecRelationship" } }, "targetServiceSchema": { "$ref": "#/components/schemas/TargetServiceSchema" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The ServiceSpecification to be updated" }, "ServiceCategoryUpdate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the category" }, "isRoot": { "type": "boolean", "description": "If true, this Boolean indicates that the category is a root of categories" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the category" }, "parentId": { "type": "string", "description": "Unique identifier of the parent category" }, "version": { "type": "string", "description": "ServiceCategory version" }, "category": { "type": "array", "description": "List of child categories in the tree for in this category", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "serviceCandidate": { "type": "array", "description": "List of service candidates associated with this category", "items": { "$ref": "#/components/schemas/ServiceCandidateRef" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The ServiceCategory to be updated" }, "ServiceCatalogUpdate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the service catalog" }, "version": { "type": "string", "description": "ServiceCatalog version" }, "category": { "type": "array", "description": "List of service categories associated with this catalog", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "relatedParty": { "type": "array", "description": "List of parties or party roles related to this category", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The ServiceCatalog to be updated" }, "ServiceCandidateUpdate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of this REST resource" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of the service candidate." }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "the version of service candidate" }, "category": { "type": "array", "description": "List of categories for this candidate", "items": { "$ref": "#/components/schemas/ServiceCategoryRef" } }, "serviceSpecification": { "$ref": "#/components/schemas/ServiceSpecificationRef" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The ServiceCandidate to be updated" }, "ServiceDescriptor": { "type": "object", "properties": { "uuid": { "type": "string" }, "metadata": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ServiceDescriptorAttr" } }, "rootEntityID": { "type": "string" }, "rootEntityType": { "type": "string" } }, "description": "This model will hold information that will help later on service orchestration." }, "ServiceDescriptorAttr": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } } } }, "securitySchemes": { "security_auth": { "type": "oauth2", "scheme": "bearer", "bearerFormat": "JWT", "flows": { "authorizationCode": { "authorizationUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/auth", "tokenUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/token", "scopes": { "read": "read scope", "write": "write scope" } } } } } } }