{ "openapi": "3.0.1", "info": { "title": "TMF 652 Resource Order Management-v4.0.0", "description": "This is Swagger UI environment generated for the TMF 652-Resource Order Management-v4.0.0 specification", "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": "resourceOrder", "description": "the resourceOrder API" }, { "name": "cancelResourceOrder", "description": "the cancelResourceOrder API" }, { "name": "listener", "description": "the listener API" }, { "name": "hub", "description": "the hub API" } ], "paths": { "/resourceOrderingManagement/v4/resourceOrder": { "get": { "tags": [ "resourceOrder" ], "summary": "List or find ResourceOrder objects", "description": "This operation list or find ResourceOrder entities", "operationId": "listResourceOrder", "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/ResourceOrder" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrder" } } } } } } }, "post": { "tags": [ "resourceOrder" ], "summary": "Creates a ResourceOrder", "description": "This operation creates a ResourceOrder entity.", "operationId": "createResourceOrder", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } } } } }, "/resourceOrderingManagement/v4/listener/resourceOrderStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ResourceOrderStateChangeEvent", "description": "Example of a client listener for receiving the notification ResourceOrderStateChangeEvent", "operationId": "listenToResourceOrderStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderStateChangeEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/resourceOrderInformationRequiredEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ResourceOrderInformationRequiredEvent", "description": "Example of a client listener for receiving the notification ResourceOrderInformationRequiredEvent", "operationId": "listenToResourceOrderInformationRequiredEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderInformationRequiredEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/resourceOrderDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ResourceOrderDeleteEvent", "description": "Example of a client listener for receiving the notification ResourceOrderDeleteEvent", "operationId": "listenToResourceOrderDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderDeleteEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/resourceOrderCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ResourceOrderCreateEvent", "description": "Example of a client listener for receiving the notification ResourceOrderCreateEvent", "operationId": "listenToResourceOrderCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderCreateEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/resourceOrderAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ResourceOrderAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification ResourceOrderAttributeValueChangeEvent", "operationId": "listenToResourceOrderAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderAttributeValueChangeEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/cancelResourceOrderStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CancelResourceOrderStateChangeEvent", "description": "Example of a client listener for receiving the notification CancelResourceOrderStateChangeEvent", "operationId": "listenToCancelResourceOrderStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrderStateChangeEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/cancelResourceOrderInformationRequiredEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CancelResourceOrderInformationRequiredEvent", "description": "Example of a client listener for receiving the notification CancelResourceOrderInformationRequiredEvent", "operationId": "listenToCancelResourceOrderInformationRequiredEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrderInformationRequiredEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/listener/cancelResourceOrderCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity CancelResourceOrderCreateEvent", "description": "Example of a client listener for receiving the notification CancelResourceOrderCreateEvent", "operationId": "listenToCancelResourceOrderCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrderCreateEvent" } } }, "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" } } } } } } }, "/resourceOrderingManagement/v4/hub": { "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" } } } } } } }, "/cancelResourceOrder": { "get": { "tags": [ "cancelResourceOrder" ], "summary": "List or find CancelResourceOrder objects", "description": "This operation list or find CancelResourceOrder entities", "operationId": "listCancelResourceOrder", "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/CancelResourceOrder" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } } } }, "post": { "tags": [ "cancelResourceOrder" ], "summary": "Creates a CancelResourceOrder", "description": "This operation creates a CancelResourceOrder entity.", "operationId": "createCancelResourceOrder", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrderCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } } } }, "/resourceOrderingManagement/v4/resourceOrder/{id}": { "get": { "tags": [ "resourceOrder" ], "summary": "Retrieves a ResourceOrder by ID", "description": "This operation retrieves a ResourceOrder entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveResourceOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ResourceOrder", "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/ResourceOrder" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } } } }, "delete": { "tags": [ "resourceOrder" ], "summary": "Deletes a ResourceOrder", "description": "This operation deletes a ResourceOrder entity.", "operationId": "deleteResourceOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ResourceOrder", "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": [ "resourceOrder" ], "summary": "Updates partially a ResourceOrder", "description": "This operation updates partially a ResourceOrder entity.", "operationId": "patchResourceOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ResourceOrder", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrderUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResourceOrder" } } } } } } }, "/cancelResourceOrder/{id}": { "get": { "tags": [ "cancelResourceOrder" ], "summary": "Retrieves a CancelResourceOrder by ID", "description": "This operation retrieves a CancelResourceOrder entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveCancelResourceOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the CancelResourceOrder", "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/CancelResourceOrder" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CancelResourceOrder" } } } } } } }, "/resourceOrderingManagement/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" } } }, "AppointmentRef": { "required": [ "id" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation" }, "id": { "type": "string", "description": "The identifier of the referred appointment" }, "href": { "type": "string", "description": "The reference of the appointment" }, "description": { "type": "string", "description": "An explanatory text regarding the appointment made with a party" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "@referredType": { "type": "string" } }, "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit" }, "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." }, "Characteristic": { "required": [ "name", "value" ], "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 characteristic" }, "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicRelationship" } }, "value": { "$ref": "#/components/schemas/Any" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "CharacteristicRelationship": { "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 characteristic" }, "relationshipType": { "type": "string", "description": "The type of relationship" } }, "description": "Another Characteristic that is related to the current Characteristic;" }, "ConstraintRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "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": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "id": { "type": "string", "description": "unique identifier" }, "version": { "type": "string", "description": "constraint version" }, "@referredType": { "type": "string" } }, "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec." }, "ExternalId": { "required": [ "entityType", "id", "owner" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "id": { "type": "string", "description": "ID of the entity within the external system." }, "entityType": { "type": "string", "description": "Type of the entity within the external system" }, "owner": { "type": "string", "description": "Name of the external system that owns the entity." }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list." }, "Feature": { "required": [ "featureCharacteristic", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the feature." }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "isEnabled": { "type": "boolean", "description": "True if this feature is enabled. Default is true." }, "name": { "type": "string", "description": "This is the name for the feature." }, "constraint": { "uniqueItems": true, "type": "array", "description": "This is a list of feature constraints.", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "featureCharacteristic": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "description": "This is a list of Characteristics for a particular feature.", "items": { "$ref": "#/components/schemas/Characteristic" } }, "featureRelationship": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FeatureRelationship" } } }, "description": "Configuration feature." }, "FeatureRelationship": { "required": [ "relationshipType" ], "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 target feature." }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Configuration feature" }, "Note": { "type": "object", "properties": { "uuid": { "type": "string" }, "date": { "type": "string", "description": "Date of the note" }, "@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" }, "author": { "type": "string", "description": "Author of the note" }, "system": { "type": "string", "description": "Describes the system from which the action related to this note was done" }, "text": { "type": "string", "description": "Text of the note" } }, "description": "Extra information about a given entity" }, "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." }, "RelatedPlaceRefOrValue": { "required": [ "role" ], "type": "object", "properties": { "uuid": { "type": "string" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "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 of the place" }, "role": { "type": "string" }, "@referredType": { "type": "string" } }, "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "ResourceOrderCreate": { "type": "object", "properties": { "requestedCompletionDate": { "type": "string", "description": "Requested delivery date from the requestor perspective" }, "requestedStartDate": { "type": "string", "description": "Order start date wished by the requestor" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "category": { "type": "string", "description": "Used to categorize the order from a business perspective that can be useful for the OM system." }, "completionDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "free-text description of the Resource Order" }, "expectedCompletionDate": { "type": "string", "format": "date-time" }, "externalId": { "type": "string", "description": "DEPRECATED: Use externalReference Instead. ID given by the consumer (to facilitate searches afterwards)" }, "name": { "type": "string", "description": "A string used to give a name to the Resource Order" }, "orderDate": { "type": "string", "format": "date-time" }, "orderType": { "type": "string", "description": "Name of the Resource Order type" }, "priority": { "type": "integer", "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "state": { "type": "string", "description": "The life cycle state of the resource." }, "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" } }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrderItem" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The ResourceOrder to be created" }, "ResourceOrderItem": { "type": "object", "properties": { "resourceRefOrValue": { "$ref": "#/components/schemas/ResourceRefOrValue" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "id": { "type": "string", "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" }, "action": { "type": "string", "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" }, "quantity": { "type": "integer", "description": "Quantity ordered", "format": "int32" }, "state": { "type": "string", "description": "State of the order item : described in the state machine diagram", "enum": [ "INITIAL", "ACKNOWLEDGED", "REJECTED", "PENDING", "HELD", "INPROGRESS", "CANCELLED", "COMPLETED", "FAILED", "PARTIAL" ] }, "appointment": { "$ref": "#/components/schemas/AppointmentRef" }, "orderItemRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrderItemRelationship" } }, "resource": { "$ref": "#/components/schemas/ResourceRefOrValue" }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "An identified part of the order. A resource order is decomposed into one or more order items." }, "ResourceOrderItemRef": { "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "itemId": { "type": "string", "description": "Identifier of the line item" }, "resourceOrderHref": { "type": "string", "description": "Link to the order to which this item belongs to" }, "resourceOrderId": { "type": "string", "description": "Identifier of the order that this item belongs to" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "@referredType": { "type": "string" } } }, "ResourceOrderItemRelationship": { "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "relationshipType": { "type": "string", "description": "Type of the order item relationship" }, "orderItem": { "$ref": "#/components/schemas/ResourceOrderItemRef" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } } }, "ResourceRef": { "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 supporting resource" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "ResourceRefOrValue": { "required": [ "href", "id" ], "type": "object", "properties": { "endOperatingDate": { "type": "string", "description": "A date time( DateTime). The date till the resource is operating" }, "startOperatingDate": { "type": "string", "description": "A date time( DateTime). The date from which the resource is operating" }, "@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": "The URI for the object itself." }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "id": { "type": "string", "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "description": { "type": "string", "description": "free-text description of the resource" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "uniqueItems": true, "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/Feature" } }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "attachment": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "note": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "place": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" }, "relatedParty": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceCharacteristic": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "resourceRelationship": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "resourceStatus": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Resource entity and not the related ResourceRefOrValue class itself" }, "ResourceRelationship": { "required": [ "relationshipType", "resource" ], "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" }, "relationshipType": { "type": "string", "description": "Type of the resource relationship, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (eg: an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", "example": "bundled" }, "resource": { "$ref": "#/components/schemas/ResourceRef" } }, "description": "Linked resources to the one instantiate, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (e.g. an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" }, "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." }, "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" }, "ResourceOrder": { "type": "object", "properties": { "completionDate": { "type": "string", "description": "Effective delivery date amended by the provider" }, "expectedCompletionDate": { "type": "string", "description": "Expected delivery date amended by the provider" }, "requestedCompletionDate": { "type": "string", "description": "Requested delivery date from the requestor perspective" }, "requestedStartDate": { "type": "string", "description": "Order start date wished by the requestor" }, "startDate": { "type": "string", "description": "Date when the order was started for processing" }, "orderDate": { "type": "string" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "id": { "type": "string", "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." }, "href": { "type": "string", "description": "Hyperlink to access the order" }, "category": { "type": "string", "description": "Used to categorize the order from a business perspective that can be useful for the OM system." }, "description": { "type": "string", "description": "free-text description of the Resource Order" }, "externalId": { "type": "string", "description": "DEPRECATED: Use externalReference Instead. ID given by the consumer (to facilitate searches afterwards)" }, "name": { "type": "string", "description": "A string used to give a name to the Resource Order" }, "orderType": { "type": "string", "description": "Name of the Resource Order type" }, "priority": { "type": "integer", "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", "format": "int32" }, "state": { "type": "string", "description": "The life cycle state of the resource." }, "externalReference": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" } }, "note": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "orderItem": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrderItem" } }, "relatedParty": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order" }, "ResourceOrderStateChangeEvent": { "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/ResourceOrderStateChangeEventPayload" } }, "description": "The event data" }, "ResourceOrderStateChangeEventPayload": { "type": "object", "properties": { "resourceOrder": { "$ref": "#/components/schemas/ResourceOrder" } }, "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" }, "ResourceOrderInformationRequiredEvent": { "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/ResourceOrderInformationRequiredEventPayload" } }, "description": "The event data" }, "ResourceOrderInformationRequiredEventPayload": { "type": "object", "properties": { "resourceOrder": { "$ref": "#/components/schemas/ResourceOrder" } }, "description": "The event data structure" }, "ResourceOrderDeleteEvent": { "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/ResourceOrderDeleteEventPayload" } }, "description": "The event data" }, "ResourceOrderDeleteEventPayload": { "type": "object", "properties": { "resourceOrder": { "$ref": "#/components/schemas/ResourceOrder" } }, "description": "The event data structure" }, "ResourceOrderCreateEvent": { "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/ResourceOrderCreateEventPayload" } }, "description": "The event data" }, "ResourceOrderCreateEventPayload": { "type": "object", "properties": { "resourceOrder": { "$ref": "#/components/schemas/ResourceOrder" } }, "description": "The event data structure" }, "ResourceOrderAttributeValueChangeEvent": { "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/ResourceOrderAttributeValueChangeEventPayload" } }, "description": "The event data" }, "ResourceOrderAttributeValueChangeEventPayload": { "type": "object", "properties": { "resourceOrder": { "$ref": "#/components/schemas/ResourceOrder" } }, "description": "The event data structure" }, "CancelResourceOrder": { "required": [ "resourceOrder" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "id": { "type": "string", "description": "id of the cancellation request (this is not an order id)" }, "href": { "type": "string", "description": "Hyperlink to access the cancellation request" }, "cancellationReason": { "type": "string", "description": "Reason why the order is cancelled." }, "effectiveCancellationDate": { "type": "string", "format": "date-time" }, "requestedCancellationDate": { "type": "string", "format": "date-time" }, "resourceOrder": { "$ref": "#/components/schemas/ResourceOrderRef" }, "state": { "type": "string", "enum": [ "acknowledged", "terminatedWithError", "inProgress", "done" ] }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "Request for cancellation an existing resource order" }, "CancelResourceOrderStateChangeEvent": { "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/CancelResourceOrderStateChangeEventPayload" } }, "description": "The event data" }, "CancelResourceOrderStateChangeEventPayload": { "type": "object", "properties": { "cancelResourceOrder": { "$ref": "#/components/schemas/CancelResourceOrder" } }, "description": "The event data structure" }, "ResourceOrderRef": { "required": [ "id" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string", "description": "The unique identifier of the related resource order" }, "href": { "type": "string", "description": "Hyperlink to access the related Resource Order" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "@referredType": { "type": "string" } } }, "CancelResourceOrderInformationRequiredEvent": { "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/CancelResourceOrderInformationRequiredEventPayload" } }, "description": "The event data" }, "CancelResourceOrderInformationRequiredEventPayload": { "type": "object", "properties": { "cancelResourceOrder": { "$ref": "#/components/schemas/CancelResourceOrder" } }, "description": "The event data structure" }, "CancelResourceOrderCreateEvent": { "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/CancelResourceOrderCreateEventPayload" } }, "description": "The event data" }, "CancelResourceOrderCreateEventPayload": { "type": "object", "properties": { "cancelResourceOrder": { "$ref": "#/components/schemas/CancelResourceOrder" } }, "description": "The event data structure" }, "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" }, "CancelResourceOrderCreate": { "required": [ "resourceOrder" ], "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "cancellationReason": { "type": "string", "description": "Reason why the order is cancelled." }, "requestedCancellationDate": { "type": "string", "format": "date-time" }, "resourceOrder": { "$ref": "#/components/schemas/ResourceOrderRef" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The CancelResourceOrder to be created" }, "ResourceOrderUpdate": { "type": "object", "properties": { "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "category": { "type": "string", "description": "Used to categorize the order from a business perspective that can be useful for the OM system." }, "description": { "type": "string", "description": "free-text description of the Resource Order" }, "expectedCompletionDate": { "type": "string", "format": "date-time" }, "externalId": { "type": "string", "description": "DEPRECATED: Use externalReference Instead. ID given by the consumer (to facilitate searches afterwards)" }, "name": { "type": "string", "description": "A string used to give a name to the Resource Order" }, "orderType": { "type": "string", "description": "Name of the Resource Order type" }, "priority": { "type": "integer", "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", "format": "int32" }, "requestedCompletionDate": { "type": "string", "format": "date-time" }, "requestedStartDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "state": { "type": "string", "description": "The life cycle state of the resource." }, "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" } }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "orderItem": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceOrderItem" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The ResourceOrder 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" } } } } } } }