{ "openapi": "3.0.1", "info": { "title": "TMF 620 Product Catalog Management", "description": "## TMF API Reference: TMF620 - Product Catalog Management ### Release : 19.0 - June 2019 Product Catalog API is one of Catalog Management API Family. Product Catalog API goal is to provide a catalog of products. ### Operations Product Catalog API performs the following operations on the resources : - 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 - 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": "catalog", "description": "the catalog API" }, { "name": "productSpecification", "description": "the productSpecification API" }, { "name": "listener", "description": "the listener API" }, { "name": "exportJob", "description": "the exportJob API" }, { "name": "productOffering", "description": "the productOffering API" }, { "name": "importJob", "description": "the importJob API" }, { "name": "category", "description": "the category API" }, { "name": "hub", "description": "the hub API" }, { "name": "productOfferingPrice", "description": "the productOfferingPrice API" } ], "paths": { "/productCatalogManagement/v4/productSpecification": { "get": { "tags": [ "productSpecification" ], "summary": "List or find ProductSpecification objects", "description": "This operation list or find ProductSpecification entities", "operationId": "listProductSpecification", "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/ProductSpecification" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" } } } } } } }, "post": { "tags": [ "productSpecification" ], "summary": "Creates a ProductSpecification", "description": "This operation creates a ProductSpecification entity.", "operationId": "createProductSpecification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecificationCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } } } } }, "/productCatalogManagement/v4/productOffering": { "get": { "tags": [ "productOffering" ], "summary": "List or find ProductOffering objects", "description": "This operation list or find ProductOffering entities", "operationId": "listProductOffering", "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/ProductOffering" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } } } }, "post": { "tags": [ "productOffering" ], "summary": "Creates a ProductOffering", "description": "This operation creates a ProductOffering entity.", "operationId": "createProductOffering", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } } } } }, "/productCatalogManagement/v4/productOfferingPrice": { "get": { "tags": [ "productOfferingPrice" ], "summary": "List or find ProductOfferingPrice objects", "description": "This operation list or find ProductOfferingPrice entities", "operationId": "listProductOfferingPrice", "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/ProductOfferingPrice" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } } } }, "post": { "tags": [ "productOfferingPrice" ], "summary": "Creates a ProductOfferingPrice", "description": "This operation creates a ProductOfferingPrice entity.", "operationId": "createProductOfferingPrice", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPriceCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } } } }, "/productCatalogManagement/v4/productOffering/fromServiceSpecId/{id}": { "post": { "tags": [ "productOffering" ], "summary": "Creates and Retrieves a ProductOffering by ID", "description": "This operation retrieves a ProductOffering entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveProductOffering", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOffering", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } } } } }, "/productCatalogManagement/v4/listener/productSpecificationDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductSpecificationDeleteEvent", "description": "Example of a client listener for receiving the notification ProductSpecificationDeleteEvent", "operationId": "listenToProductSpecificationDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecificationDeleteEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productSpecificationCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductSpecificationCreateEvent", "description": "Example of a client listener for receiving the notification ProductSpecificationCreateEvent", "operationId": "listenToProductSpecificationCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecificationCreateEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingStateChangeEvent", "description": "Example of a client listener for receiving the notification ProductOfferingStateChangeEvent", "operationId": "listenToProductOfferingStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingStateChangeEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingPriceStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingPriceStateChangeEvent", "description": "Example of a client listener for receiving the notification ProductOfferingPriceStateChangeEvent", "operationId": "listenToProductOfferingPriceStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPriceStateChangeEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingPriceDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingPriceDeleteEvent", "description": "Example of a client listener for receiving the notification ProductOfferingPriceDeleteEvent", "operationId": "listenToProductOfferingPriceDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPriceDeleteEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingPriceCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingPriceCreateEvent", "description": "Example of a client listener for receiving the notification ProductOfferingPriceCreateEvent", "operationId": "listenToProductOfferingPriceCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPriceCreateEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingPriceAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingPriceAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification ProductOfferingPriceAttributeValueChangeEvent", "operationId": "listenToProductOfferingPriceAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPriceAttributeValueChangeEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingDeleteEvent", "description": "Example of a client listener for receiving the notification ProductOfferingDeleteEvent", "operationId": "listenToProductOfferingDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingDeleteEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingCreateEvent", "description": "Example of a client listener for receiving the notification ProductOfferingCreateEvent", "operationId": "listenToProductOfferingCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingCreateEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/productOfferingAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ProductOfferingAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification ProductOfferingAttributeValueChangeEvent", "operationId": "listenToProductOfferingAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingAttributeValueChangeEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/categoryDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CategoryDeleteEvent", "description": "Example of a client listener for receiving the notification CategoryDeleteEvent", "operationId": "listenToCategoryDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CategoryDeleteEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/categoryCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CategoryCreateEvent", "description": "Example of a client listener for receiving the notification CategoryCreateEvent", "operationId": "listenToCategoryCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CategoryCreateEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/catalogDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CatalogDeleteEvent", "description": "Example of a client listener for receiving the notification CatalogDeleteEvent", "operationId": "listenToCatalogDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CatalogDeleteEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/catalogCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CatalogCreateEvent", "description": "Example of a client listener for receiving the notification CatalogCreateEvent", "operationId": "listenToCatalogCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CatalogCreateEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/v4/listener/catalogBatchEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CatalogBatchEvent", "description": "Example of a client listener for receiving the notification CatalogBatchEvent", "operationId": "listenToCatalogBatchEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CatalogBatchEvent" } } }, "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" } } } } } } }, "/productCatalogManagement/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" } } } } } } }, "/productCatalogManagement/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" } } } } } } }, "/productCatalogManagement/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" } } } } } } }, "/productCatalogManagement/v4/category": { "get": { "tags": [ "category" ], "summary": "List or find Category objects", "description": "This operation list or find Category entities", "operationId": "listCategory", "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/Category" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } }, "post": { "tags": [ "category" ], "summary": "Creates a Category", "description": "This operation creates a Category entity.", "operationId": "createCategory", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CategoryCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } } } } }, "/productCatalogManagement/v4/catalog": { "get": { "tags": [ "catalog" ], "summary": "List or find Catalog objects", "description": "This operation list or find Catalog entities", "operationId": "listCatalog", "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/Catalog" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } } } } }, "post": { "tags": [ "catalog" ], "summary": "Creates a Catalog", "description": "This operation creates a Catalog entity.", "operationId": "createCatalog", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CatalogCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } } } } }, "/productCatalogManagement/v4/productSpecification/{id}": { "get": { "tags": [ "productSpecification" ], "summary": "Retrieves a ProductSpecification by ID", "description": "This operation retrieves a ProductSpecification entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveProductSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductSpecification", "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/ProductSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } } } }, "delete": { "tags": [ "productSpecification" ], "summary": "Deletes a ProductSpecification", "description": "This operation deletes a ProductSpecification entity.", "operationId": "deleteProductSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductSpecification", "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": [ "productSpecification" ], "summary": "Updates partially a ProductSpecification", "description": "This operation updates partially a ProductSpecification entity.", "operationId": "patchProductSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductSpecification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecificationUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductSpecification" } } } } } } }, "/productCatalogManagement/v4/productOfferingPrice/{id}": { "get": { "tags": [ "productOfferingPrice" ], "summary": "Retrieves a ProductOfferingPrice by ID", "description": "This operation retrieves a ProductOfferingPrice entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveProductOfferingPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOfferingPrice", "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/ProductOfferingPrice" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } } }, "delete": { "tags": [ "productOfferingPrice" ], "summary": "Deletes a ProductOfferingPrice", "description": "This operation deletes a ProductOfferingPrice entity.", "operationId": "deleteProductOfferingPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOfferingPrice", "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": [ "productOfferingPrice" ], "summary": "Updates partially a ProductOfferingPrice", "description": "This operation updates partially a ProductOfferingPrice entity.", "operationId": "patchProductOfferingPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOfferingPrice", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPriceUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } } } } }, "/productCatalogManagement/v4/productOffering/{id}": { "get": { "tags": [ "productOffering" ], "summary": "Retrieves a ProductOffering by ID", "description": "This operation retrieves a ProductOffering entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveProductOffering_1", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOffering", "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/ProductOffering" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } } } }, "delete": { "tags": [ "productOffering" ], "summary": "Deletes a ProductOffering", "description": "This operation deletes a ProductOffering entity.", "operationId": "deleteProductOffering", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOffering", "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": [ "productOffering" ], "summary": "Updates partially a ProductOffering", "description": "This operation updates partially a ProductOffering entity.", "operationId": "patchProductOffering", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ProductOffering", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOfferingUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductOffering" } } } } } } }, "/productCatalogManagement/v4/category/{id}": { "get": { "tags": [ "category" ], "summary": "Retrieves a Category by ID", "description": "This operation retrieves a Category entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Category", "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/Category" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } } } }, "delete": { "tags": [ "category" ], "summary": "Deletes a Category", "description": "This operation deletes a Category entity.", "operationId": "deleteCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Category", "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": [ "category" ], "summary": "Updates partially a Category", "description": "This operation updates partially a Category entity.", "operationId": "patchCategory", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Category", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CategoryUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Category" } } } } } } }, "/productCatalogManagement/v4/catalog/{id}": { "get": { "tags": [ "catalog" ], "summary": "Retrieves a Catalog by ID", "description": "This operation retrieves a Catalog entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveCatalog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Catalog", "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/Catalog" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } } } }, "delete": { "tags": [ "catalog" ], "summary": "Deletes a Catalog", "description": "This operation deletes a Catalog entity.", "operationId": "deleteCatalog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Catalog", "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": [ "catalog" ], "summary": "Updates partially a Catalog", "description": "This operation updates partially a Catalog entity.", "operationId": "patchCatalog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Catalog", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CatalogUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Catalog" } } } } } } }, "/productCatalogManagement/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" } } } }, "/productCatalogManagement/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" } } } }, "/productCatalogManagement/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" }, "AttachmentRefOrValue": { "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@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", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture", "example": "video" }, "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", "example": "Photograph of the Product" }, "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)", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@referredType": { "type": "string" } }, "description": "An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture." }, "BundledProductSpecification": { "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": "Reference of the product specification" }, "name": { "type": "string", "description": "Name of the product specification" }, "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" }, "id": { "type": "string", "description": "Unique identifier of the product specification" } }, "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." }, "ProductSpecificationCharacteristic": { "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" }, "configurable": { "type": "boolean", "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" }, "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 a product" }, "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" }, "productSpecCharRelationship": { "uniqueItems": true, "type": "array", "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicRelationship" } }, "productSpecCharacteristicValue": { "uniqueItems": true, "type": "array", "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValue" } } }, "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." }, "ProductSpecificationCharacteristicRelationship": { "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" }, "id": { "type": "string", "description": "the identifier of the associated product specification" }, "charSpecSeq": { "type": "integer", "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications. For example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third.", "format": "int32" }, "relationshipType": { "type": "string", "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" } }, "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics." }, "ProductSpecificationCharacteristicValue": { "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": "Regular expression to define constraint on the allowed 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": "string", "description": "The low range value that a characteristic can take on" }, "valueTo": { "type": "string", "description": "The upper range value that a characteristic can take on" }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" }, "value": { "$ref": "#/components/schemas/Any" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." }, "ProductSpecificationCreate": { "type": "object", "properties": { "brand": { "type": "string", "description": "The manufacturer or trademark of the specification" }, "description": { "type": "string", "description": "A narrative that explains in detail what the product specification is" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the product specification" }, "productNumber": { "type": "string", "description": "An identification number assigned to uniquely identity the specification" }, "version": { "type": "string", "description": "Product specification version" }, "attachment": { "type": "array", "description": "Complements the description of an element (for instance a product) through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "bundledProductSpecification": { "type": "array", "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", "items": { "$ref": "#/components/schemas/BundledProductSpecification" } }, "productSpecCharacteristic": { "type": "array", "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristic" } }, "productSpecificationRelationship": { "type": "array", "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", "items": { "$ref": "#/components/schemas/ProductSpecificationRelationship" } }, "relatedParty": { "type": "array", "description": "A related party defines party or party role linked to a specific entity.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceSpecification": { "type": "array", "description": "The ResourceSpecification is required to realize a ProductSpecification.", "items": { "$ref": "#/components/schemas/ResourceSpecificationRef" } }, "serviceSpecification": { "type": "array", "description": "ServiceSpecification(s) required to realize a ProductSpecification.", "items": { "$ref": "#/components/schemas/ServiceSpecificationRef" } }, "targetProductSchema": { "$ref": "#/components/schemas/TargetProductSchema" }, "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 ProductSpecification to be created" }, "ProductSpecificationRelationship": { "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" }, "id": { "type": "string", "description": "Unique identifier of the productSpecification" }, "relationshipType": { "type": "string", "description": "Type of relationship such as migration, substitution, dependency, exclusivity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." }, "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" }, "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." }, "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." }, "TargetProductSchema": { "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" } }, "description": "The reference object to the schema and type of target product which is described by product specification" }, "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" }, "ProductSpecification": { "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" }, "id": { "type": "string", "description": "Unique identifier of the product specification" }, "brand": { "type": "string", "description": "The manufacturer or trademark of the specification" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." }, "productNumber": { "type": "string", "description": "An identification number assigned to uniquely identity the specification" }, "attachment": { "uniqueItems": true, "type": "array", "description": "Complements the description of an element (for instance a product) through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "bundledProductSpecification": { "uniqueItems": true, "type": "array", "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", "items": { "$ref": "#/components/schemas/BundledProductSpecification" } }, "productSpecCharacteristic": { "uniqueItems": true, "type": "array", "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristic" } }, "productSpecificationRelationship": { "uniqueItems": true, "type": "array", "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", "items": { "$ref": "#/components/schemas/ProductSpecificationRelationship" } }, "relatedParty": { "uniqueItems": true, "type": "array", "description": "A related party defines party or party role linked to a specific entity.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceSpecification": { "uniqueItems": true, "type": "array", "description": "The ResourceSpecification is required to realize a ProductSpecification.", "items": { "$ref": "#/components/schemas/ResourceSpecificationRef" } }, "serviceSpecification": { "uniqueItems": true, "type": "array", "description": "ServiceSpecification(s) required to realize a ProductSpecification.", "items": { "$ref": "#/components/schemas/ServiceSpecificationRef" } }, "targetProductSchema": { "$ref": "#/components/schemas/TargetProductSchema" } }, "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." }, "AgreementRef": { "required": [ "id" ], "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": "Identifier of the agreement" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." }, "BundledProductOffering": { "required": [ "id" ], "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 BundledProductOffering" }, "name": { "type": "string", "description": "Name of the BundledProductOffering" }, "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" }, "id": { "type": "string", "description": "Unique identifier of a related entity." }, "bundledProductOfferingOption": { "$ref": "#/components/schemas/BundledProductOfferingOption" } }, "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." }, "BundledProductOfferingOption": { "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" }, "numberRelOfferDefault": { "type": "integer", "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering", "format": "int32" }, "numberRelOfferLowerLimit": { "type": "integer", "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering", "format": "int32" }, "numberRelOfferUpperLimit": { "type": "integer", "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering", "format": "int32" } }, "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded" }, "CategoryRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of a related entity." }, "version": { "type": "string" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "The category for grouping recommendations" }, "ChannelRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of a related entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.." }, "MarketSegmentRef": { "required": [ "id" ], "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 of the market segment" }, "@referredType": { "type": "string", "description": "(Class) type of the referred market segment" } }, "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." }, "PlaceRef": { "required": [ "id" ], "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 of a related entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered." }, "ProductOfferingCreate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the productOffering" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." }, "isSellable": { "type": "boolean", "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the productOffering" }, "statusReason": { "type": "string", "description": "A string providing a complementary information on the value of the lifecycle status attribute." }, "version": { "type": "string", "description": "ProductOffering version" }, "agreement": { "type": "array", "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "items": { "$ref": "#/components/schemas/AgreementRef" } }, "attachment": { "type": "array", "description": "Complements the description of an element (for instance a product) through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "bundledProductOffering": { "type": "array", "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "category": { "type": "array", "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "channel": { "type": "array", "description": "The channel defines the channel for selling product offerings.", "items": { "$ref": "#/components/schemas/ChannelRef" } }, "marketSegment": { "type": "array", "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", "items": { "$ref": "#/components/schemas/MarketSegmentRef" } }, "place": { "type": "array", "description": "Place defines the places where the products are sold or delivered.", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "prodSpecCharValueUse": { "type": "array", "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValueUse" } }, "productOfferingPrice": { "type": "array", "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer.", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRef" } }, "productOfferingTerm": { "type": "array", "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", "items": { "$ref": "#/components/schemas/ProductOfferingTerm" } }, "productSpecification": { "$ref": "#/components/schemas/ProductSpecificationRef" }, "resourceCandidate": { "$ref": "#/components/schemas/ResourceCandidateRef" }, "serviceCandidate": { "$ref": "#/components/schemas/ServiceCandidateRef" }, "serviceLevelAgreement": { "$ref": "#/components/schemas/SLARef" }, "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 ProductOffering to be created" }, "ProductOfferingPriceRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of a related entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased" }, "ProductOfferingTerm": { "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" }, "duration": { "$ref": "#/components/schemas/Quantity" } }, "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." }, "ProductSpecificationCharacteristicValueUse": { "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" }, "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" }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "productSpecCharacteristicValue": { "uniqueItems": true, "type": "array", "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValue" } }, "productSpecification": { "$ref": "#/components/schemas/ProductSpecificationRef" } }, "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." }, "ProductSpecificationRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of a related entity." }, "targetProductSchema": { "$ref": "#/components/schemas/TargetProductSchema" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." }, "ResourceCandidateRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of the resource candidate" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog." }, "SLARef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of service level agreement" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." }, "ServiceCandidateRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of the service candidate" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." }, "ProductOffering": { "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" }, "id": { "type": "string", "description": "Unique identifier of the productOffering" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." }, "isSellable": { "type": "boolean", "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." }, "statusReason": { "type": "string", "description": "A string providing a complementary information on the value of the lifecycle status attribute." }, "agreement": { "uniqueItems": true, "type": "array", "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "items": { "$ref": "#/components/schemas/AgreementRef" } }, "attachment": { "uniqueItems": true, "type": "array", "description": "Complements the description of an element (for instance a product) through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "bundledProductOffering": { "uniqueItems": true, "type": "array", "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "category": { "uniqueItems": true, "type": "array", "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "channel": { "uniqueItems": true, "type": "array", "description": "The channel defines the channel for selling product offerings.", "items": { "$ref": "#/components/schemas/ChannelRef" } }, "marketSegment": { "uniqueItems": true, "type": "array", "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", "items": { "$ref": "#/components/schemas/MarketSegmentRef" } }, "place": { "uniqueItems": true, "type": "array", "description": "Place defines the places where the products are sold or delivered.", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "prodSpecCharValueUse": { "uniqueItems": true, "type": "array", "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValueUse" } }, "productOfferingPrice": { "uniqueItems": true, "type": "array", "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer.", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRef" } }, "productOfferingTerm": { "uniqueItems": true, "type": "array", "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", "items": { "$ref": "#/components/schemas/ProductOfferingTerm" } }, "productSpecification": { "$ref": "#/components/schemas/ProductSpecificationRef" }, "resourceCandidate": { "$ref": "#/components/schemas/ResourceCandidateRef" }, "serviceCandidate": { "$ref": "#/components/schemas/ServiceCandidateRef" }, "serviceLevelAgreement": { "$ref": "#/components/schemas/SLARef" } }, "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "BundledProductOfferingPriceRelationship": { "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" }, "id": { "type": "string", "description": "Unique identifier of the bundled product offering price" } }, "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge)." }, "ConstraintRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "reference id to the target constraint" }, "@referredType": { "type": "string", "description": "The (class) type of the referred constraint" } }, "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec." }, "Money": { "type": "object", "properties": { "unit": { "type": "string", "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" }, "value": { "type": "number", "description": "A positive floating point number", "format": "float" } }, "description": "A base / value business entity used to represent money" }, "PricingLogicAlgorithm": { "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" }, "id": { "type": "string", "description": "unique id of the PricingLogicAlgorithm" }, "plaSpecId": { "type": "string", "description": "id of corresponding PricingLogicAlgorithm specification" } }, "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)" }, "ProductOfferingPriceCreate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the productOfferingPrice" }, "isBundle": { "type": "boolean", "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" }, "lifecycleStatus": { "type": "string", "description": "the lifecycle status of this ProductOfferingPrice" }, "name": { "type": "string", "description": "Name of the productOfferingPrice" }, "percentage": { "type": "number", "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)", "format": "float" }, "priceType": { "type": "string", "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." }, "recurringChargePeriodLength": { "type": "integer", "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable", "format": "int32" }, "recurringChargePeriodType": { "type": "string", "description": "The period to repeat the application of the price Could be month, week..." }, "version": { "type": "string", "description": "ProductOffering version" }, "bundledPopRelationship": { "type": "array", "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship.", "items": { "$ref": "#/components/schemas/BundledProductOfferingPriceRelationship" } }, "constraint": { "type": "array", "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice.", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "place": { "type": "array", "description": "Place defines the places where the products are sold or delivered.", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "popRelationship": { "type": "array", "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRelationship" } }, "price": { "$ref": "#/components/schemas/Money" }, "pricingLogicAlgorithm": { "type": "array", "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth).", "items": { "$ref": "#/components/schemas/PricingLogicAlgorithm" } }, "prodSpecCharValueUse": { "type": "array", "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValueUse" } }, "productOfferingTerm": { "type": "array", "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods.", "items": { "$ref": "#/components/schemas/ProductOfferingTerm" } }, "tax": { "type": "array", "description": "An amount of money levied on the price of a Product by a legislative body.", "items": { "$ref": "#/components/schemas/TaxItem" } }, "unitOfMeasure": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "the immediate base class type of this product offering" }, "@schemaLocation": { "type": "string", "description": "hyperlink reference to the schema describing this resource" }, "@type": { "type": "string", "description": "The class type of this Product offering" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "description": "The ProductOfferingPrice to be created" }, "ProductOfferingPriceRelationship": { "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" }, "id": { "type": "string", "description": "Unique identifier of the associated product offering price" }, "relationshipType": { "type": "string", "description": "type of the relationship, for example override, discount, etc." } }, "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price." }, "TaxItem": { "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" }, "taxCategory": { "type": "string", "description": "Tax category" }, "taxRate": { "type": "number", "description": "Applied rate of the tax", "format": "float" }, "taxAmount": { "$ref": "#/components/schemas/Money" } }, "description": "A tax item is created for each tax rate and tax type used in the bill." }, "ProductOfferingPrice": { "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" }, "id": { "type": "string", "description": "unique id of this resource" }, "isBundle": { "type": "boolean", "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" }, "percentage": { "type": "number", "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)", "format": "float" }, "priceType": { "type": "string", "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." }, "recurringChargePeriodLength": { "type": "integer", "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable", "format": "int32" }, "recurringChargePeriodType": { "type": "string", "description": "The period to repeat the application of the price Could be month, week..." }, "bundledPopRelationship": { "uniqueItems": true, "type": "array", "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship.", "items": { "$ref": "#/components/schemas/BundledProductOfferingPriceRelationship" } }, "constraint": { "uniqueItems": true, "type": "array", "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice.", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "place": { "uniqueItems": true, "type": "array", "description": "Place defines the places where the products are sold or delivered.", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "popRelationship": { "uniqueItems": true, "type": "array", "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRelationship" } }, "price": { "$ref": "#/components/schemas/Money" }, "pricingLogicAlgorithm": { "uniqueItems": true, "type": "array", "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth).", "items": { "$ref": "#/components/schemas/PricingLogicAlgorithm" } }, "prodSpecCharValueUse": { "uniqueItems": true, "type": "array", "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValueUse" } }, "productOfferingTerm": { "uniqueItems": true, "type": "array", "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods.", "items": { "$ref": "#/components/schemas/ProductOfferingTerm" } }, "tax": { "uniqueItems": true, "type": "array", "description": "An amount of money levied on the price of a Product by a legislative body.", "items": { "$ref": "#/components/schemas/TaxItem" } }, "unitOfMeasure": { "$ref": "#/components/schemas/Quantity" } }, "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment." }, "ProductSpecificationDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductSpecificationDeleteEventPayload" } }, "description": "The event data" }, "ProductSpecificationDeleteEventPayload": { "type": "object", "properties": { "productSpecification": { "$ref": "#/components/schemas/ProductSpecification" } }, "description": "The event data structure" }, "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" }, "ProductSpecificationCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductSpecificationCreateEventPayload" } }, "description": "The event data" }, "ProductSpecificationCreateEventPayload": { "type": "object", "properties": { "productSpecification": { "$ref": "#/components/schemas/ProductSpecification" } }, "description": "The event data structure" }, "ProductOfferingStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductOfferingStateChangeEventPayload" } }, "description": "The event data" }, "ProductOfferingStateChangeEventPayload": { "type": "object", "properties": { "productOffering": { "$ref": "#/components/schemas/ProductOffering" } }, "description": "The event data structure" }, "ProductOfferingPriceStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductOfferingPriceStateChangeEventPayload" } }, "description": "The event data" }, "ProductOfferingPriceStateChangeEventPayload": { "type": "object", "properties": { "productOfferingPrice": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "description": "The event data structure" }, "ProductOfferingPriceDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductOfferingPriceDeleteEventPayload" } }, "description": "The event data" }, "ProductOfferingPriceDeleteEventPayload": { "type": "object", "properties": { "productOfferingPrice": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "description": "The event data structure" }, "ProductOfferingPriceCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductOfferingPriceCreateEventPayload" } }, "description": "The event data" }, "ProductOfferingPriceCreateEventPayload": { "type": "object", "properties": { "productOfferingPrice": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "description": "The event data structure" }, "ProductOfferingPriceAttributeValueChangeEvent": { "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." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/ProductOfferingPriceAttributeValueChangeEventPayload" } }, "description": "The event data" }, "ProductOfferingPriceAttributeValueChangeEventPayload": { "type": "object", "properties": { "productOfferingPrice": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "description": "The event data structure" }, "ProductOfferingDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductOfferingDeleteEventPayload" } }, "description": "The event data" }, "ProductOfferingDeleteEventPayload": { "type": "object", "properties": { "productOffering": { "$ref": "#/components/schemas/ProductOffering" } }, "description": "The event data structure" }, "ProductOfferingCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/ProductOfferingCreateEventPayload" } }, "description": "The event data" }, "ProductOfferingCreateEventPayload": { "type": "object", "properties": { "productOffering": { "$ref": "#/components/schemas/ProductOffering" } }, "description": "The event data structure" }, "ProductOfferingAttributeValueChangeEvent": { "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." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/ProductOfferingAttributeValueChangeEventPayload" } }, "description": "The event data" }, "ProductOfferingAttributeValueChangeEventPayload": { "type": "object", "properties": { "productOffering": { "$ref": "#/components/schemas/ProductOffering" } }, "description": "The event data structure" }, "Category": { "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" }, "id": { "type": "string", "description": "Unique identifier of the category" }, "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" }, "productOffering": { "type": "array", "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "items": { "$ref": "#/components/schemas/ProductOfferingRef" } }, "subCategory": { "type": "array", "description": "List of child categories in the tree for in this category", "items": { "$ref": "#/components/schemas/CategoryRef" } } }, "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." }, "CategoryDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CategoryDeleteEventPayload" } }, "description": "The event data" }, "CategoryDeleteEventPayload": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/Category" } }, "description": "The event data structure" }, "ProductOfferingRef": { "required": [ "id" ], "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" }, "id": { "type": "string", "description": "Unique identifier of a related entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "CategoryCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CategoryCreateEventPayload" } }, "description": "The event data" }, "CategoryCreateEventPayload": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/Category" } }, "description": "The event data structure" }, "Catalog": { "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" }, "id": { "type": "string", "description": "Unique identifier of the Catalog" }, "catalogType": { "type": "string", "description": "Indicates if the catalog is a product, service or resource catalog" }, "relatedParty": { "type": "array", "description": "List of parties involved in this catalog", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "category": { "type": "array", "description": "List of categories associated with this catalog", "items": { "$ref": "#/components/schemas/CategoryRef" } } }, "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details" }, "CatalogDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CatalogDeleteEventPayload" } }, "description": "The event data" }, "CatalogDeleteEventPayload": { "type": "object", "properties": { "catalog": { "$ref": "#/components/schemas/Catalog" } }, "description": "The event data structure" }, "CatalogCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CatalogCreateEventPayload" } }, "description": "The event data" }, "CatalogCreateEventPayload": { "type": "object", "properties": { "catalog": { "$ref": "#/components/schemas/Catalog" } }, "description": "The event data structure" }, "CatalogBatchEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/CatalogBatchEventPayload" } }, "description": "The event data" }, "CatalogBatchEventPayload": { "type": "object", "properties": { "catalog": { "$ref": "#/components/schemas/Catalog" } }, "description": "The event data structure" }, "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" }, "url": { "type": "string", "description": "URL of the file containing the data to be imported" }, "status": { "type": "string", "description": "Status of the import job (not started, running, succeeded, failed)", "enum": [ "Not Started", "Running", "Succeeded", "Failed" ] }, "@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" }, "url": { "type": "string", "description": "URL of the file containing the data to be imported" }, "status": { "type": "string", "description": "Status of the import job (not started, running, succeeded, failed)", "enum": [ "Not Started", "Running", "Succeeded", "Failed" ] }, "@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" }, "url": { "type": "string", "description": "URL of the file containing the data to be exported" }, "status": { "type": "string", "description": "Status of the export job (not started, running, succeeded, failed)", "enum": [ "Not Started", "Running", "Succeeded", "Failed" ] }, "@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" }, "url": { "type": "string", "description": "URL of the file containing the data to be exported" }, "status": { "type": "string", "description": "Status of the export job (not started, running, succeeded, failed)", "enum": [ "Not Started", "Running", "Succeeded", "Failed" ] }, "@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" }, "CategoryCreate": { "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": "Category version" }, "productOffering": { "type": "array", "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "items": { "$ref": "#/components/schemas/ProductOfferingRef" } }, "subCategory": { "type": "array", "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings.", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "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 Category to be created" }, "CatalogCreate": { "type": "object", "properties": { "catalogType": { "type": "string", "description": "Indicates if the catalog is a product, service or resource catalog" }, "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 catalog" }, "version": { "type": "string", "description": "Catalog version" }, "category": { "type": "array", "description": "List of root categories contained in this catalog", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "relatedParty": { "type": "array", "description": "List of parties involved in this catalog", "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 Catalog to be created" }, "ProductSpecificationUpdate": { "type": "object", "properties": { "brand": { "type": "string", "description": "The manufacturer or trademark of the specification" }, "description": { "type": "string", "description": "A narrative that explains in detail what the product specification is" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the product specification" }, "productNumber": { "type": "string", "description": "An identification number assigned to uniquely identity the specification" }, "version": { "type": "string", "description": "Product specification version" }, "attachment": { "type": "array", "description": "Complements the description of an element (for instance a product) through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "bundledProductSpecification": { "type": "array", "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", "items": { "$ref": "#/components/schemas/BundledProductSpecification" } }, "productSpecCharacteristic": { "type": "array", "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristic" } }, "productSpecificationRelationship": { "type": "array", "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", "items": { "$ref": "#/components/schemas/ProductSpecificationRelationship" } }, "relatedParty": { "type": "array", "description": "A related party defines party or party role linked to a specific entity.", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceSpecification": { "type": "array", "description": "The ResourceSpecification is required to realize a ProductSpecification.", "items": { "$ref": "#/components/schemas/ResourceSpecificationRef" } }, "serviceSpecification": { "type": "array", "description": "ServiceSpecification(s) required to realize a ProductSpecification.", "items": { "$ref": "#/components/schemas/ServiceSpecificationRef" } }, "targetProductSchema": { "$ref": "#/components/schemas/TargetProductSchema" }, "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 ProductSpecification to be updated" }, "ProductOfferingPriceUpdate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the productOfferingPrice" }, "isBundle": { "type": "boolean", "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" }, "lifecycleStatus": { "type": "string", "description": "the lifecycle status of this ProductOfferingPrice" }, "name": { "type": "string", "description": "Name of the productOfferingPrice" }, "percentage": { "type": "number", "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)", "format": "float" }, "priceType": { "type": "string", "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." }, "recurringChargePeriodLength": { "type": "integer", "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable", "format": "int32" }, "recurringChargePeriodType": { "type": "string", "description": "The period to repeat the application of the price Could be month, week..." }, "version": { "type": "string", "description": "ProductOffering version" }, "bundledPopRelationship": { "type": "array", "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship.", "items": { "$ref": "#/components/schemas/BundledProductOfferingPriceRelationship" } }, "constraint": { "type": "array", "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice.", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "place": { "type": "array", "description": "Place defines the places where the products are sold or delivered.", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "popRelationship": { "type": "array", "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRelationship" } }, "price": { "$ref": "#/components/schemas/Money" }, "pricingLogicAlgorithm": { "type": "array", "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth).", "items": { "$ref": "#/components/schemas/PricingLogicAlgorithm" } }, "prodSpecCharValueUse": { "type": "array", "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValueUse" } }, "productOfferingTerm": { "type": "array", "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods.", "items": { "$ref": "#/components/schemas/ProductOfferingTerm" } }, "tax": { "type": "array", "description": "An amount of money levied on the price of a Product by a legislative body.", "items": { "$ref": "#/components/schemas/TaxItem" } }, "unitOfMeasure": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "the immediate base class type of this product offering" }, "@schemaLocation": { "type": "string", "description": "hyperlink reference to the schema describing this resource" }, "@type": { "type": "string", "description": "The class type of this Product offering" } }, "description": "The ProductOfferingPrice to be updated" }, "ProductOfferingUpdate": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the productOffering" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." }, "isSellable": { "type": "boolean", "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the productOffering" }, "statusReason": { "type": "string", "description": "A string providing a complementary information on the value of the lifecycle status attribute." }, "version": { "type": "string", "description": "ProductOffering version" }, "agreement": { "type": "array", "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "items": { "$ref": "#/components/schemas/AgreementRef" } }, "attachment": { "type": "array", "description": "Complements the description of an element (for instance a product) through video, pictures...", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "bundledProductOffering": { "type": "array", "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "category": { "type": "array", "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "channel": { "type": "array", "description": "The channel defines the channel for selling product offerings.", "items": { "$ref": "#/components/schemas/ChannelRef" } }, "marketSegment": { "type": "array", "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", "items": { "$ref": "#/components/schemas/MarketSegmentRef" } }, "place": { "type": "array", "description": "Place defines the places where the products are sold or delivered.", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "prodSpecCharValueUse": { "type": "array", "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", "items": { "$ref": "#/components/schemas/ProductSpecificationCharacteristicValueUse" } }, "productOfferingPrice": { "type": "array", "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer.", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRef" } }, "productOfferingTerm": { "type": "array", "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", "items": { "$ref": "#/components/schemas/ProductOfferingTerm" } }, "productSpecification": { "$ref": "#/components/schemas/ProductSpecificationRef" }, "resourceCandidate": { "$ref": "#/components/schemas/ResourceCandidateRef" }, "serviceCandidate": { "$ref": "#/components/schemas/ServiceCandidateRef" }, "serviceLevelAgreement": { "$ref": "#/components/schemas/SLARef" }, "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 ProductOffering to be updated" }, "CategoryUpdate": { "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": "Category version" }, "productOffering": { "type": "array", "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "items": { "$ref": "#/components/schemas/ProductOfferingRef" } }, "subCategory": { "type": "array", "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings.", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "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 Category to be updated" }, "CatalogUpdate": { "type": "object", "properties": { "catalogType": { "type": "string", "description": "Indicates if the catalog is a product, service or resource catalog" }, "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 catalog" }, "version": { "type": "string", "description": "Catalog version" }, "category": { "type": "array", "description": "List of root categories contained in this catalog", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "relatedParty": { "type": "array", "description": "List of parties involved in this catalog", "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 Catalog to be updated" } }, "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" } } } } } } }