{ "openapi": "3.0.1", "info": { "title": "TMF628 Performance Management API", "description": "TMF628 Performance Management API", "license": { "name": "Apache 2.0", "url": "https://osl.etsi.org" }, "version": "5.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": "events subscription", "description": "Endpoints to register and terminate an Event Listener" }, { "name": "trackingRecord", "description": "Operations for TrackingRecord Resource" }, { "name": "performanceIndicatorGroupSpecification", "description": "Operations for PerformanceIndicatorGroupSpecification Resource" }, { "name": "performanceIndicatorSpecification", "description": "Operations for PerformanceIndicatorSpecification Resource" }, { "name": "dataAccessEndpoint", "description": "Operations for DataAccessEndpoint Resource" }, { "name": "measurementCollectionJob", "description": "Operations for MeasurementCollectionJob Resource" }, { "name": "notification listener", "description": "Notifications for Resource Lifecycle and event notifications" }, { "name": "performanceMeasurement", "description": "Operations for PerformanceMeasurement Resource" } ], "paths": { "/performance/v5/performanceIndicatorSpecification": { "get": { "tags": [ "performanceIndicatorSpecification" ], "summary": "List or find PerformanceIndicatorSpecification objects", "description": "List or find PerformanceIndicatorSpecification objects", "operationId": "listPerformanceIndicatorSpecification", "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": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "performanceIndicatorSpecification" ], "summary": "Creates a PerformanceIndicatorSpecification", "description": "This operation creates a PerformanceIndicatorSpecification entity.", "operationId": "createPerformanceIndicatorSpecification", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationFVO" } } }, "required": true }, "responses": { "201": { "description": "OK/Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/performanceIndicatorGroupSpecification": { "get": { "tags": [ "performanceIndicatorGroupSpecification" ], "summary": "List or find PerformanceIndicatorGroupSpecification objects", "description": "List or find PerformanceIndicatorGroupSpecification objects", "operationId": "listPerformanceIndicatorGroupSpecification", "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": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "performanceIndicatorGroupSpecification" ], "summary": "Creates a PerformanceIndicatorGroupSpecification", "description": "This operation creates a PerformanceIndicatorGroupSpecification entity.", "operationId": "createPerformanceIndicatorGroupSpecification", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationFVO" } } }, "required": true }, "responses": { "201": { "description": "OK/Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/hub": { "post": { "tags": [ "events subscription" ], "summary": "Create a subscription (hub) to receive Events", "description": "Sets the communication endpoint to receive Events.", "operationId": "createHub", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hub_FVO" } } }, "required": true }, "responses": { "201": { "description": "Notified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hub" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/measurementCollectionJob": { "get": { "tags": [ "measurementCollectionJob" ], "summary": "List or find MeasurementCollectionJob objects", "description": "List or find MeasurementCollectionJob objects", "operationId": "listMeasurementCollectionJob", "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": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementCollectionJob" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "measurementCollectionJob" ], "summary": "Creates a MeasurementCollectionJob", "description": "This operation creates a MeasurementCollectionJob entity.", "operationId": "createMeasurementCollectionJob", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobFVO" } } }, "required": true }, "responses": { "201": { "description": "OK/Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/performanceMeasurementCreateEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity PerformanceMeasurementCreateEvent", "description": "Example of a client listener for receiving the notification PerformanceMeasurementCreateEvent", "operationId": "performanceMeasurementCreateEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceMeasurementCreateEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/performanceMeasurementCollectionReadyEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity PerformanceMeasurementCollectionReadyEvent", "description": "Example of a client listener for receiving the notification PerformanceMeasurementCollectionReadyEvent", "operationId": "performanceMeasurementCollectionReadyEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceMeasurementCollectionReadyEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/measurementCollectionJobFilesReadyEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity MeasurementCollectionJobFilesReadyEvent", "description": "Example of a client listener for receiving the notification MeasurementCollectionJobFilesReadyEvent", "operationId": "measurementCollectionJobFilesReadyEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobFilesReadyEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/measurementCollectionJobFilesPreparationErrorEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity MeasurementCollectionJobFilesPreparationErrorEvent", "description": "Example of a client listener for receiving the notification MeasurementCollectionJobFilesPreparationErrorEvent", "operationId": "measurementCollectionJobFilesPreparationErrorEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobFilesPreparationErrorEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/measurementCollectionJobExecutionStateChangeEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity MeasurementCollectionJobExecutionStateChangeEvent", "description": "Example of a client listener for receiving the notification MeasurementCollectionJobExecutionStateChangeEvent", "operationId": "measurementCollectionJobExecutionStateChangeEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobExecutionStateChangeEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/measurementCollectionJobDeleteEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity MeasurementCollectionJobDeleteEvent", "description": "Example of a client listener for receiving the notification MeasurementCollectionJobDeleteEvent", "operationId": "measurementCollectionJobDeleteEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobDeleteEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/measurementCollectionJobCreateEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity MeasurementCollectionJobCreateEvent", "description": "Example of a client listener for receiving the notification MeasurementCollectionJobCreateEvent", "operationId": "measurementCollectionJobCreateEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobCreateEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/listener/measurementCollectionJobAttributeValueChangeEvent": { "post": { "tags": [ "notification listener" ], "summary": "Client listener for entity MeasurementCollectionJobAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification MeasurementCollectionJobAttributeValueChangeEvent", "operationId": "measurementCollectionJobAttributeValueChangeEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobAttributeValueChangeEvent" } } }, "required": true }, "responses": { "204": { "description": "Notified" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/performanceIndicatorSpecification/{id}": { "get": { "tags": [ "performanceIndicatorSpecification" ], "summary": "Retrieves a PerformanceIndicatorSpecification by ID", "description": "This operation retrieves a PerformanceIndicatorSpecification entity. Attribute selection enabled for all first level attributes.", "operationId": "retrievePerformanceIndicatorSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "performanceIndicatorSpecification" ], "summary": "Deletes a PerformanceIndicatorSpecification", "description": "This operation deletes a PerformanceIndicatorSpecification entity.", "operationId": "deletePerformanceIndicatorSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "performanceIndicatorSpecification" ], "summary": "Updates partially a PerformanceIndicatorSpecification", "description": "This operation updates partially a PerformanceIndicatorSpecification entity.", "operationId": "patchPerformanceIndicatorSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationMVO" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationMVO" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationMVO" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationMVO" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/performanceIndicatorGroupSpecification/{id}": { "get": { "tags": [ "performanceIndicatorGroupSpecification" ], "summary": "Retrieves a PerformanceIndicatorGroupSpecification by ID", "description": "This operation retrieves a PerformanceIndicatorGroupSpecification entity. Attribute selection enabled for all first level attributes.", "operationId": "retrievePerformanceIndicatorGroupSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "performanceIndicatorGroupSpecification" ], "summary": "Deletes a PerformanceIndicatorGroupSpecification", "description": "This operation deletes a PerformanceIndicatorGroupSpecification entity.", "operationId": "deletePerformanceIndicatorGroupSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "performanceIndicatorGroupSpecification" ], "summary": "Updates partially a PerformanceIndicatorGroupSpecification", "description": "This operation updates partially a PerformanceIndicatorGroupSpecification entity.", "operationId": "patchPerformanceIndicatorGroupSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationMVO" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationMVO" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationMVO" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationMVO" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/v5/measurementCollectionJob/{id}": { "get": { "tags": [ "measurementCollectionJob" ], "summary": "Retrieves a MeasurementCollectionJob by ID", "description": "This operation retrieves a MeasurementCollectionJob entity. Attribute selection enabled for all first level attributes.", "operationId": "retrieveMeasurementCollectionJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "measurementCollectionJob" ], "summary": "Deletes a MeasurementCollectionJob", "description": "This operation deletes a MeasurementCollectionJob entity.", "operationId": "deleteMeasurementCollectionJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "measurementCollectionJob" ], "summary": "Updates partially a MeasurementCollectionJob", "description": "This operation updates partially a MeasurementCollectionJob entity.", "operationId": "patchMeasurementCollectionJob", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobMVO" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobMVO" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobMVO" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJobMVO" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/MeasurementCollectionJob" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json-patch-query+json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/trackingRecord": { "get": { "tags": [ "trackingRecord" ], "summary": "List or find TrackingRecord objects", "description": "List or find TrackingRecord objects", "operationId": "listTrackingRecord", "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": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingRecord" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/trackingRecord/{id}": { "get": { "tags": [ "trackingRecord" ], "summary": "Retrieves a TrackingRecord by ID", "description": "This operation retrieves a TrackingRecord entity. Attribute selection enabled for all first level attributes.", "operationId": "retrieveTrackingRecord", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingRecord" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/performanceMeasurement": { "get": { "tags": [ "performanceMeasurement" ], "summary": "List or find PerformanceMeasurement objects", "description": "List or find PerformanceMeasurement objects", "operationId": "listPerformanceMeasurement", "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": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceMeasurement" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/performanceMeasurement/{id}": { "get": { "tags": [ "performanceMeasurement" ], "summary": "Retrieves a PerformanceMeasurement by ID", "description": "This operation retrieves a PerformanceMeasurement entity. Attribute selection enabled for all first level attributes.", "operationId": "retrievePerformanceMeasurement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceMeasurement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/dataAccessEndpoint": { "get": { "tags": [ "dataAccessEndpoint" ], "summary": "List or find DataAccessEndpoint objects", "description": "List or find DataAccessEndpoint objects", "operationId": "listDataAccessEndpoint", "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": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataAccessEndpoint" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/dataAccessEndpoint/{id}": { "get": { "tags": [ "dataAccessEndpoint" ], "summary": "Retrieves a DataAccessEndpoint by ID", "description": "This operation retrieves a DataAccessEndpoint entity. Attribute selection enabled for all first level attributes.", "operationId": "retrieveDataAccessEndpoint", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAccessEndpoint" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/performance/v5/hub/{id}": { "delete": { "tags": [ "events subscription" ], "summary": "Remove a subscription (hub) to receive Events", "operationId": "hubDelete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Resource", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "PerformanceIndicatorSpecRelationship": { "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" }, "relationshipType": { "type": "string" }, "role": { "type": "string", "description": "The association role for this service specification" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } } }, "PerformanceIndicatorSpecification": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValue" }, { "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" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "description": { "type": "string", "description": "A narrative that explains in detail what the PerformanceIndicatorSpecification is." }, "perspective": { "type": "string", "description": "The point of view for the PerformanceIndicatorSpecification, such as a single user instance or aggregation." }, "indicatorCategory": { "type": "string", "description": "A grouping or set of PerformanceIndicatorSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent." }, "indicatorType": { "type": "string", "enum": [ "string", "int", "float", "double" ] }, "derivationAlgorithm": { "type": "string", "description": "A step-by-step procedure used to calculate the value of PerformanceIndicator." }, "derivationMethod": { "type": "string", "description": "For simple calculations, the method used to calculate the value of a PerformanceIndicator, such as average, minimum, maximum, sum and so forth." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "collectionType": { "type": "string", "enum": [ "cumulative", "delta", "discrete_event", "gauge", "status_inspection" ] }, "indicatorUnit": { "type": "string", "description": "The unit by which the indicator is measured. For example, seconds, KBs, rate per second, etc." }, "performanceIndicatorSpecRelationship": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorSpecRelationship" } } } } ] }, "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" }, "Error": { "required": [ "code", "reason" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "referenceError": { "type": "string", "description": "URI of documentation describing the error.", "format": "uri" }, "@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", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." } }, "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)" }, "PerformanceIndicatorSpecRelationshipFVO": { "required": [ "@type", "relationshipType", "validFor" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "relationshipType": { "type": "string" }, "role": { "type": "string", "description": "The association role for this service specification" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } } }, "PerformanceIndicatorSpecificationFVO": { "required": [ "collectionType", "indicatorCategory", "indicatorType", "indicatorUnit", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValueFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "A word, term, or phrase by which a PerformanceIndicatorSpecification is known and distinguished from other PerformanceIndicatorSpecifications." }, "description": { "type": "string", "description": "A narrative that explains in detail what the PerformanceIndicatorSpecification is." }, "perspective": { "type": "string", "description": "The point of view for the PerformanceIndicatorSpecification, such as a single user instance or aggregation." }, "indicatorCategory": { "type": "string", "description": "A grouping or set of PerformanceIndicatorSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent." }, "indicatorType": { "type": "string", "enum": [ "string", "int", "float", "double" ] }, "derivationAlgorithm": { "type": "string", "description": "A step-by-step procedure used to calculate the value of PerformanceIndicator." }, "derivationMethod": { "type": "string", "description": "For simple calculations, the method used to calculate the value of a PerformanceIndicator, such as average, minimum, maximum, sum and so forth." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "collectionType": { "type": "string", "enum": [ "cumulative", "delta", "discrete_event", "gauge", "status_inspection" ] }, "indicatorUnit": { "type": "string", "description": "The unit by which the indicator is measured. For example, seconds, KBs, rate per second, etc." }, "performanceIndicatorSpecRelationship": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorSpecRelationshipFVO" } } } } ] }, "PerformanceIndicatorGroupSpecification": { "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" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "groupCategory": { "type": "string", "description": "A grouping or set of PerformanceIndicatorGroupSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent." }, "performanceIndicatorSpecification": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValue" } } } }, "PerformanceIndicatorSpecificationRefOrValue": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "PerformanceIndicatorGroupSpecificationFVO": { "required": [ "@type", "groupCategory", "name" ], "type": "object", "properties": { "@baseType": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "name": { "type": "string", "description": "A word, term, or phrase by which a PerformanceIndicatorGroupSpecification is tagged." }, "groupCategory": { "type": "string", "description": "A grouping or set of PerformanceIndicatorGroupSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent." }, "performanceIndicatorSpecification": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationFVO" }, { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefFVO" } ] } } }, "description": "The PerformanceIndicatorGroupSpecification to be created" }, "PerformanceIndicatorSpecificationRefFVO": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValueFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string", "description": "Version of the performance indicator specification" } } } ] }, "PerformanceIndicatorSpecificationRefOrValueFVO": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "Hub": { "required": [ "@type", "callback" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "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" }, "Hub_FVO": { "required": [ "@type", "callback" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "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" }, "AttachmentRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "url": { "type": "string", "description": "Link to the attachment media/content" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures" }, "Characteristic": { "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" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "description": "Collection of characteristic relationships", "items": { "$ref": "#/components/schemas/CharacteristicRelationship" } } }, "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" }, "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" }, "relationshipType": { "type": "string", "description": "The type of relationship" } }, "description": "Collection of characteristic relationships" }, "CompressionType": { "type": "object", "properties": { "compressionEnumType": { "type": "string", "enum": [ "no_compression", "gzip", "vendor_ext", "minor_ext" ] } }, "description": "File compression type." }, "DataAccessEndpoint": { "type": "object", "properties": { "uuid": { "type": "string" }, "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" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "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" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItem" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRef" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRef" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/Feature" } }, "intent": { "$ref": "#/components/schemas/IntentRef" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifier" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's" }, "uri": { "type": "string", "description": "URI for using the data access API", "format": "uri" }, "uriQueryFilter": { "$ref": "#/components/schemas/DataFilterMap" }, "apiType": { "type": "string" } } }, "DataFilterAttributeStringArray": { "type": "object", "properties": { "valueType": { "type": "string", "description": "Data type of the value of the attribute" }, "value": { "type": "array", "description": "an array of field names", "example": [ "Dallas", "Houston", "Paris" ], "items": { "type": "string", "description": "an array of field names", "example": "[\"Dallas\",\"Houston\",\"Paris\"]" } } } }, "DataFilterMap": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/DataFilterMapItem" } } } }, "DataFilterMapItem": { "type": "object", "properties": { "filterTemplate": { "$ref": "#/components/schemas/DataFilterTemplate" }, "stringArray": { "$ref": "#/components/schemas/DataFilterAttributeStringArray" } }, "description": "definition of a field used for filtering template with the associated attributes." }, "DataFilterTemplate": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "id": { "type": "string", "description": "Unique identifier of this DataFilterTemplate", "example": "6c088cf7f1bc" }, "href": { "type": "string", "description": "Hyperlink reference to this DataFilterTemplate", "example": "https://host/dataFilerTemplate/6c088cf7f1bc" }, "name": { "type": "string", "description": "Name given to this DataFilterTemplate" }, "description": { "type": "string", "description": "Description of this DataFilterTemplate" } } }, "DayOfMonthRecurrence": { "required": [ "@type" ], "type": "object", "properties": { "dates": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" } } }, "DayOfWeekRecurrence": { "required": [ "@type" ], "type": "object", "properties": { "dates": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" } }, "description": "The weekly schedule is used to define a schedule that is based on the days of the week, e.g. a schedule that will be active only on Monday and Tuesday." }, "Duration": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Time interval (number of seconds, minutes, hours, etc.)", "format": "int32" }, "units": { "type": "string", "description": "Unit of time (seconds, minutes, hours, etc.)" } }, "description": "A time interval in a given unit of time" }, "ExternalIdentifier": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "owner": { "type": "string", "description": "Name of the external system that owns the entity.", "example": "MagentoCommerce" }, "externalIdentifierType": { "type": "string", "description": "Type of the identification, typically would be the type of the entity within the external system", "example": "ProductOrder" }, "id": { "type": "string", "description": "identification of the entity within the external system." } }, "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system." }, "Feature": { "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" }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "featureRelationship": { "type": "array", "description": "Collection of feature relationships", "items": { "$ref": "#/components/schemas/FeatureRelationship" } }, "featureCharacteristic": { "type": "array", "description": "This is a list of Characteristics for a particular feature.", "items": { "$ref": "#/components/schemas/Characteristic" } }, "policyConstraint": { "type": "array", "description": "Reference to manage a list of feature specification policy constraints", "items": { "$ref": "#/components/schemas/PolicyRef" } }, "isEnabled": { "type": "boolean", "description": "True if this feature is enabled. Default is true." } }, "description": "Configuration features" }, "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" }, "FileTransferData": { "type": "object", "properties": { "transportProtocol": { "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" }, "fileLocation": { "type": "string", "format": "uri" }, "fileFormat": { "type": "string" }, "compressionType": { "$ref": "#/components/schemas/CompressionType" }, "retentionPeriod": { "$ref": "#/components/schemas/Duration" }, "packingType": { "$ref": "#/components/schemas/PackingType" } } }, "IntentRef": { "required": [ "@type", "id" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "The URI of the referred entity." }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Intent reference, for when Intent is used by other entities" }, "MeasurementCollectionJob": { "type": "object", "properties": { "uuid": { "type": "string" }, "creationTime": { "type": "string", "description": "The measurement job creation time." }, "lastModifiedTime": { "type": "string", "description": "The last time that a measurement job was modified." }, "@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" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "adminState": { "type": "string", "enum": [ "locked", "unlocked" ] }, "executionState": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "inProgress", "cancelled", "completed", "failed" ] }, "fileTransferData": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FileTransferData" } }, "dataAccessEndpoint": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DataAccessEndpoint" } }, "jobId": { "type": "string", "description": "The ID of the management job." }, "jobPriority": { "maximum": 10, "minimum": 1, "type": "integer", "description": "The priority of the management job. The way the management application will use the JobPriority to schedule job execution is application specific and outside the scope. Integer, limited to a range of 1 to 10.", "format": "int32" }, "scheduleDefinition": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDefinition" } }, "consumingApplicationId": { "type": "string", "description": "The identifier of the application that consumes performance indicators." }, "producingApplicationId": { "type": "string", "description": "The identifier of the application that produces performance indicators." }, "granularity": { "type": "string", "enum": [ "g_1mn", "g_5mn", "g_15mn", "g_30mn", "g_1h", "g_24h", "g_1m", "g_1y", "na", "g_10sec", "g_30sec" ] }, "performanceIndicatorGroupSpecification": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecification" } }, "performanceIndicatorSpecification": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValue" } }, "trackingRecord": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TrackingRecord" } }, "monitoredInstancesCriteria": { "$ref": "#/components/schemas/MonitoredInstancesCriteria" }, "monitoredClassCriteria": { "$ref": "#/components/schemas/MonitoredClassCriteria" }, "outputFormat": { "type": "string" }, "reportingPeriod": { "type": "string", "enum": [ "r_1mn", "r_5mn", "r_15mn", "r_30mn", "r_1h", "r_24h", "na" ] }, "jobCollectionFilter": { "$ref": "#/components/schemas/DataFilterMap" }, "searchTaskFilter": { "$ref": "#/components/schemas/DataFilterMap" }, "jobOnDemand": { "type": "boolean", "description": "True if the job is a single job to be executed immediately in which case the reportingPeriod and scheduleDefinition would not be applicable, false otherwise" } } }, "MonitoredClassCriteria": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "monitoredObjectClass": { "type": "string", "description": "A monitored object class for specifying the set of instances that are referenced by a PM query." }, "objectInstanceFilter": { "type": "string", "description": "A filter that can be used in conjunction with the monitored object class for specifying the set of instances that are referenced by a PM query." } } }, "MonitoredInstancesCriteria": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "monitoredObjectInstances": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "type": "string" } } } }, "MonthlyScheduleDayOfWeekDefinition": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "dayOfMonthRecurrence": { "type": "array", "items": { "$ref": "#/components/schemas/DayOfMonthRecurrence" } }, "recurringDaySequence": { "type": "string" } } }, "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" }, "PackingType": { "type": "object", "properties": { "packingEnumType": { "type": "string", "enum": [ "NO_PACKING", "GZIP", "TAR", "VENDOR_EXT", "MINOR_EXT" ] } }, "description": "Specify if the output file(s) are to be packed." }, "PartyRefOrPartyRoleRef": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "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." }, "PolicyRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string" } }, "description": "Reference to manage a list of feature specification policy constraints" }, "RelatedPartyRefOrPartyRoleRef": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "role": { "type": "string", "description": "Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'" }, "partyOrPartyRole": { "$ref": "#/components/schemas/PartyRefOrPartyRoleRef" } } }, "RelatedPlaceRef": { "required": [ "@type" ], "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", "description": "When sub-classing, this defines the sub-class Extensible name" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "role": { "type": "string" }, "place": { "$ref": "#/components/schemas/PlaceRef" } } }, "RelatedResourceOrderItem": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceOrderHref": { "type": "string", "description": "Reference of the related entity." }, "resourceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "itemAction": { "type": "string", "enum": [ "ADD", "MODIFY", "DELETE", "NOCHANGE" ] }, "itemId": { "type": "string", "description": "Identifier of the order item where the resource was managed" }, "role": { "type": "string", "description": "role of the resource order item for this resource" } }, "description": "A list of resource order items related to this resource" }, "ResourceRefOrValue": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "ResourceRelationship": { "required": [ "@type" ], "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", "description": "When sub-classing, this defines the sub-class Extensible name" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "resourceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "resource": { "$ref": "#/components/schemas/ResourceRefOrValue" }, "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" } } }, "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." }, "ScheduleDefinition": { "type": "object", "properties": { "uuid": { "type": "string" }, "scheduleDefinitionStartTime": { "type": "string", "description": "The Start time of the Schedule Definition" }, "scheduleDefinitionEndTime": { "type": "string", "description": "The End time of the Schedule Definition. If the attribute is empty the Schedule run forever, not having a time constraint." }, "excludedDate": { "type": "array", "description": "A list of specific dates that should be excluded from the Schedule Definition.", "items": { "type": "string", "description": "A list of specific dates that should be excluded from the Schedule Definition." } }, "monthlyScheduleDayOfMonthDefinition": { "type": "array", "description": "The schedule definition for running the threshold job", "items": { "type": "string", "description": "The schedule definition for running the threshold job" } }, "dateScheduleDefintion": { "type": "array", "description": "The date schedule is used to define a schedule that is based on specific dates, such as December 31st 2015, February 28th 2013", "items": { "type": "string", "description": "The date schedule is used to define a schedule that is based on specific dates, such as December 31st 2015, February 28th 2013" } }, "@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" }, "recurringFrequency": { "type": "string", "description": "A recurring frequency to run a job within day that is included in schedule definition, for example: every 5 minutes, 15 minute, 30 minutes, 1 hour" }, "scheduleDefinitionHourRange": { "type": "string", "description": "A list of time ranges within a specific day that the schedule will be active on, for example 08:00-12:00, 16:00-19:00." }, "WeeklyScheduledDefinition": { "type": "array", "description": "The weekly schedule is used to define a schedule that is based on the days of the week, e.g. a schedule that will be active only on Monday and Tuesday.", "items": { "$ref": "#/components/schemas/DayOfWeekRecurrence" } }, "MonthlyScheduleDayOfWeekDefinition": { "$ref": "#/components/schemas/MonthlyScheduleDayOfWeekDefinition" } } }, "TrackingRecord": { "type": "object", "properties": { "uuid": { "type": "string" }, "time": { "type": "string", "description": "Describes the time at which the action was done" }, "@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": { "type": "string", "description": "Describes the action being done, such as: ack, clear", "example": "[\"acknowledge\",\"clear\"]" }, "characteristic": { "type": "array", "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces", "items": { "$ref": "#/components/schemas/Characteristic" } }, "systemId": { "type": "string", "description": "Describes the system Id from which the action was done" }, "user": { "type": "string", "description": "Describes the user doing the action" } } }, "AttachmentRefFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "url": { "type": "string", "description": "Link to the attachment media/content" } } }, "CharacteristicFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "description": "Collection of characteristic relationships", "items": { "$ref": "#/components/schemas/CharacteristicRelationshipFVO" } } }, "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" }, "CharacteristicRelationshipFVO": { "required": [ "@type", "relationshipType", "uuid" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "Unique identifier of the characteristic" }, "relationshipType": { "type": "string", "description": "The type of relationship" } }, "description": "Collection of characteristic relationships" }, "DataAccessEndpointFVO": { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "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" }, "name": { "type": "string", "description": "the name of the resource" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/NoteFVO" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItemFVO" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefFVO" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRefFVO" } }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationshipFVO" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicFVO" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefFVO" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRefFVO" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/FeatureFVO" } }, "intent": { "$ref": "#/components/schemas/IntentRef_FVO" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifierFVO" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's" }, "uri": { "type": "string", "description": "URI for using the data access API", "format": "uri" }, "uriQueryFilter": { "$ref": "#/components/schemas/DataFilterMapFVO" }, "apiType": { "type": "string" } } }, "DataFilterMapFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/DataFilterMapItem_FVO" } } } }, "DataFilterMapItem_FVO": { "type": "object", "properties": { "filterTemplate": { "$ref": "#/components/schemas/DataFilterTemplateFVO" }, "stringArray": { "$ref": "#/components/schemas/DataFilterAttributeStringArray" } }, "description": "definition of a field used for filtering template with the associated attributes." }, "DataFilterTemplateFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name given to this DataFilterTemplate" }, "description": { "type": "string", "description": "Description of this DataFilterTemplate" } } }, "DayOfMonthRecurrenceFVO": { "required": [ "@type" ], "type": "object", "properties": { "dates": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" } } }, "DayOfWeekRecurrenceFVO": { "required": [ "@type" ], "type": "object", "properties": { "dates": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" } }, "description": "The weekly schedule is used to define a schedule that is based on the days of the week, e.g. a schedule that will be active only on Monday and Tuesday." }, "ExternalIdentifierFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "owner": { "type": "string", "description": "Name of the external system that owns the entity.", "example": "MagentoCommerce" }, "externalIdentifierType": { "type": "string", "description": "Type of the identification, typically would be the type of the entity within the external system", "example": "ProductOrder" } }, "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system." }, "FeatureFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "featureRelationship": { "type": "array", "description": "Collection of feature relationships", "items": { "$ref": "#/components/schemas/FeatureRelationshipFVO" } }, "featureCharacteristic": { "type": "array", "description": "This is a list of Characteristics for a particular feature.", "items": { "$ref": "#/components/schemas/CharacteristicFVO" } }, "policyConstraint": { "type": "array", "description": "Reference to manage a list of feature specification policy constraints", "items": { "$ref": "#/components/schemas/PolicyRefFVO" } }, "isEnabled": { "type": "boolean", "description": "True if this feature is enabled. Default is true." }, "name": { "type": "string", "description": "This is the name for the feature." } }, "description": "Configuration features" }, "FeatureRelationshipFVO": { "required": [ "@type", "id", "relationshipType" ], "type": "object", "properties": { "@schemaLocation": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "This is the name of the target feature." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship.", "enum": [ "excluded", "includes", "may include", "requires" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Collection of feature relationships" }, "FileTransferDataFVO": { "type": "object", "properties": { "transportProtocol": { "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" }, "fileLocation": { "type": "string", "format": "uri" }, "fileFormat": { "type": "string" }, "compressionType": { "$ref": "#/components/schemas/CompressionType" }, "retentionPeriod": { "$ref": "#/components/schemas/Duration" }, "packingType": { "$ref": "#/components/schemas/PackingType" } } }, "IntentRef_FVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Intent reference, for when Intent is used by other entities" }, "LogicalResourceFVO": { "required": [ "@type" ], "type": "object", "discriminator": { "propertyName": "@type" }, "allOf": [ { "$ref": "#/components/schemas/ResourceRefOrValueFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "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" }, "name": { "type": "string", "description": "the name of the resource" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/NoteFVO" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItemFVO" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefFVO" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRefFVO" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicFVO" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefFVO" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRefFVO" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/FeatureFVO" } }, "intent": { "$ref": "#/components/schemas/IntentRef_FVO" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifierFVO" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's" }, "@type": { "type": "string" } } } ] }, "MeasurementCollectionJobFVO": { "required": [ "consumingApplicationId", "performanceIndicatorSpecification", "producingApplicationId" ], "type": "object", "properties": { "creationTime": { "type": "string", "description": "The measurement job creation time." }, "lastModifiedTime": { "type": "string", "description": "The last time that a measurement job was modified." }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "adminState": { "type": "string", "enum": [ "locked", "unlocked" ] }, "executionState": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "inProgress", "cancelled", "completed", "failed" ] }, "fileTransferData": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FileTransferDataFVO" } }, "dataAccessEndpoint": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DataAccessEndpointFVO" } }, "jobId": { "type": "string", "description": "The ID of the management job." }, "jobPriority": { "maximum": 10, "minimum": 1, "type": "integer", "description": "The priority of the management job. The way the management application will use the JobPriority to schedule job execution is application specific and outside the scope. Integer, limited to a range of 1 to 10.", "format": "int32" }, "scheduleDefinition": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDefinitionFVO" } }, "consumingApplicationId": { "type": "string", "description": "The identifier of the application that consumes performance indicators." }, "producingApplicationId": { "type": "string", "description": "The identifier of the application that produces performance indicators." }, "granularity": { "type": "string", "enum": [ "g_1mn", "g_5mn", "g_15mn", "g_30mn", "g_1h", "g_24h", "g_1m", "g_1y", "na", "g_10sec", "g_30sec" ] }, "performanceIndicatorGroupSpecification": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationFVO" } }, "performanceIndicatorSpecification": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationFVO" }, { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefFVO" } ] } }, "trackingRecord": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TrackingRecordFVO" } }, "monitoredInstancesCriteria": { "$ref": "#/components/schemas/MonitoredInstancesCriteriaFVO" }, "monitoredClassCriteria": { "$ref": "#/components/schemas/MonitoredClassCriteriaFVO" }, "outputFormat": { "type": "string" }, "reportingPeriod": { "type": "string", "enum": [ "r_1mn", "r_5mn", "r_15mn", "r_30mn", "r_1h", "r_24h", "na" ] }, "jobCollectionFilter": { "$ref": "#/components/schemas/DataFilterMapFVO" }, "searchTaskFilter": { "$ref": "#/components/schemas/DataFilterMapFVO" }, "jobOnDemand": { "type": "boolean", "description": "True if the job is a single job to be executed immediately in which case the reportingPeriod and scheduleDefinition would not be applicable, false otherwise" } }, "description": "The MeasurementCollectionJob to be created" }, "MonitoredClassCriteriaFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "monitoredObjectClass": { "type": "string", "description": "A monitored object class for specifying the set of instances that are referenced by a PM query." }, "objectInstanceFilter": { "type": "string", "description": "A filter that can be used in conjunction with the monitored object class for specifying the set of instances that are referenced by a PM query." } } }, "MonitoredInstancesCriteriaFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "monitoredObjectInstances": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "type": "string" } } } }, "MonthlyScheduleDayOfWeekDefinitionFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "dayOfMonthRecurrence": { "type": "array", "items": { "$ref": "#/components/schemas/DayOfMonthRecurrenceFVO" } }, "recurringDaySequence": { "type": "string" } } }, "NoteFVO": { "required": [ "@type" ], "type": "object", "properties": { "date": { "type": "string", "description": "Date of the note", "example": "2020-11-20T08:00Z" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "author": { "type": "string", "description": "Author of the note", "example": "Mr. N. Bene" }, "text": { "type": "string", "description": "Text of the note", "example": "This is important" } } }, "PartyRefOrPartyRoleRefFVO": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "PartyRef_FVO": { "type": "object", "description": "A Party reference", "allOf": [ { "$ref": "#/components/schemas/PartyRefOrPartyRoleRefFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } } ] }, "PartyRoleRefFVO": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PartyRefOrPartyRoleRefFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "partyId": { "type": "string", "description": "The identifier of the engaged party that is linked to the PartyRole object." }, "partyName": { "type": "string", "description": "The name of the engaged party that is linked to the PartyRole object." } } } ] }, "PlaceRef_FVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Place reference." }, "PolicyRefFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string" } }, "description": "Reference to manage a list of feature specification policy constraints" }, "RelatedPartyRefOrPartyRoleRefFVO": { "required": [ "@type", "role" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "role": { "type": "string", "description": "Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'" }, "partyOrPartyRole": { "oneOf": [ { "$ref": "#/components/schemas/PartyRef_FVO" }, { "$ref": "#/components/schemas/PartyRoleRefFVO" } ] } } }, "RelatedPlaceRefFVO": { "required": [ "@type", "place", "role" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "role": { "type": "string" }, "place": { "$ref": "#/components/schemas/PlaceRef_FVO" } } }, "RelatedResourceOrderItemFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceOrderHref": { "type": "string", "description": "Reference of the related entity." }, "resourceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "itemAction": { "type": "string", "enum": [ "ADD", "MODIFY", "DELETE", "NOCHANGE" ] }, "itemId": { "type": "string", "description": "Identifier of the order item where the resource was managed" }, "role": { "type": "string", "description": "role of the resource order item for this resource" } }, "description": "A list of resource order items related to this resource" }, "ResourceFVO": { "required": [ "@type" ], "type": "object", "discriminator": { "propertyName": "@type" }, "allOf": [ { "$ref": "#/components/schemas/ResourceRefOrValueFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "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" }, "name": { "type": "string", "description": "the name of the resource" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/NoteFVO" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItemFVO" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefFVO" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRefFVO" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicFVO" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefFVO" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRefFVO" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/FeatureFVO" } }, "intent": { "$ref": "#/components/schemas/IntentRef_FVO" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifierFVO" } }, "@type": { "type": "string" } } } ] }, "ResourceRefOrValueFVO": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "ResourceRef_FVO": { "type": "object", "description": "Resource reference, for when Resource is used by other entities.", "allOf": [ { "$ref": "#/components/schemas/ResourceRefOrValueFVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } } ] }, "ResourceRelationshipFVO": { "required": [ "@type", "relationshipType", "resource" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "resourceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicFVO" } }, "resource": { "oneOf": [ { "$ref": "#/components/schemas/DataAccessEndpointFVO" }, { "$ref": "#/components/schemas/LogicalResourceFVO" }, { "$ref": "#/components/schemas/ResourceFVO" }, { "$ref": "#/components/schemas/ResourceRef_FVO" } ] }, "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" } } }, "ResourceSpecificationRefFVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string", "description": "Resource Specification version" } } }, "ScheduleDefinitionFVO": { "required": [ "@type" ], "type": "object", "properties": { "scheduleDefinitionStartTime": { "type": "string", "description": "The Start time of the Schedule Definition" }, "scheduleDefinitionEndTime": { "type": "string", "description": "The End time of the Schedule Definition. If the attribute is empty the Schedule run forever, not having a time constraint." }, "excludedDate": { "type": "array", "description": "A list of specific dates that should be excluded from the Schedule Definition.", "items": { "type": "string", "description": "A list of specific dates that should be excluded from the Schedule Definition." } }, "monthlyScheduleDayOfMonthDefinition": { "type": "array", "description": "The schedule definition for running the threshold job", "items": { "type": "string", "description": "The schedule definition for running the threshold job" } }, "dateScheduleDefintion": { "type": "array", "description": "The date schedule is used to define a schedule that is based on specific dates, such as December 31st 2015, February 28th 2013", "items": { "type": "string", "description": "The date schedule is used to define a schedule that is based on specific dates, such as December 31st 2015, February 28th 2013" } }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "recurringFrequency": { "type": "string", "description": "A recurring frequency to run a job within day that is included in schedule definition, for example: every 5 minutes, 15 minute, 30 minutes, 1 hour" }, "scheduleDefinitionHourRange": { "type": "string", "description": "A list of time ranges within a specific day that the schedule will be active on, for example 08:00-12:00, 16:00-19:00." }, "WeeklyScheduledDefinition": { "type": "array", "description": "The weekly schedule is used to define a schedule that is based on the days of the week, e.g. a schedule that will be active only on Monday and Tuesday.", "items": { "$ref": "#/components/schemas/DayOfWeekRecurrenceFVO" } }, "MonthlyScheduleDayOfWeekDefinition": { "$ref": "#/components/schemas/MonthlyScheduleDayOfWeekDefinitionFVO" } } }, "TrackingRecordFVO": { "required": [ "@type" ], "type": "object", "properties": { "time": { "type": "string", "description": "Describes the time at which the action was done" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string" }, "description": { "type": "string", "description": "Describes the action being done, such as: ack, clear", "example": "[\"acknowledge\",\"clear\"]" }, "characteristic": { "type": "array", "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces", "items": { "$ref": "#/components/schemas/CharacteristicFVO" } }, "systemId": { "type": "string", "description": "Describes the system Id from which the action was done" }, "user": { "type": "string", "description": "Describes the user doing the action" } } }, "EntityRef": { "required": [ "id" ], "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" }, "@referredType": { "type": "string" } }, "description": "Entity reference schema to be use for all entityRef class." }, "MeasurementCollectionJobRef": { "required": [ "@type", "id" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "The URI of the referred entity." }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Reference to a MeasurementCollectionJob" }, "PerformanceMeasurement": { "required": [ "@type" ], "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "description": { "type": "string", "description": "A free-text description of the performance measurement" }, "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJobRef" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "relatedMeasurement": { "maxItems": 2147483647, "minItems": 0, "type": "array", "description": "related Performance measurements array", "items": { "$ref": "#/components/schemas/PerformanceMeasurementRelationship" } }, "tag": { "type": "object", "description": "The optional tag object attached to this entire measurement" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "PerformanceMeasurementCreateEvent": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOccurred": { "type": "string", "format": "date-time" }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/PerformanceMeasurementCreateEventPayload" } }, "description": "PerformanceMeasurement create Event payload" }, "PerformanceMeasurementCreateEventPayload": { "type": "object", "properties": { "performanceMeasurement": { "$ref": "#/components/schemas/PerformanceMeasurement" } }, "description": "PerformanceMeasurementCreateEventPayload generic structure" }, "PerformanceMeasurementRefOrValue": { "required": [ "@type" ], "type": "object", "properties": { "atType": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "PerformanceMeasurementRelationship": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "relationshipType": { "type": "string" }, "relatedMeasurement": { "$ref": "#/components/schemas/PerformanceMeasurementRefOrValue" }, "role": { "type": "string", "description": "The association role for this PerformanceMeasurement" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "related Performance measurements array" }, "PerformanceMeasurementCollectionReadyEvent": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOccurred": { "type": "string", "format": "date-time" }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/PerformanceMeasurementCollectionReadyEventPayload" } }, "description": "PerformanceMeasurement collectionReady Event payload" }, "PerformanceMeasurementCollectionReadyEventPayload": { "type": "object", "properties": { "performanceMeasurement": { "$ref": "#/components/schemas/PerformanceMeasurement" } }, "description": "PerformanceMeasurementCollectionReadyEventPayload generic structure" }, "MeasurementCollectionJobFilesReadyEvent": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOccurred": { "type": "string", "format": "date-time" }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/MeasurementCollectionJobFilesReadyEventPayload" } }, "description": "MeasurementCollectionJob filesReady Event payload" }, "MeasurementCollectionJobFilesReadyEventPayload": { "type": "object", "properties": { "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "description": "MeasurementCollectionJobFilesReadyEventPayload generic structure" }, "MeasurementCollectionJobFilesPreparationErrorEvent": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOccurred": { "type": "string", "format": "date-time" }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/MeasurementCollectionJobFilesPreparationErrorEventPayload" } }, "description": "MeasurementCollectionJob filesPreparationError Event payload" }, "MeasurementCollectionJobFilesPreparationErrorEventPayload": { "type": "object", "properties": { "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "description": "MeasurementCollectionJobFilesPreparationErrorEventPayload generic structure" }, "MeasurementCollectionJobExecutionStateChangeEvent": { "required": [ "@type" ], "type": "object", "properties": { "timeOccurred": { "type": "string", "description": "The time the event occurred." }, "eventTime": { "type": "string", "description": "Time of the event occurrence." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/MeasurementCollectionJobExecutionStateChangeEventPayload" } }, "description": "MeasurementCollectionJob executionStateChange Event payload" }, "MeasurementCollectionJobExecutionStateChangeEventPayload": { "type": "object", "properties": { "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "description": "MeasurementCollectionJobExecutionStateChangeEventPayload generic structure" }, "MeasurementCollectionJobDeleteEvent": { "required": [ "@type" ], "type": "object", "properties": { "timeOccurred": { "type": "string", "description": "The time the event occurred." }, "eventTime": { "type": "string", "description": "Time of the event occurrence." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/MeasurementCollectionJobDeleteEventPayload" } }, "description": "MeasurementCollectionJob delete Event payload" }, "MeasurementCollectionJobDeleteEventPayload": { "type": "object", "properties": { "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "description": "MeasurementCollectionJobDeleteEventPayload generic structure" }, "MeasurementCollectionJobCreateEvent": { "required": [ "@type" ], "type": "object", "properties": { "timeOccurred": { "type": "string", "description": "The time the event occurred." }, "eventTime": { "type": "string", "description": "Time of the event occurrence." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/MeasurementCollectionJobCreateEventPayload" } }, "description": "MeasurementCollectionJob create Event payload" }, "MeasurementCollectionJobCreateEventPayload": { "type": "object", "properties": { "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJobRef" } }, "description": "MeasurementCollectionJobCreateEventPayload generic structure" }, "MeasurementCollectionJobAttributeValueChangeEvent": { "required": [ "@type" ], "type": "object", "properties": { "timeOccurred": { "type": "string", "description": "The time the event occurred." }, "eventTime": { "type": "string", "description": "Time of the event occurrence." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "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 explanation of the event." }, "priority": { "type": "string", "description": "A priority." }, "source": { "$ref": "#/components/schemas/EntityRef" }, "reportingSystem": { "$ref": "#/components/schemas/EntityRef" }, "relatedParty": { "type": "array", "description": "Collection of related parties", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic": { "type": "array", "description": "Collection of analytic characteristics", "items": { "$ref": "#/components/schemas/Characteristic" } }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventType": { "type": "string", "description": "The type of the notification." }, "event": { "$ref": "#/components/schemas/MeasurementCollectionJobAttributeValueChangeEventPayload" } }, "description": "MeasurementCollectionJob attributeValueChange Event payload" }, "MeasurementCollectionJobAttributeValueChangeEventPayload": { "type": "object", "properties": { "measurementCollectionJob": { "$ref": "#/components/schemas/MeasurementCollectionJob" } }, "description": "MeasurementCollectionJobAttributeValueChangeEventPayload generic structure" }, "PerformanceIndicatorSpecRelationshipMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "relationshipType": { "type": "string" }, "role": { "type": "string", "description": "The association role for this service specification" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } } }, "PerformanceIndicatorSpecificationMVO": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValueMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "A word, term, or phrase by which a PerformanceIndicatorSpecification is known and distinguished from other PerformanceIndicatorSpecifications." }, "description": { "type": "string", "description": "A narrative that explains in detail what the PerformanceIndicatorSpecification is." }, "perspective": { "type": "string", "description": "The point of view for the PerformanceIndicatorSpecification, such as a single user instance or aggregation." }, "indicatorCategory": { "type": "string", "description": "A grouping or set of PerformanceIndicatorSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent." }, "indicatorType": { "type": "string", "enum": [ "string", "int", "float", "double" ] }, "derivationAlgorithm": { "type": "string", "description": "A step-by-step procedure used to calculate the value of PerformanceIndicator." }, "derivationMethod": { "type": "string", "description": "For simple calculations, the method used to calculate the value of a PerformanceIndicator, such as average, minimum, maximum, sum and so forth." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "collectionType": { "type": "string", "enum": [ "cumulative", "delta", "discrete_event", "gauge", "status_inspection" ] }, "indicatorUnit": { "type": "string", "description": "The unit by which the indicator is measured. For example, seconds, KBs, rate per second, etc." }, "performanceIndicatorSpecRelationship": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorSpecRelationshipMVO" } } } } ] }, "PerformanceIndicatorGroupSpecificationMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "A word, term, or phrase by which a PerformanceIndicatorGroupSpecification is tagged." }, "groupCategory": { "type": "string", "description": "A grouping or set of PerformanceIndicatorGroupSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent." }, "performanceIndicatorSpecification": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationMVO" }, { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefMVO" } ] } } }, "description": "The PerformanceIndicatorGroupSpecification to be patched" }, "PerformanceIndicatorSpecificationRefMVO": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefOrValueMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string", "description": "Version of the performance indicator specification" } } } ] }, "PerformanceIndicatorSpecificationRefOrValueMVO": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "AttachmentRefMVO": { "required": [ "@type" ], "type": "object", "properties": { "@baseType": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "url": { "type": "string", "description": "Link to the attachment media/content" } } }, "CharacteristicMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "description": "Collection of characteristic relationships", "items": { "$ref": "#/components/schemas/CharacteristicRelationshipMVO" } } }, "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" }, "CharacteristicRelationshipMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "Unique identifier of the characteristic" }, "relationshipType": { "type": "string", "description": "The type of relationship" } }, "description": "Collection of characteristic relationships" }, "DataAccessEndpointMVO": { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "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" }, "name": { "type": "string", "description": "the name of the resource" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/NoteMVO" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItemMVO" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefMVO" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRefMVO" } }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationshipMVO" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicMVO" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefMVO" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRefMVO" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/FeatureMVO" } }, "intent": { "$ref": "#/components/schemas/IntentRef_MVO" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifierMVO" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's" }, "uri": { "type": "string", "description": "URI for using the data access API", "format": "uri" }, "uriQueryFilter": { "$ref": "#/components/schemas/DataFilterMapMVO" }, "apiType": { "type": "string" } } }, "DataFilterMapItem_MVO": { "type": "object", "properties": { "filterTemplate": { "$ref": "#/components/schemas/DataFilterTemplateMVO" }, "stringArray": { "$ref": "#/components/schemas/DataFilterAttributeStringArray" } }, "description": "definition of a field used for filtering template with the associated attributes." }, "DataFilterMapMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/DataFilterMapItem_MVO" } } } }, "DataFilterTemplateMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string", "description": "Unique identifier of this DataFilterTemplate", "example": "6c088cf7f1bc" }, "name": { "type": "string", "description": "Name given to this DataFilterTemplate" }, "description": { "type": "string", "description": "Description of this DataFilterTemplate" } } }, "DayOfMonthRecurrenceMVO": { "required": [ "@type" ], "type": "object", "properties": { "dates": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" } } }, "DayOfWeekRecurrenceMVO": { "required": [ "@type" ], "type": "object", "properties": { "dates": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" } }, "description": "The weekly schedule is used to define a schedule that is based on the days of the week, e.g. a schedule that will be active only on Monday and Tuesday." }, "ExternalIdentifierMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "owner": { "type": "string", "description": "Name of the external system that owns the entity.", "example": "MagentoCommerce" }, "externalIdentifierType": { "type": "string", "description": "Type of the identification, typically would be the type of the entity within the external system", "example": "ProductOrder" }, "id": { "type": "string", "description": "identification of the entity within the external system." } }, "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system." }, "FeatureMVO": { "required": [ "@type", "name" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "featureRelationship": { "type": "array", "description": "Collection of feature relationships", "items": { "$ref": "#/components/schemas/FeatureRelationshipMVO" } }, "featureCharacteristic": { "type": "array", "description": "This is a list of Characteristics for a particular feature.", "items": { "$ref": "#/components/schemas/CharacteristicMVO" } }, "policyConstraint": { "type": "array", "description": "Reference to manage a list of feature specification policy constraints", "items": { "$ref": "#/components/schemas/PolicyRefMVO" } }, "isEnabled": { "type": "boolean", "description": "True if this feature is enabled. Default is true." }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "This is the name for the feature." } }, "description": "Configuration features" }, "FeatureRelationshipMVO": { "required": [ "@type", "id", "relationshipType" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship.", "enum": [ "excluded", "includes", "may include", "requires" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Collection of feature relationships" }, "FileTransferDataMVO": { "type": "object", "properties": { "transportProtocol": { "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" }, "fileLocation": { "type": "string", "format": "uri" }, "fileFormat": { "type": "string" }, "compressionType": { "$ref": "#/components/schemas/CompressionType" }, "retentionPeriod": { "$ref": "#/components/schemas/Duration" }, "packingType": { "$ref": "#/components/schemas/PackingType" } } }, "IntentRef_MVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Intent reference, for when Intent is used by other entities" }, "LogicalResourceMVO": { "required": [ "@type" ], "type": "object", "discriminator": { "propertyName": "@type" }, "allOf": [ { "$ref": "#/components/schemas/ResourceRefOrValueMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "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" }, "name": { "type": "string", "description": "the name of the resource" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/NoteMVO" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItemMVO" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefMVO" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRefMVO" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicMVO" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefMVO" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRefMVO" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/FeatureMVO" } }, "intent": { "$ref": "#/components/schemas/IntentRef_MVO" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifierMVO" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's" }, "@type": { "type": "string" } } } ] }, "MeasurementCollectionJobMVO": { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "fileTransferData": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FileTransferDataMVO" } }, "dataAccessEndpoint": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DataAccessEndpointMVO" } }, "scheduleDefinition": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDefinitionMVO" } }, "executionState": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "inProgress", "cancelled", "completed", "failed" ] }, "consumingApplicationId": { "type": "string", "description": "The identifier of the application that consumes performance indicators." }, "producingApplicationId": { "type": "string", "description": "The identifier of the application that produces performance indicators." }, "granularity": { "type": "string", "enum": [ "g_1mn", "g_5mn", "g_15mn", "g_30mn", "g_1h", "g_24h", "g_1m", "g_1y", "na", "g_10sec", "g_30sec" ] }, "performanceIndicatorGroupSpecification": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PerformanceIndicatorGroupSpecificationMVO" } }, "performanceIndicatorSpecification": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationMVO" }, { "$ref": "#/components/schemas/PerformanceIndicatorSpecificationRefMVO" } ] } }, "trackingRecord": { "maxItems": 2147483647, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TrackingRecordMVO" } }, "outputFormat": { "type": "string" }, "reportingPeriod": { "type": "string", "enum": [ "r_1mn", "r_5mn", "r_15mn", "r_30mn", "r_1h", "r_24h", "na" ] }, "jobCollectionFilter": { "$ref": "#/components/schemas/DataFilterMapMVO" }, "searchTaskFilter": { "$ref": "#/components/schemas/DataFilterMapMVO" }, "jobOnDemand": { "type": "boolean", "description": "True if the job is a single job to be executed immediately in which case the reportingPeriod and scheduleDefinition would not be applicable, false otherwise" } }, "description": "The MeasurementCollectionJob to be patched" }, "MonthlyScheduleDayOfWeekDefinitionMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "dayOfMonthRecurrence": { "type": "array", "items": { "$ref": "#/components/schemas/DayOfMonthRecurrenceMVO" } }, "recurringDaySequence": { "type": "string" } } }, "NoteMVO": { "required": [ "@type" ], "type": "object", "properties": { "date": { "type": "string", "description": "Date of the note", "example": "2020-11-20T08:00Z" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "Identifier of the note within its containing entity", "example": "afa9-3d90aaa8da0f" }, "author": { "type": "string", "description": "Author of the note", "example": "Mr. N. Bene" }, "text": { "type": "string", "description": "Text of the note", "example": "This is important" } } }, "PartyRefOrPartyRoleRefMVO": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "PartyRef_MVO": { "type": "object", "description": "A Party reference", "allOf": [ { "$ref": "#/components/schemas/PartyRefOrPartyRoleRefMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } } ] }, "PartyRoleRefMVO": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PartyRefOrPartyRoleRefMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "partyId": { "type": "string", "description": "The identifier of the engaged party that is linked to the PartyRole object." }, "partyName": { "type": "string", "description": "The name of the engaged party that is linked to the PartyRole object." } } } ] }, "PlaceRef_MVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Place reference." }, "PolicyRefMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string" } }, "description": "Reference to manage a list of feature specification policy constraints" }, "RelatedPartyRefOrPartyRoleRefMVO": { "required": [ "@type", "role" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "role": { "type": "string", "description": "Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'" }, "partyOrPartyRole": { "oneOf": [ { "$ref": "#/components/schemas/PartyRef_MVO" }, { "$ref": "#/components/schemas/PartyRoleRefMVO" } ] } } }, "RelatedPlaceRefMVO": { "required": [ "@type", "place", "role" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "role": { "type": "string" }, "place": { "$ref": "#/components/schemas/PlaceRef_MVO" } } }, "RelatedResourceOrderItemMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceOrderHref": { "type": "string", "description": "Reference of the related entity." }, "resourceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "itemAction": { "type": "string", "enum": [ "ADD", "MODIFY", "DELETE", "NOCHANGE" ] }, "itemId": { "type": "string", "description": "Identifier of the order item where the resource was managed" }, "role": { "type": "string", "description": "role of the resource order item for this resource" } }, "description": "A list of resource order items related to this resource" }, "ResourceMVO": { "required": [ "@type" ], "type": "object", "discriminator": { "propertyName": "@type" }, "allOf": [ { "$ref": "#/components/schemas/ResourceRefOrValueMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "unique identifier" }, "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" }, "name": { "type": "string", "description": "the name of the resource" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ] }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ] }, "resourceStatus": { "type": "string", "enum": [ "alarm", "available", "installed", "not exists", "pendingRemoval", "planned", "reserved", "standby", "suspended", "unknown" ] }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ] }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/NoteMVO" } }, "resourceOrderItem": { "type": "array", "description": "A list of resource order items related to this resource", "items": { "$ref": "#/components/schemas/RelatedResourceOrderItemMVO" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefMVO" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRefMVO" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicMVO" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefMVO" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRefMVO" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "activationFeature": { "type": "array", "description": "Configuration features", "items": { "$ref": "#/components/schemas/FeatureMVO" } }, "intent": { "$ref": "#/components/schemas/IntentRef_MVO" }, "externalIdentifier": { "type": "array", "description": "An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system.", "items": { "$ref": "#/components/schemas/ExternalIdentifierMVO" } }, "@type": { "type": "string" } } } ] }, "ResourceRefOrValueMVO": { "required": [ "@type" ], "type": "object", "properties": { "type": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type" } }, "ResourceRef_MVO": { "type": "object", "description": "Resource reference, for when Resource is used by other entities.", "allOf": [ { "$ref": "#/components/schemas/ResourceRefOrValueMVO" }, { "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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "uuid": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } } ] }, "ResourceRelationshipMVO": { "required": [ "@type", "relationshipType", "resource" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "Unique identifier of the characteristic" }, "resourceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicMVO" } }, "resource": { "oneOf": [ { "$ref": "#/components/schemas/DataAccessEndpointMVO" }, { "$ref": "#/components/schemas/LogicalResourceMVO" }, { "$ref": "#/components/schemas/ResourceMVO" }, { "$ref": "#/components/schemas/ResourceRef_MVO" } ] }, "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" } } }, "ResourceSpecificationRefMVO": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "The identifier of the referred entity." }, "name": { "type": "string", "description": "Name of the referred entity." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "version": { "type": "string", "description": "Resource Specification version" } } }, "ScheduleDefinitionMVO": { "required": [ "@type" ], "type": "object", "properties": { "scheduleDefinitionStartTime": { "type": "string", "description": "The Start time of the Schedule Definition" }, "scheduleDefinitionEndTime": { "type": "string", "description": "The End time of the Schedule Definition. If the attribute is empty the Schedule run forever, not having a time constraint." }, "excludedDate": { "type": "array", "description": "A list of specific dates that should be excluded from the Schedule Definition.", "items": { "type": "string", "description": "A list of specific dates that should be excluded from the Schedule Definition." } }, "WeeklyScheduledDefinition": { "type": "array", "description": "The weekly schedule is used to define a schedule that is based on the days of the week, e.g. a schedule that will be active only on Monday and Tuesday.", "items": { "$ref": "#/components/schemas/DayOfWeekRecurrenceMVO" } }, "monthlyScheduleDayOfMonthDefinition": { "type": "array", "description": "The schedule definition for running the threshold job", "items": { "type": "string", "description": "The schedule definition for running the threshold job" } }, "dateScheduleDefintion": { "type": "array", "description": "The date schedule is used to define a schedule that is based on specific dates, such as December 31st 2015, February 28th 2013", "items": { "type": "string", "description": "The date schedule is used to define a schedule that is based on specific dates, such as December 31st 2015, February 28th 2013" } }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "uuid": { "type": "string", "description": "Identifier of the schedule definition" }, "recurringFrequency": { "type": "string", "description": "A recurring frequency to run a job within day that is included in schedule definition, for example: every 5 minutes, 15 minute, 30 minutes, 1 hour" }, "scheduleDefinitionHourRange": { "type": "string", "description": "A list of time ranges within a specific day that the schedule will be active on, for example 08:00-12:00, 16:00-19:00." }, "MonthlyScheduleDayOfWeekDefinition": { "$ref": "#/components/schemas/MonthlyScheduleDayOfWeekDefinitionMVO" } } }, "TrackingRecordMVO": { "required": [ "@type" ], "type": "object", "properties": { "time": { "type": "string", "description": "Describes the time at which the action was done" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@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" }, "href": { "type": "string" }, "description": { "type": "string", "description": "Describes the action being done, such as: ack, clear", "example": "[\"acknowledge\",\"clear\"]" }, "characteristic": { "type": "array", "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces", "items": { "$ref": "#/components/schemas/CharacteristicMVO" } }, "systemId": { "type": "string", "description": "Describes the system Id from which the action was done" }, "user": { "type": "string", "description": "Describes the user doing the action" }, "uuid": { "type": "string", "description": "Identifier of the TrackingRecord." } } } }, "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" } } } } } } }