{ "openapi":"3.0.3", "info":{ "description":"
Last Updated March 2025

You can use Oracle Communications Service Catalog and Design REST API's to view and manage data through the following TMF implementations:

  • TMF 620 Product Catalog Management - only Product Specification Resource.
  • TMF 633 Service Catalog Management - only Service Specification resource.
  • TMF 634 Resource Catalog Management - only Resource Specification resource.

    • Whether you're experienced with or new to REST, use this guide to find what you need, including:

    ", "version":"2026.10.29", "title":"REST API for Oracle Communications Service Catalog and Design", "x-summary":"Last Updated March 2025 You can use Oracle Communications Service Catalog and Design REST API's to view and manage data through the following TMF implementations: TMF 620 Product Catalog Management - only Product Specification Resource." }, "servers":[ { "description":"Service Catalog and Design Server", "url":"https://{hostname}:{port}/", "variables":{ "hostname":{ "default":"", "description":"host name for Service Catalog and Design Server" }, "port":{ "default":"", "description":"port number of Service Catalog and Design Server" } } }, { "description":"TMF 620 Product Catalog Management Service Catalog and Design Server", "url":"https://{hostname}:{port}/scd/tmf-api/productCatalogManagement/v5/productSpecification" }, { "description":"TMF 633 Service Catalog Management Service Catalog and Design Server", "url":"https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4" }, { "description":" TMF 634 Resource Catalog Management Service Catalog and Design Server", "url":"https://{hostname}:{port}/scd/tmf-api/resourceCatalogManagement/v5" } ], "tags":[ { "name":"Client Listeners for Service Specification", "description":"The operations from the Client Listeners for Service Specification category." }, { "name":"Product Specification", "description":"The Product Specification resource lets you view, create, update, and delete product specifications. A product specification is a detailed description of a tangible or intangible object that is externally available as a product offering to customers. A Product specification, also known as product type, consists of detailed description of tangible or intangible characteristics that are made externally available through the product offer. These are the attributes associated with a product offer and define the technical aspects of the product offer." }, { "name":"Resource Specification", "description":"The Resource Specification resource is used to view, create, update, and delete service specifications. A resource specification lets you capture information about a resource such as virtual storage medium and so on." }, { "name":"Service Specification", "description":"The Service Specification resource is used to view, create, update, and delete service specifications. A service specification lets you capture information about a service such as the service level, resource, party, and so on." } ], "paths":{ "/productSpecification":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/productCatalogManagement/v5" } ], "post":{ "tags":[ "Product Specification" ], "summary":"Create a Product Specification", "operationId":"createProductSpecification", "description":"This operation creates a Product Specification entity.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductSpecificationOracle" }, "example":{ "id":"PS001", "name":"NetworkSlicePS", "description":"Network Slice Product Specification", "@type":"ProductSpecificationOracle", "productSpecCharacteristic":[ { "name":"SST", "description":"Slice/Service Type", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "productSpecCharacteristicValue":[ ] } ], "serviceSpecification":[ { "id":"CFS001", "name":"NetworkSliceCFS", "@type":"ServiceSpecificationRefOracle", "role":"PRIMARY" } ], "project":{ "id":"P001", "name":"5G" } } } } }, "responses":{ "201":{ "description":"Created: Your request is successful and a new resource has been created.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductSpecificationOracle" } }, "example":{ "id":"PS001", "href":"/scd/tmf-api/productCatalogManagement/v5/productSpecification/PS001", "name":"NetworkSlicePS", "description":"Network Slice Product Specification", "brand":"Oracle", "isBundle":false, "lastUpdate":"2021-11-19T12:17:46.933Z", "lifecycleStatus":"In design", "version":"1.0", "@type":"ProductSpecificationOracle", "productSpecCharacteristic":[ { "name":"SST", "description":"Slice/Service Type", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "minCardinality":0, "maxCardinality":1, "productSpecCharacteristicValue":[ ] } ], "serviceSpecification":[ { "id":"CFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/CFS001", "name":"NetworkSliceCFS", "@type":"ServiceSpecificationRefOracle", "role":"PRIMARY" } ], "project":{ "id":"P001", "name":"5G" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"productSpecification-post", "x-filename-id":"productspecification-post" }, "get":{ "tags":[ "Product Specification" ], "summary":"Get all Product Specifications", "operationId":"listProductSpecification", "description":"This operation retrieves all the Product Specification entities.", "parameters":[ { "$ref":"#/components/parameters/idQueryParam" }, { "$ref":"#/components/parameters/name" }, { "$ref":"#/components/parameters/description" }, { "$ref":"#/components/parameters/version" }, { "$ref":"#/components/parameters/lifecycleStatus" }, { "$ref":"#/components/parameters/type" }, { "$ref":"#/components/parameters/isBundle" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/fields" } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductSpecificationOracle" } }, "example":[ { "id":"PS001", "href":"/scd/tmf-api/productCatalogManagement/v5/productSpecification/PS001", "name":"NetworkSlicePS", "description":"Network Slice Product Specification", "brand":"Oracle", "isBundle":false, "lastUpdate":"2021-11-19T12:17:46.933Z", "lifecycleStatus":"In design", "version":"1.0", "@type":"ProductSpecificationOracle", "productSpecCharacteristic":[ { "name":"SST", "description":"Slice/Service Type", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "minCardinality":0, "maxCardinality":1, "productSpecCharacteristicValue":[ ] } ], "serviceSpecification":[ { "id":"CFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/CFS001", "name":"NetworkSliceCFS", "@type":"ServiceSpecificationRefOracle", "role":"PRIMARY" } ], "project":{ "id":"P001", "name":"5G" } } ] } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"productSpecification-get", "x-filename-id":"productspecification-get" } }, "/productSpecification/{id}":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/productCatalogManagement/v5" } ], "get":{ "tags":[ "Product Specification" ], "summary":"Get a Product Specification", "operationId":"retrieveProductSpecification", "description":"This operation retrieves a Product Specification entity. Attribute selection is enabled for all first level attributes.", "parameters":[ { "$ref":"#/components/parameters/id" }, { "$ref":"#/components/parameters/fields" } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductSpecificationOracle" }, "example":{ "id":"PS001", "href":"/scd/tmf-api/productCatalogManagement/v5/productSpecification/PS001", "name":"NetworkSlicePS", "description":"Network Slice Product Specification", "brand":"Oracle", "isBundle":false, "lastUpdate":"2021-11-19T12:17:46.933Z", "lifecycleStatus":"In design", "version":"1.0", "@type":"ProductSpecificationOracle", "productSpecCharacteristic":[ { "name":"SST", "description":"Slice/Service Type", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "minCardinality":0, "maxCardinality":1, "productSpecCharacteristicValue":[ ] } ], "serviceSpecification":[ { "id":"CFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/CFS001", "name":"NetworkSliceCFS", "@type":"ServiceSpecificationRefOracle", "role":"PRIMARY" } ], "project":{ "id":"P001", "name":"5G" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"productSpecification-{id}-get", "x-filename-id":"productspecification-id-get" }, "patch":{ "tags":[ "Product Specification" ], "summary":"Update a Product Specification", "operationId":"patchProductSpecification", "description":"This operation updates a Product Specification entity.", "parameters":[ { "$ref":"#/components/parameters/id" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductSpecificationOracle" }, "example":{ "id":"PS001", "name":"NetworkSlicePS", "@type":"ProductSpecificationOracle", "productSpecCharacteristic":[ { "name":"latency", "description":"Latency of the Network Slice", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "productSpecCharacteristicValue":[ ] } ], "project":{ "id":"P001", "name":"5G" } } } } }, "responses":{ "200":{ "description":"Updated", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductSpecificationOracle" }, "example":{ "id":"PS001", "href":"/scd/tmf-api/productCatalogManagement/v5/productSpecification/PS001", "name":"NetworkSlicePS", "description":"Network Slice Product Specification", "brand":"Oracle", "isBundle":false, "lastUpdate":"2021-11-19T12:17:46.933Z", "lifecycleStatus":"In design", "version":"1.0", "@type":"ProductSpecificationOracle", "productSpecCharacteristic":[ { "name":"SST", "description":"Slice/Service Type", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "minCardinality":0, "maxCardinality":1, "productSpecCharacteristicValue":[ ] }, { "name":"latency", "description":"Latency of the Network Slice", "valueType":"STRING", "@type":"ProductSpecCharacteristic", "minCardinality":0, "maxCardinality":1, "productSpecCharacteristicValue":[ ] } ], "serviceSpecification":[ { "id":"CFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/CFS001", "name":"NetworkSliceCFS", "@type":"ServiceSpecificationRefOracle", "role":"PRIMARY" } ], "project":{ "id":"P001", "name":"5G" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"productSpecification-{id}-patch", "x-filename-id":"productspecification-id-patch" }, "delete":{ "tags":[ "Product Specification" ], "summary":"Delete a Product Specification", "operationId":"deleteProductSpecification", "description":"This operation deletes a Product Specification entity.", "parameters":[ { "$ref":"#/components/parameters/id" } ], "responses":{ "204":{ "$ref":"#/components/responses/204" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"productSpecification-{id}-delete", "x-filename-id":"productspecification-id-delete" } }, "/serviceSpecification":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4" } ], "post":{ "tags":[ "Service Specification" ], "summary":"Create a Service Specification", "operationId":"createServiceSpecification", "description":"This operation creates a Service Specification entity.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" }, "example":{ "id":"RFS001", "description":"Network Slice Subnet for 5G Core", "name":"CoreSliceSubnetRFS", "specCharacteristic":[ { "name":"nsId", "description":"Network Slice ID", "valueType":"STRING", "characteristicValueSpecification":[ ] } ], "targetEntitySchema":{ "@type":"RFS" }, "@type":"ServiceSpecificationOracle", "resourceSpecification":[ { "name":"AMF" } ], "project":{ "id":"P001", "name":"5G" } } } } }, "responses":{ "201":{ "description":"Created: Your request is successful and a new resource has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" }, "example":{ "id":"RFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/RFS001", "description":"Network Slice Subnet for 5G Core", "isBundle":false, "lastUpdate":"2021-11-19T12:30:58.187Z", "lifecycleStatus":"In design", "name":"CoreSliceSubnetRFS", "version":"1.0", "resourceSpecification":[ { "id":"101-825", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/101-825", "name":"AMF", "@referredType":"Resource Component" } ], "specCharacteristic":[ { "description":"Network Slice ID", "maxCardinality":1, "minCardinality":0, "name":"nsId", "valueType":"STRING", "characteristicValueSpecification":[ ] } ], "targetEntitySchema":{ "@type":"RFS" }, "@type":"ServiceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"serviceSpecification-post", "x-filename-id":"servicespecification-post" }, "get":{ "tags":[ "Service Specification" ], "summary":"Get all Service Specifications", "description":"This operation lists or finds all the Service Specification entities", "operationId":"listServiceSpecification", "parameters":[ { "$ref":"#/components/parameters/idQueryParam" }, { "$ref":"#/components/parameters/name" }, { "$ref":"#/components/parameters/description" }, { "$ref":"#/components/parameters/version" }, { "$ref":"#/components/parameters/lifecycleStatus" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/fields" } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" } }, "example":[ { "id":"RFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/RFS001", "description":"Network Slice Subnet for 5G Core", "isBundle":false, "lastUpdate":"2021-11-19T12:30:58.187Z", "lifecycleStatus":"In design", "name":"CoreSliceSubnetRFS", "version":"1.0", "resourceSpecification":[ { "id":"101-825", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/101-825", "name":"AMF", "@referredType":"Resource Component" } ], "specCharacteristic":[ { "description":"Network Slice ID", "maxCardinality":1, "minCardinality":0, "name":"nsId", "valueType":"STRING", "characteristicValueSpecification":[ ] } ], "targetEntitySchema":{ "@type":"RFS" }, "@type":"ServiceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } }, { "id":"CFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/CFS001", "isBundle":false, "lastUpdate":"2021-11-19T12:17:47.224Z", "lifecycleStatus":"In design", "name":"NetworkSliceCFS", "version":"1.0", "specCharacteristic":[ ], "targetEntitySchema":{ "@type":"CFS" }, "@type":"ServiceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } } ] } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"serviceSpecification-get", "x-filename-id":"servicespecification-get" } }, "/serviceSpecification/{id}":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4" } ], "get":{ "tags":[ "Service Specification" ], "summary":"Get a Service Specification", "description":"This operation retrieves a Service Specification entity.", "operationId":"retrieveServiceSpecification", "parameters":[ { "$ref":"#/components/parameters/serviceId" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/specificationType" }, { "$ref":"#/components/parameters/version" } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" }, "example":{ "id":"RFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/RFS001", "description":"Network Slice Subnet for 5G Core", "isBundle":false, "lastUpdate":"2021-11-19T12:30:58.187Z", "lifecycleStatus":"In design", "name":"CoreSliceSubnetRFS", "version":"1.0", "resourceSpecification":[ { "id":"101-825", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/101-825", "name":"AMF", "@referredType":"Resource Component" } ], "specCharacteristic":[ { "description":"Network Slice ID", "maxCardinality":1, "minCardinality":0, "name":"nsId", "valueType":"STRING", "characteristicValueSpecification":[ ] } ], "targetEntitySchema":{ "@type":"RFS" }, "@type":"ServiceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"serviceSpecification-{id}-get", "x-filename-id":"servicespecification-id-get" }, "patch":{ "tags":[ "Service Specification" ], "summary":"Update a Service Specification", "description":"This operation updates a Service Specification entity.", "operationId":"patchServiceSpecification", "parameters":[ { "$ref":"#/components/parameters/patch_serviceId" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" }, "example":{ "id":"CFS001", "name":"NetworkSliceCFS", "serviceSpecRelationship":[ { "id":"RFS001", "name":"CoreSliceSubnetRFS" } ], "@type":"ServiceSpecificationOracle", "project":{ "name":"5G" } } } } }, "responses":{ "200":{ "description":"Updated", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" }, "example":{ "id":"CFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/CFS001", "description":"", "isBundle":false, "lastUpdate":"2021-11-19T12:17:47.224Z", "lifecycleStatus":"In design", "name":"NetworkSliceCFS", "version":"1.0", "serviceSpecRelationship":[ { "id":"RFS001", "href":"/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/RFS001", "name":"CoreSliceSubnetRFS", "@referredType":"Resource Facing Service Component" } ], "specCharacteristic":[ ], "targetEntitySchema":{ "@type":"CFS" }, "@type":"ServiceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"serviceSpecification-{id}-patch", "x-filename-id":"servicespecification-id-patch" }, "delete":{ "tags":[ "Service Specification" ], "summary":"Delete a Service Specification", "description":"This operation deletes a Service Specification entity.", "operationId":"deleteServiceSpecification", "parameters":[ { "$ref":"#/components/parameters/serviceId" } ], "responses":{ "204":{ "$ref":"#/components/responses/204" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"serviceSpecification-{id}-delete", "x-filename-id":"servicespecification-id-delete" } }, "/resourceSpecification":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/resourceCatalogManagement/v5" } ], "post":{ "operationId":"createResourceSpecification", "summary":"Create a Resource Specification", "description":"This operation creates a Resource Specification entity.", "tags":[ "Resource Specification" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceSpecificationOracle" }, "example":{ "id":"RS-DC001", "name":"Data Center", "description":"Data Center for 5G Network", "resourceSpecCharacteristic":[ { "name":"nfvoVimName", "description":"Represents the VIM Name in NFVO.", "valueType":"STRING", "resourceSpecCharacteristicValue":[ ], "@type":"ResourceSpecificationCharacteristic" } ], "@type":"ResourceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } } } } }, "responses":{ "201":{ "description":"Created: Your request is successful and a new resource has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceSpecificationOracle" }, "example":{ "id":"RES_0001", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/RES_0001", "description":"", "isBundle":false, "lastUpdate":"2022-05-27T11:40:57.54Z", "lifecycleStatus":"In design", "name":"DOCSIPSR_CPE_1", "version":"1.0", "featureSpecification":[ ], "resourceSpecCharacteristic":[ { "description":"", "maxCardinality":1, "minCardinality":0, "name":"CPE Type", "valueType":"STRING", "resourceSpecCharacteristicValue":[ ], "@type":"ResourceSpecificationCharacteristic" } ], "resourceSpecRelationship":[ { "id":"PSR_116-920", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-920", "name":"CPE_Mgt_System" }, { "id":"PSR_116-942", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-942", "name":"Wareouse" } ], "@type":"ResourceSpecificationOracle", "project":{ "id":"PSR_0001", "name":"TestInitiative" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"resourceSpecification-post", "x-filename-id":"resourcespecification-post" }, "get":{ "operationId":"listResourceSpecification", "summary":"Get all Resource Specifications", "description":"This operation lists or finds all the Resource Specification entities", "tags":[ "Resource Specification" ], "parameters":[ { "$ref":"#/components/parameters/idQueryParam" }, { "$ref":"#/components/parameters/name" }, { "$ref":"#/components/parameters/description" }, { "$ref":"#/components/parameters/version" }, { "$ref":"#/components/parameters/lifecycleStatus" }, { "$ref":"#/components/parameters/type" }, { "$ref":"#/components/parameters/isBundle" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/fields" } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationOracle" } }, "example":[ { "id":"RES_0001", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/RES_0001", "description":"", "isBundle":false, "lastUpdate":"2022-05-27T11:40:57.54Z", "lifecycleStatus":"In design", "name":"DOCSIPSR_CPE_1", "version":"1.0", "featureSpecification":[ ], "resourceSpecCharacteristic":[ { "description":"", "maxCardinality":1, "minCardinality":0, "name":"CPE Type", "valueType":"STRING", "resourceSpecCharacteristicValue":[ ], "@type":"ResourceSpecificationCharacteristic" } ], "resourceSpecRelationship":[ { "id":"PSR_116-920", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-920", "name":"CPE_Mgt_System" }, { "id":"PSR_116-942", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-942", "name":"Wareouse" } ], "@type":"ResourceSpecificationOracle", "project":{ "id":"PSR_0001", "name":"TestInitiative" } } ] } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"resourceSpecification-get", "x-filename-id":"resourcespecification-get" } }, "/resourceSpecification/{id}":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/resourceCatalogManagement/v5" } ], "get":{ "operationId":"retrieveResourceSpecification", "summary":"Get a Resource Specification", "description":"This operation retrieves a Resource Specification entity. Attribute selection is enabled for all first level attributes.", "tags":[ "Resource Specification" ], "parameters":[ { "$ref":"#/components/parameters/resourceId" }, { "$ref":"#/components/parameters/fields" } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceSpecificationOracle" }, "example":{ "id":"RES_0001", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/RES_0001", "description":"", "isBundle":false, "lastUpdate":"2022-05-27T11:40:57.54Z", "lifecycleStatus":"In design", "name":"DOCSIPSR_CPE_1", "version":"1.0", "featureSpecification":[ ], "resourceSpecCharacteristic":[ { "description":"", "maxCardinality":1, "minCardinality":0, "name":"CPE Type", "valueType":"STRING", "resourceSpecCharacteristicValue":[ ], "@type":"ResourceSpecificationCharacteristic" } ], "resourceSpecRelationship":[ { "id":"PSR_116-920", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-920", "name":"CPE_Mgt_System" }, { "id":"PSR_116-942", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-942", "name":"Wareouse" } ], "@type":"ResourceSpecificationOracle", "project":{ "id":"PSR_0001", "name":"TestInitiative" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"resourceSpecification-{id}-get", "x-filename-id":"resourcespecification-id-get" }, "patch":{ "operationId":"patchResourceSpecification", "summary":"Update a Resource Specification", "description":"This operation updates partially a Resource Specification entity.", "tags":[ "Resource Specification" ], "parameters":[ { "$ref":"#/components/parameters/patch_resourceId" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceSpecificationOracle" }, "example":{ "id":"RS-DC001", "name":"Data Center", "description":"Data Center for 5G Network", "resourceSpecCharacteristic":[ { "description":"Represents VIM Account ID in NFVO.", "maxCardinality":1, "minCardinality":0, "name":"nfvoVimAccountId", "valueType":"STRING", "resourceSpecCharacteristicValue":[ ], "@type":"ResourceSpecificationCharacteristic" } ], "@type":"ResourceSpecificationOracle", "project":{ "id":"P001", "name":"5G" } } } } }, "responses":{ "200":{ "description":"Updated", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceSpecificationOracle" }, "example":{ "id":"RES_0001", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/RES_0001", "isBundle":false, "lastUpdate":"2022-05-27T11:56:07.588Z", "lifecycleStatus":"In design", "name":"DOCSIPSR_CPE_1_rename", "version":"1.0", "featureSpecification":[ ], "resourceSpecCharacteristic":[ { "maxCardinality":1, "minCardinality":0, "name":"CPE Type", "valueType":"STRING", "resourceSpecCharacteristicValue":[ ], "@type":"ResourceSpecificationCharacteristic" } ], "resourceSpecRelationship":[ { "id":"PSR_116-920", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-920", "name":"CPE_Mgt_System" }, { "id":"PSR_116-942", "href":"/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification/PSR_116-942", "name":"Wareouse" } ], "@type":"ResourceSpecificationOracle", "project":{ "id":"PSR_0001", "name":"TestInitiative" } } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"resourceSpecification-{id}-patch", "x-filename-id":"resourcespecification-id-patch" }, "delete":{ "operationId":"deleteResourceSpecification", "summary":"Delete a Resource Specification", "description":"This operation deletes a Resource Specification entity.", "tags":[ "Resource Specification" ], "parameters":[ { "$ref":"#/components/parameters/resourceId" } ], "responses":{ "204":{ "$ref":"#/components/responses/204" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"resourceSpecification-{id}-delete", "x-filename-id":"resourcespecification-id-delete" } }, "/listener/serviceSpecificationReleaseEvent":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4" } ], "post":{ "operationId":"listenToServiceSpecificationReleaseEvent", "summary":"Client listeners for ServiceSpecificationReleaseEvent", "description":"This operation notifies a client listener for a Service Specification Release event.", "tags":[ "Client Listeners for Service Specification" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceSpecificationReleaseEvent" }, "example":{ "eventId":"123456", "eventTime":"2025-06-04T08:56:33.315Z", "eventType":"ServiceSpecificationReleaseEvent", "domain":"Service", "event":{ "project":{ "id":"Broadband_Internet", "href":"http://scd_host/scd/model/1.0/content/initiative/Broadband_Internet/1.0", "name":"Broadband Internet", "lifecycleStatus":"released", "acknowledgementUrl":"http://scd_host/scd/tmf-api/serviceCatalogManagement/v4/eventAcknowledge", "@type":"Project", "projectItems":[ { "id":"Voice_CFS", "href":"http://scd_host/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/Voice_CFS?version=1.0", "name":"Voice CFS", "@type":"ServiceSpecificationOracle", "@baseType":"ServiceSpecification" }, { "id":"Text_CFS", "href":"http://scd_host/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/Text_CFS?version=1.0", "name":"Text CFS", "@type":"ServiceSpecificationOracle", "@baseType":"ServiceSpecification" } ] } } } } } }, "responses":{ "201":{ "description":"Notified", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EventSubscription" } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"listener-serviceSpecificationReleaseEvent-post", "x-filename-id":"listener-servicespecificationreleaseevent-post" } }, "/eventAcknowledge":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4" } ], "post":{ "operationId":"eventAcknowledge", "summary":"notification acknowledgement", "description":"This operation enables a client listener to acknowledge service specification event.", "tags":[ "Client Listeners for Service Specification" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EventAcknowledgement" }, "example":{ "eventId":"123456", "eventType":"ServiceSpecificationReleaseEvent", "projectId":"Broadband_Internet", "message":"optional message", "status":"SUCCESS", "projectItemsStatus":[ { "id":"Voice_CFS", "version":"1.0", "status":"SUCCESS", "message":"optional message", "@type":"ServiceSpecificationOracle", "@baseType":"ServiceSpecification" }, { "id":"Text_CFS", "version":"1.0", "status":"SUCCESS", "message":"optional message", "@type":"ServiceSpecificationOracle", "@baseType":"ServiceSpecification" } ] } } } }, "responses":{ "200":{ "description":"Success" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"eventAcknowledge-post", "x-filename-id":"eventacknowledge-post" } }, "/listener/projectStateChangeEvent":{ "servers":[ { "url":"https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4" } ], "post":{ "operationId":"listenToProjectStateChangeEvent", "summary":"Client listener for ProjectStateChangeEvent", "description":"This operation notifies a client listener for a project State Change event.", "tags":[ "Client Listeners for Service Specification" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProjectStateChangeEvent" }, "example":{ "eventId":"123456", "eventTime":"2025-06-04T08:56:33.315Z", "eventType":"ProjectStateChangeEvent", "event":{ "project":{ "id":"Broadband_Internet_PCM", "href":"http://scd_host/scd/model/1.0/content/initiative/Broadband_Internet_PCM/1.0", "name":"Broadband Internet Product Catalog Management", "lifecycleStatus":"functional testing", "contextEventId":"654321", "@type":"Project" } } } } } }, "responses":{ "201":{ "description":"Notified", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EventSubscription" } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "405":{ "$ref":"#/components/responses/405" }, "409":{ "$ref":"#/components/responses/409" }, "500":{ "$ref":"#/components/responses/500" } }, "x-internal-id":"listener-projectStateChangeEvent-post", "x-filename-id":"listener-projectstatechangeevent-post" } } }, "security":[ { "BasicAuthentication":[ ] }, { } ], "components":{ "securitySchemes":{ "BasicAuthentication":{ "type":"http", "scheme":"basic" } }, "parameters":{ "Content-Type":{ "in":"header", "name":"Content-Type", "schema":{ "type":"string" }, "required":false }, "path":{ "in":"query", "name":"path", "schema":{ "type":"string" }, "required":true }, "id":{ "name":"id", "description":"The unique identifier of the Product Specification.", "in":"path", "required":true, "schema":{ "type":"string" }, "examples":{ "service-id":{ "summary":"Product Specification Id", "value":"PS001" } } }, "serviceId":{ "name":"id", "description":"The unique identifier of the Service Specification.", "in":"path", "required":true, "schema":{ "type":"string" }, "examples":{ "service-id":{ "summary":"Service Specification ID", "value":"RFS001" } } }, "patch_serviceId":{ "name":"id", "description":"The unique identifier of the Service Specification.", "in":"path", "required":true, "schema":{ "type":"string" }, "examples":{ "service-id":{ "summary":"Service Specification ID", "value":"CFS001" } } }, "resourceId":{ "name":"id", "description":"The unique identifier of the resource item.", "in":"path", "required":true, "schema":{ "type":"string" }, "examples":{ "service-id":{ "summary":"Resource Specification Id", "value":"RES_0001" } } }, "patch_resourceId":{ "name":"id", "description":"The unique identifier of the resource item.", "in":"path", "required":true, "schema":{ "type":"string" }, "examples":{ "service-id":{ "summary":"Resource Specification ID", "value":"RES_0001" } } }, "limit":{ "name":"limit", "description":"The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.", "in":"query", "required":false, "schema":{ "type":"integer" } }, "name":{ "name":"name", "description":"The name of the product, the service or the resource.", "in":"query", "required":false, "schema":{ "type":"string" } }, "DestinationName":{ "name":"DestinationName", "description":"The unique name of the destination. You can filter destinations using the desitnation name. For example, ?DestinationName=RecordName", "in":"query", "required":false, "schema":{ "type":"string" } }, "description":{ "name":"description", "description":"The description of the product, the service, or the resource.", "in":"query", "required":false, "schema":{ "type":"string" } }, "version":{ "name":"version", "description":"The current version of the product, the service or the resource.", "in":"query", "required":false, "schema":{ "type":"string" } }, "lifecycleStatus":{ "name":"lifecycleStatus", "description":"Not Supported - The current lifecycle status of the product, the service, or the resource.", "in":"query", "required":false, "schema":{ "type":"string" } }, "type":{ "name":"@type", "description":"The class type of the product, the service, or the resource.", "in":"query", "required":false, "schema":{ "type":"string" } }, "baseType":{ "name":"@baseType", "description":"The base class type of the product, the service, or the resource.", "in":"query", "required":false, "schema":{ "type":"string" } }, "schemaLocation":{ "name":"@schemaLocation", "description":"The link to the location where the scheme of the product, service, or the resource is defined.", "in":"query", "required":false, "schema":{ "type":"string" } }, "offset":{ "name":"offset", "description":"The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.", "in":"query", "required":false, "schema":{ "type":"string" } }, "fields":{ "name":"fields", "description":"The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a product specification, service specification, or a resource specification.", "in":"query", "required":false, "schema":{ "type":"string" } }, "productNumber":{ "name":"productNumber", "description":"The unique identifier of the specification.", "in":"query", "required":false, "schema":{ "type":"string" } }, "isBundle":{ "name":"isBundle", "description":"Not Supported -Contains one of the values, True or False. If False, then a single product offering is included. If True, then a bundle of product offerings is included.", "in":"query", "required":false, "schema":{ "type":"string" } }, "brand":{ "name":"brand", "description":"The manufacturer or trademark of the specification.", "in":"query", "required":false, "schema":{ "type":"string" } }, "depth":{ "name":"depth", "description":"The depth at which a resource item occurs in a resource hierarchy.", "in":"query", "required":false, "schema":{ "type":"string" } }, "expand":{ "name":"expand", "in":"query", "required":false, "schema":{ "type":"string" }, "description":"The sub-entities that are embedded into each resource item returned in the response. To avoid huge responses, any sub-entity that contains more than 500 items is not expanded, and it is returned as a usual link. The link can be used to retrieve the sub-entity in a separate call using the limit and offset parameters to control the response size." }, "specification":{ "name":"specification", "in":"query", "required":false, "schema":{ "type":"string" }, "description":"For filtering: product specification ID" }, "specificationType":{ "name":"specificationType", "in":"query", "required":false, "schema":{ "type":"string" }, "description":"The specification type, which can be either CFS or RFS" }, "idQueryParam":{ "name":"id", "description":"The unique identifier of the product, service, or the resource item.", "in":"query", "schema":{ "type":"string" }, "examples":{ "product-id":{ "summary":"Product Specification ID", "value":"PS001" }, "service-id":{ "summary":"Service Specification ID", "value":"RFS001" }, "resource-id":{ "summary":"Resource Specification ID", "value":"RES_0001" } } }, "createdBy":{ "name":"createdBy", "description":"Represents the job request submitter name.", "in":"query", "schema":{ "type":"string" } }, "productSpecification.id":{ "name":"productSpecification.id", "description":"Filter Offerings based on Product Specification ID", "in":"query", "schema":{ "type":"string" } }, "productSpecification.name":{ "name":"productSpecification.name", "description":"Filter Offerings based on Product Specification Name", "in":"query", "schema":{ "type":"string" } }, "whereUsed":{ "name":"whereUsed", "description":"enrich objects with usedBy information", "in":"query", "schema":{ "type":"string" } }, "profileType":{ "name":"profileType", "description":"Type of the profile", "in":"query", "schema":{ "type":"string" } }, "eligibleForProject":{ "name":"eligibleForProject", "description":"Not Supported -Project ID", "in":"query", "schema":{ "type":"string" } } }, "responses":{ "204":{ "description":"Deleted: The request has succeeded." }, "400":{ "description":"Bad Request: Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized: Your request isn't authorized. The authentication credentials included with this request are missing or invalid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden: You don't have authorization to perform this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found: Your request includes a resource URI that doesn't exist.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed: HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict: The request can't be completed due to a conflict with the current state of the resource.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error: The server encountered something unexpected that prevented it from completing the request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "501":{ "description":"Not Implemented: The server doesn't support the functionality required to fulfill the request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "schemas":{ "Any":{ }, "Extensible":{ "type":"object", "description":"Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type", "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", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "required":[ "@type" ] }, "ProductSpecification":{ "title":"ProductSpecification", "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.Specification" ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } }, "properties":{ "id":{ "type":"string", "maxLength":30, "description":"Unique identifier of the product specification" }, "href":{ "type":"string", "description":"Reference of the product specification" }, "name":{ "type":"string", "description":"Name of the product specification" }, "description":{ "type":"string", "description":"A narrative that explains in detail what the product specification is" }, "brand":{ "type":"string", "description":"The manufacturer or trademark of the specification" }, "isBundle":{ "type":"boolean", "description":"isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"Date and time of the last update" }, "lifecycleStatus":{ "type":"string", "description":"Used to indicate the current lifecycle status" }, "productNumber":{ "type":"string", "description":"An identification number assigned to uniquely identity the specification" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "version":{ "type":"string", "description":"Product specification version" }, "@type":{ "type":"string", "description":"class type of the product specification" }, "@baseType":{ "type":"string", "description":"base class type (immediate parent) of the product specification" }, "@schemaLocation":{ "type":"string", "description":"hyperlink reference to schema describing this object" }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "productSpecCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecification" } }, "serviceSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceSpecificationRefOracle" } }, "targetProductSchema":{ "$ref":"#/components/schemas/TargetProductSchema" }, "productSpecificationRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductSpecificationRelationship" } }, "resourceSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationRef" } }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/Attachment" } }, "bundledProductSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundledProductSpecification" } } }, "required":[ "name", "lastUpdate", "lifecycleStatus" ] }, "ProductSpecificationOracle":{ "title":"ProductSpecificationOracle", "allOf":[ { "$ref":"#/components/schemas/ProductSpecification" }, { "properties":{ "project":{ "$ref":"#/components/schemas/ProjectRef" }, "created":{ "type":"string", "format":"date-time", "description":"Date and time of the creation" }, "createdBy":{ "type":"string", "description":"name of the person who created item" }, "lastUpdatedBy":{ "type":"string", "description":"name of the person who updated item" }, "commercialDomain":{ "type":"array", "items":{ "$ref":"#/components/schemas/CommercialDomainRefOracle" } } }, "required":[ "name", "project", "lastUpdate", "lifecycleStatus" ] } ] }, "CommercialDomainRefOracle":{ "title":"CommercialDomainRefOracle", "type":"object", "description":"A Commercial Domain.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the commercial domain" }, "version":{ "type":"string", "description":"Version of the commercial domain" }, "name":{ "type":"string", "description":"Name of the commercial domain" }, "type":{ "type":"string", "description":"Indicates the type of domain." } }, "required":[ "id", "name" ] }, "Error":{ "title":"Error", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "required":[ "code", "reason" ], "discriminator":{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }, "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." } } } ], "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)" }, "TimePeriodOracle":{ "description":"Validity period of the related party", "title":"TimePeriodOracle", "type":"object", "properties":{ "startDateTime":{ "type":"string", "format":"date-time", "description":"An instant of time, starting at the TimePeriod" }, "endDateTime":{ "type":"string", "format":"date-time", "description":"An instant of time, ending at the TimePeriod." } } }, "RelatedParty":{ "title":"RelatedParty", "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of a related party" }, "href":{ "type":"string", "description":"Reference of the related party, could be a party reference or a party role reference" }, "role":{ "type":"string", "description":"Role of the related party." }, "name":{ "type":"string", "description":"Name of the related party" }, "@referredType":{ "type":"string", "description":"The class type of referred party/party role reference" }, "@type":{ "type":"string", "description":"the class type of the RelatedParty" }, "@baseType":{ "type":"string", "description":"The immediate base class type of the RelatedParty" }, "@schemaLocation":{ "type":"string", "description":"A link to the schema describing this RelatedParty entity" } }, "required":[ "id" ] }, "TargetProductSchema":{ "title":"TargetProductSchema", "description":"The reference object to the schema and type of target product which is described by product specification", "type":"object", "properties":{ "@type":{ "type":"string", "description":"class type of the target product" }, "@schemaLocation":{ "type":"string", "description":"This field provides a link to the schema describing the target product" } }, "required":[ "@type", "@schemaLocation" ] }, "Attachment":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Complements the description of an element (for instance a product) through video, pictures...", "properties":{ "name":{ "type":"string", "description":"The name of the attachment" }, "description":{ "type":"string", "description":"A narrative text describing the content of the attachment", "example":"Photograph of the Product" }, "url":{ "type":"string", "description":"Uniform Resource Locator, is a web page address (a subset of URI)", "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "content":{ "type":"string", "format":"base64", "description":"The actual contents of the attachment object, if embedded, encoded as base64" }, "size":{ "$ref":"#/components/schemas/Quantity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachmentType":{ "type":"string", "description":"a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy" }, "mimeType":{ "type":"string", "description":"a technical characterization of the attachment content format using IETF Mime Types" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment" } } }, "ProductSpecificationCharacteristic":{ "title":"ProductSpecificationCharacteristic", "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.ProductCharacteristic" ], "description":"A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", "properties":{ "id":{ "type":"string", "description":"ID of the productSpecCharacteristic" }, "name":{ "type":"string", "description":"Name of the productSpecCharacteristic" }, "description":{ "type":"string", "description":"A narrative that explains in detail what the productSpecCharacteristic is" }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "configurable":{ "type":"boolean", "description":"If true, the Boolean indicates that the productSpecCharacteristic is configurable" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "@type":{ "type":"string", "description":"the class type of this characteristic" }, "@baseType":{ "type":"string", "description":"base class type (immediate parent) of the ProductSpecificationCharacteristic" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"hyperlink reference to the schema describing this characteristic" }, "@valueSchemaLocation":{ "type":"string", "description":"This (optional) field provides a link to the schema describing the value type." }, "minCardinality":{ "type":"integer", "description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" }, "maxCardinality":{ "type":"integer", "description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" }, "isUnique":{ "type":"boolean", "description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "regex":{ "type":"string", "description":"A rule or principle represented in regular expression used to derive the value of a characteristic value" }, "extensible":{ "type":"boolean", "description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" }, "allowedUnits":{ "type":"array", "items":{ "type":"string" } }, "productSpecCharRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductSpecCharRelationship" } }, "productSpecCharacteristicValue":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductSpecificationCharacteristicValue" } } }, "required":[ "name" ] }, "ProductSpecCharRelationship":{ "title":"ProductSpecCharRelationship", "type":"object", "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", "properties":{ "relationshipType":{ "type":"string", "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity", "enum":[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ] }, "validFor":{ "$ref":"#/components/schemas/TimePeriodOracle" }, "charSpecSeq":{ "type":"integer", "description":"The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third.\n" }, "id":{ "type":"string", "description":"the identifier of the associated product specification" }, "name":{ "type":"string", "description":"Name of the target product specification characteristic" }, "href":{ "type":"string", "description":"Hyperlink reference to the target product specification" }, "@type":{ "type":"string", "description":"Class type of target product specification" }, "@baseType":{ "type":"string", "description":"base class type (immediate parent) of the productSpecCharRelationship" }, "@schemaLocation":{ "type":"string", "description":"hyperlink reference to schema describing this object" } }, "required":[ "id", "name", "relationshipType" ] }, "ProductSpecificationCharacteristicValue":{ "title":"ProductSpecificationCharacteristicValue", "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.Characteristic.CharacteristicValue" ], "description":"A number or text that can be assigned to a ProductSpecificationCharacteristic.", "properties":{ "isDefault":{ "type":"boolean", "description":"Indicates if the value is the default value for a characteristic" }, "unitOfMeasure":{ "type":"string", "description":"Could be minutes, GB...", "enum":[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ] }, "validFor":{ "$ref":"#/components/schemas/TimePeriodOracle" }, "value":{ "type":"object", "description":"A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic" }, "valueFrom":{ "type":"string", "description":"The low range value that a characteristic can take on" }, "valueTo":{ "type":"string", "description":"The upper range value that a characteristic can take on" }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text, and so forth" }, "rangeInterval":{ "type":"string", "description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\".", "enum":[ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ] }, "regex":{ "type":"string", "description":"Regular expression to define constraint on the allowed value" }, "@type":{ "type":"string", "description":"The class type of the characteristic value" }, "@baseType":{ "type":"string", "description":"base class type (immediate parent) of the ProductSpecificationCharacteristic" }, "@schemaLocation":{ "type":"string", "description":"Hyperlink reference to schema describing this object" } }, "required":[ "value" ] }, "ProductSpecCharacteristicValueOracle":{ "title":"ProductSpecCharacteristicValueOracle", "type":"object", "allOf":[ { "$ref":"#/components/schemas/ProductSpecificationCharacteristicValue" }, { "properties":{ "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/Attachment" } }, "valueCode":{ "type":"string", "description":"A optional code for the value where applicable, like RGB for color code." }, "valueRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ValueRelationshipOracle" } } } } ] }, "SpecCharacteristicValueOracle":{ "title":"SpecCharacteristicValueOracle", "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.Characteristic.CharacteristicValue" ], "description":"A number or text that can be assigned to a SpecCharacteristic.", "properties":{ "isDefault":{ "type":"boolean", "description":"Indicates if the value is the default value for a characteristic" }, "unitOfMeasure":{ "type":"string", "description":"Could be minutes, GB..." }, "validFor":{ "$ref":"#/components/schemas/TimePeriodOracle" }, "value":{ "type":"object", "description":"A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic" }, "valueFrom":{ "type":"string", "description":"The low range value that a characteristic can take on" }, "valueTo":{ "type":"string", "description":"The upper range value that a characteristic can take on" }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text, and so forth" }, "rangeInterval":{ "type":"string", "description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "regex":{ "type":"string", "description":"Regular expression to define constraint on the allowed value" }, "@type":{ "type":"string", "description":"The class type of the characteristic value" }, "@baseType":{ "type":"string", "description":"base class type (immediate parent) of the SpecCharacteristic" }, "@schemaLocation":{ "type":"string", "description":"Hyperlink reference to schema describing this object" } }, "required":[ "value" ] }, "ProductSpecificationRef":{ "title":"ProductSpecificationRef", "type":"object", "description":"Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the product specification" }, "href":{ "type":"string", "description":"Reference of the product specification" }, "version":{ "type":"string", "description":"Version of the product specification" }, "name":{ "type":"string", "description":"Name of the product specification" }, "@referredType":{ "type":"string", "description":"class type of referred Product Specification" }, "@type":{ "type":"string", "description":"Indicates the (class) type of ProductSpecificationRef." }, "@schemaLocation":{ "type":"string", "description":"This field provides a link to the schema describing this REST resource" }, "@baseType":{ "type":"string", "description":"Indicates the base (class) type of this REST resource" }, "targetProductSchema":{ "$ref":"#/components/schemas/TargetProductSchema" } }, "required":[ "id" ] }, "ServiceSpecificationRef":{ "title":"ServiceSpecificationRef", "type":"object", "description":"Service specification reference: Service Specification(s) required to realize a Product Specification.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the service specification" }, "href":{ "type":"string", "description":"Reference of the service Specification" }, "name":{ "type":"string", "description":"Name of the required Service Specification" }, "version":{ "type":"string", "description":"Service specification version" }, "@referredType":{ "type":"string", "description":"the class type of associated service specification" }, "@type":{ "type":"string", "description":"Indicates the (class) type of ServiceSpecificationRef." }, "@schemaLocation":{ "type":"string", "description":"This field provides a link to the schema describing this REST resource" }, "@baseType":{ "type":"string", "description":"Indicates the base (class) type of this REST resource" }, "targetServiceSchema":{ "$ref":"#/components/schemas/TargetServiceSchema" } }, "required":[ "id" ] }, "ServiceSpecificationRefOracle":{ "title":"ServiceSpecificationRefOracle", "type":"object", "allOf":[ { "$ref":"#/components/schemas/ServiceSpecificationRef" }, { "properties":{ "serviceCode":{ "type":"string", "description":"Code to service specification" }, "role":{ "type":"string", "description":"Service specification role", "enum":[ "PRIMARY", "AUXILIARY" ] } } } ] }, "ProductSpecificationRelationship":{ "title":"ProductSpecificationRelationship", "type":"object", "description":"A migration, substitution, dependency or exclusivity relationship between/among product specifications.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the productSpecification" }, "href":{ "type":"string", "description":"Reference of the productSpecification" }, "relationshipType":{ "type":"string", "description":"Type of relationship such as migration, substitution, dependency, exclusivity", "enum":[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT" ] }, "validFor":{ "$ref":"#/components/schemas/TimePeriodOracle" } }, "required":[ "id", "relationshipType" ] }, "ResourceSpecificationRef":{ "title":"ResourceSpecificationRef", "type":"object", "description":"Resource Specification reference: The Resource Specification is required to realize a Product Specification.", "discriminator":{ "propertyName":"@type", "mapping":{ "ResourceSpecificationRef":"#/components/schemas/ResourceSpecificationRef", "ResourceSpecificationRefOracle":"#/components/schemas/ResourceSpecificationRefOracle" } }, "properties":{ "id":{ "type":"string", "description":"Unique identifier of the resource specification" }, "href":{ "type":"string", "description":"Reference of the resource specification" }, "name":{ "type":"string", "description":"Name of the required Resource Specification" }, "version":{ "type":"string", "description":"Resource specification version" }, "@referredType":{ "type":"string", "description":"the class type of associated resource specification" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" } }, "required":[ "id" ] }, "ResourceSpecificationRefOracle":{ "title":"ResourceSpecificationRefOracle", "allOf":[ { "$ref":"#/components/schemas/ResourceSpecificationRef" }, { "properties":{ "specificationType":{ "type":"string", "description":"type of resource specification", "enum":[ "CONNECTIVITY_SPECIFICATION_STRUCTURE", "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE", "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE", "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE", "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE", "FLOW_INTERFACE_SPECIFICATION_STRUCTURE", "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV4NETWORK_RESOURCE_EXTENSION_STRUCTURE", "IPV4SUBNET_RESOURCE_EXTENSION_STRUCTURE", "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV6NETWORK_RESOURCE_EXTENSION_STRUCTURE", "IPV6SUBNET_RESOURCE_EXTENSION_STRUCTURE", "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE", "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE", "MEDIA_STREAM_SPECIFICATION_STRUCTURE", "NETWORK_SPECIFICATION_STRUCTURE", "NETWORK_ADDRESS_DOMAIN_SPECIFICATION_STRUCTURE", "OTHER_RESOURCE", "PIPE_SPECIFICATION_STRUCTURE", "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE" ] } }, "required":[ "name", "specificationType" ] } ] }, "BundledProductSpecification":{ "title":"BundledProductSpecification", "type":"object", "description":"A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the product specification" }, "href":{ "type":"string", "description":"Reference of the product specification" }, "lifecycleStatus":{ "type":"string", "description":"Used to indicate the current lifecycle status" }, "name":{ "type":"string", "description":"Name of the product specification" }, "@type":{ "type":"string", "description":"the class type of the corresponding product specification" }, "@referredType":{ "type":"string", "description":"The (class) type of the referred specification" } }, "required":[ "id" ] }, "Quantity":{ "title":"Quantity", "description":"A number and unit representing how many of an ProductOffering is available at the offered price.", "type":"object", "properties":{ "amount":{ "type":"number", "description":"A quantity of something, typically the total of a thing or things in number, size, value, extent, or money." }, "units":{ "type":"string", "description":"The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].", "enum":[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ] } }, "required":[ "units", "amount" ] }, "TermDuration":{ "title":"TermDuration", "allOf":[ { "$ref":"#/components/schemas/Quantity" }, { "properties":{ "units":{ "type":"string", "description":"Term duration units", "enum":[ "DAYS", "MONTHS", "WEEKS", "YEARS" ] } } } ] }, "Money":{ "title":"Money", "description":"The amount of money that characterizes the price.", "type":"object", "properties":{ "value":{ "type":"number", "description":"A positive floating point number" }, "unit":{ "type":"string", "description":"Currency (ISO4217 norm uses 3 letters to define the currency)" } }, "required":[ "value", "unit" ] }, "TimePeriod":{ "title":"TimePeriod", "description":"The period for which the productOffering is valid", "type":"object", "properties":{ "startDateTime":{ "type":"string", "format":"date-time", "description":"An instant of time, starting at the TimePeriod" }, "endDateTime":{ "type":"string", "format":"date-time", "description":"An instant of time, ending at the TimePeriod." } }, "required":[ "startDateTime" ] }, "TargetServiceSchema":{ "title":"TargetServiceSchema", "type":"object", "description":"To support v3 imports - The reference object to the schema and type of target product which is described by product specification", "properties":{ "@type":{ "type":"string", "description":"class type of the target product" }, "@baseType":{ "type":"string", "description":"Base class type of the target product" }, "@schemaLocation":{ "type":"string", "description":"This field provides a link to the schema describing the target product" } }, "required":[ "@type", "@schemaLocation" ] }, "TargetEntitySchema":{ "type":"object", "description":"The reference object to the schema and type of target entity which is described by a specification", "required":[ "@schemaLocation", "@type" ], "properties":{ "@schemaLocation":{ "type":"string", "description":"This field provides a link to the schema describing the target entity" }, "@type":{ "type":"string", "description":"Class type of the target entity" } } }, "ProjectRef":{ "title":"ProjectRef", "type":"object", "description":"The existing project is retrieved by ID or name. If the project doesn't exist, a new project is created with the specified name and ID.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the project/initiative" }, "href":{ "type":"string", "description":"Unique reference of the project/initiative" }, "name":{ "type":"string", "description":"Name of the project/initiative. It is required to create a new project" }, "version":{ "type":"string", "description":"Version of the project/initiative" } } }, "ValueRelationshipOracle":{ "title":"ValueRelationshipOracle", "type":"object", "description":"Represent the value of a characteristic forming the constraint rule", "properties":{ "value":{ "type":"object", "description":"Value representing a Relationship attribute" } }, "required":[ "value" ] }, "ServiceSpecification":{ "title":"ServiceSpecification", "type":"object", "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", "required":[ "name" ], "x-implements":[ "oracle.communications.psr.service.tmf.api.Specification" ], "discriminator":{ "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }, "properties":{ "id":{ "type":"string", "maxLength":30, "description":"A string. Unique identifier of the service specification." }, "href":{ "type":"string", "description":"A string. Reference of the service specification." }, "description":{ "type":"string", "description":"A string. A narrative that explains in detail what the service specification is." }, "isBundle":{ "type":"boolean", "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"A date time (DateTime). Date and time of the last update of the service specification." }, "lifecycleStatus":{ "type":"string", "description":"A string. Used to indicate the current lifecycle status of the service specification." }, "name":{ "type":"string", "description":"A string. Name of the service specification." }, "version":{ "type":"string", "description":"A string. Service specification version." }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/AttachmentRef" } }, "constraint":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConstraintRef" }, "description":"This is a list of constraint references applied to this specification" }, "entitySpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntitySpecificationRelationship" }, "description":"Relationship to another specification" }, "featureSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/FeatureSpecification" }, "description":"A list of Features for this specification." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "resourceSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationRef" } }, "serviceLevelSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceLevelSpecificationRef" } }, "serviceSpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceSpecRelationship" } }, "specCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecification" }, "description":"List of characteristics that the entity can take" }, "targetEntitySchema":{ "$ref":"#/components/schemas/TargetEntitySchema", "description":"Pointer to a schema that defines the target entity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "description":"Immediate base (class) type of the Service Specification" }, "@schemaLocation":{ "type":"string", "description":"A link to the schema describing this Service Specification" }, "@type":{ "type":"string", "description":"Class type of the Service Specification" } } }, "ServiceSpecificationOracle":{ "title":"ServiceSpecificationOracle", "type":"object", "allOf":[ { "$ref":"#/components/schemas/ServiceSpecification" }, { "properties":{ "serviceCode":{ "type":"string", "description":"Code to service specification" }, "created":{ "type":"string", "format":"date-time", "description":"Date and time of creation" }, "createdBy":{ "type":"string", "description":"name of the person who created" }, "lastUpdatedBy":{ "type":"string", "description":"name of the person who updated" }, "project":{ "$ref":"#/components/schemas/ProjectRef" } }, "required":[ "project" ] } ] }, "AttachmentRef":{ "type":"object", "title":"AttachmentRef", "description":"A list of attachment references (AttachmentRef [*]). A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the attachment" }, "description":{ "type":"string", "description":"A narrative text describing the content of the attachment" }, "href":{ "type":"string", "description":"Reference of the attachment" }, "name":{ "type":"string", "description":"name of the attachment" }, "url":{ "type":"string", "description":"Uniform Resource Locator, is a web page address (a subset of URI)" }, "@type":{ "type":"string", "description":"the class type of the Attachment" }, "@baseType":{ "type":"string", "description":"The immediate base class type of the attachment" }, "@schemaLocation":{ "type":"string", "description":"A link to the schema describing this attachment entity" }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation" } }, "required":[ "id", "@type" ] }, "ServiceSpecRelationship":{ "type":"object", "title":"ServiceSpecRelationship", "description":"A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, For example, migration, substitution, dependency, or exclusivity relationship.", "properties":{ "id":{ "type":"string", "description":"A string. Unique identifier of the target serviceSpecification." }, "href":{ "type":"string", "description":"A string. Reference of the target serviceSpecification." }, "name":{ "type":"string", "description":"A string. The name given to the target service specification instance." }, "relationshipType":{ "type":"string", "description":"A string. Type of relationship such as migration, substitution, dependency, exclusivity.", "enum":[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ] }, "role":{ "type":"string", "description":"A string. The association role for this service specification." }, "validFor":{ "$ref":"#/components/schemas/TimePeriodOracle" }, "@type":{ "type":"string", "description":"the class type of the service specification relationship" }, "@baseType":{ "type":"string", "description":"The immediate base class type of the service specification relationship" }, "@schemaLocation":{ "type":"string", "description":"A link to the schema describing this service specification relationship entity" }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } }, "required":[ "id", "relationshipType", "@referredType" ] }, "ServiceLevelSpecificationRef":{ "type":"object", "title":"ServiceLevelSpecificationRef", "description":"A list of service level specification references (ServiceLevelSpecificationRef [*]). A list of service level specifications related to this service specification, and which will need to be satisfiable for corresponding service instances; For example, Gold, Platinum.", "properties":{ "id":{ "type":"string", "description":"A string. The identifier to a service level specification." }, "href":{ "type":"string", "description":"A string. The hyperlink to access a service level specification." }, "name":{ "type":"string", "description":"A string. The name of Service Level Specification." }, "@type":{ "type":"string", "description":"the class type of the service specification relationship" }, "@baseType":{ "type":"string", "description":"The immediate base class type of the service specification relationship" }, "@schemaLocation":{ "type":"string", "description":"A link to the schema describing this service specification relationship entity" }, "@referredType":{ "type":"string", "description":"A string. The actual type of the target instance when needed for disambiguation." } }, "required":[ "id" ] }, "BulkError":{ "title":"BulkError", "type":"object", "properties":{ "id":{ "type":"string", "maxLength":30, "description":"Unique identifier of the service specification" }, "name":{ "type":"string", "description":"Name of the service specification" }, "href":{ "type":"string", "description":"Reference of the service specification" }, "errorMessage":{ "type":"string", "description":"Text that provide more details and corrective actions related to the error." }, "@type":{ "type":"string", "description":"The class type of a REST resource." }, "@schemaLocation":{ "type":"string", "description":"it provides a link to the schema describing a REST resource." } } }, "ConstraintRef":{ "type":"object", "description":"Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", "properties":{ "id":{ "type":"string", "description":"reference ID to the target constraint" }, "href":{ "type":"string", "description":"Hyperlink reference to the target constraint" }, "name":{ "type":"string", "description":"Name given to the constraint" }, "version":{ "type":"string", "description":"constraint version" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" }, "@referredType":{ "type":"string", "description":"The (class) type of the referred constraint" } }, "required":[ "id" ] }, "AssociationSpecificationRef":{ "type":"object", "description":"reference to an AssociationSpecification object", "properties":{ "id":{ "type":"string", "description":"unique identifier" }, "href":{ "type":"string", "format":"uri", "description":"Hyperlink reference" }, "name":{ "type":"string", "description":"Name of the related entity." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "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" }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } }, "required":[ "id" ] }, "EntitySpecificationRelationship":{ "type":"object", "description":"A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", "required":[ "relationshipType" ], "properties":{ "id":{ "type":"string", "description":"unique identifier" }, "href":{ "type":"string", "format":"uri", "description":"Hyperlink reference" }, "name":{ "type":"string", "description":"Name of the related entity." }, "relationshipType":{ "type":"string", "description":"Type of relationship such as migration, substitution, dependency, exclusivity" }, "role":{ "type":"string", "description":"The association role for this entity specification" }, "associationSpec":{ "$ref":"#/components/schemas/AssociationSpecificationRef", "description":"A specification for an association used by this relationship" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which the entitySpecRelationship is valid" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "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" }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } } }, "FeatureSpecification":{ "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.FeatureSpecAsCharacteristic" ], "description":"Specification for resource, service or product features", "properties":{ "id":{ "type":"string", "description":"Identifier of the feature specification. Must be locally unique within the containing specification, thus allowing direct access to the feature spec." }, "isBundle":{ "type":"boolean", "description":"A flag indicating if this is a feature group (true) or not (false)" }, "isEnabled":{ "type":"boolean", "description":"A flag indicating if the feature is enabled (true) or not (false)" }, "name":{ "type":"string", "description":"Unique name given to the feature specification" }, "maxCardinality":{ "type":"integer", "description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." }, "minCardinality":{ "type":"integer", "description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." }, "version":{ "type":"string", "description":"Version of the feature specification" }, "policyConstraint":{ "description":"Reference to mangage a list of feature specification policy constraints", "type":"array", "items":{ "$ref":"#/components/schemas/PolicyRef" } }, "featureSpecCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecification" }, "description":"This is a list of characteristics for a particular feature" }, "featureSpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/FeatureSpecificationRelationship" }, "description":"A dependency, exclusivity or aggratation relationship between/among feature specifications." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which this feature specification is valid" }, "@type":{ "type":"string", "description":"Class type of the Feature Specification" } }, "required":[ "name", "@type" ] }, "FeatureSpecificationCharacteristic":{ "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.FeatureSpecCharacteristic" ], "description":"Configuration feature characteristic specification.", "required":[ "name" ], "properties":{ "id":{ "type":"string", "description":"Unique ID for the characteristic" }, "configurable":{ "type":"boolean", "description":"If true, the Boolean indicates that the target Characteristic is configurable" }, "description":{ "type":"string", "description":"A narrative that explains the CharacteristicSpecification." }, "extensible":{ "type":"boolean", "description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource." }, "isUnique":{ "type":"boolean", "description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality":{ "type":"integer", "description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." }, "minCardinality":{ "type":"integer", "description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." }, "name":{ "type":"string", "description":"A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." }, "regex":{ "type":"string", "description":"A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "featureSpecCharRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/FeatureSpecificationCharacteristicRelationship" }, "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among feature characteristics." }, "featureSpecCharacteristicValue":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicValueSpecification" }, "description":"Used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a FeatureCharacteristic object." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period of time for which a characteristic is applicable." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "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" }, "@valueSchemaLocation":{ "type":"string", "description":"This (optional) field provides a link to the schema describing the value type." } } }, "FeatureSpecificationCharacteristicRelationship":{ "type":"object", "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics.", "properties":{ "characteristicId":{ "type":"string", "description":"Unique identifier of the characteristic within the the target feature specification" }, "featureId":{ "type":"string", "description":"Unique identifier of the target feature specification within the resource specification." }, "name":{ "type":"string", "description":"Name of the target characteristic" }, "relationshipType":{ "type":"string", "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" }, "resourceSpecificationHref":{ "type":"string", "format":"uri", "description":"Hyperlink reference to the resource specification containing the target feature and feature characteristic" }, "resourceSpecificationId":{ "type":"string", "description":"Unique identifier of the resource specification containing the target feature and feature characteristic" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which the object is valid" } } }, "FeatureSpecificationRelationship":{ "type":"object", "description":"Relationship between feature specifications", "required":[ "name", "relationshipType", "@type" ], "properties":{ "featureId":{ "type":"string", "description":"Unique identifier of the target feature specification." }, "name":{ "type":"string", "description":"This is the name of the target feature specification." }, "parentSpecificationHref":{ "type":"string", "format":"uri", "description":"Hyperlink reference to the parent specification containing the target feature" }, "parentSpecificationId":{ "type":"string", "description":"Unique identifier of the parent specification containing the target feature" }, "relationshipType":{ "type":"string", "description":"This is the type of the feature specification relationship." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which this feature spoecification relationship is valid." } } }, "CharacteristicValueSpecification":{ "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.Characteristic.CharacteristicValue" ], "description":"specification of a value (number or text or an object) that can be assigned to a Characteristic.", "properties":{ "isDefault":{ "type":"boolean", "description":"If true, the Boolean Indicates if the value is the default value for a characteristic" }, "rangeInterval":{ "type":"string", "description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "regex":{ "type":"string", "description":"A regular expression constraint for given value" }, "unitOfMeasure":{ "type":"string", "description":"A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." }, "valueFrom":{ "type":"object", "description":"The low range value that a characteristic can take on" }, "valueTo":{ "type":"object", "description":"The upper range value that a characteristic can take on" }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic value can take on, such as numeric, text and so forth" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period of time for which a value is applicable." }, "value":{ "type":"object", "description":"A discrete value that the characteristic can take on, or the actual value of the characteristic" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "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" } }, "required":[ "@type" ] }, "CharacteristicSpecification":{ "type":"object", "description":"This class defines a characteristic specification.", "x-implements":[ "oracle.communications.psr.service.tmf.api.ServiceCharacteristic" ], "properties":{ "id":{ "type":"string", "description":"Unique ID for the characteristic" }, "configurable":{ "type":"boolean", "description":"If true, the Boolean indicates that the target Characteristic is configurable" }, "description":{ "type":"string", "description":"A narrative that explains the CharacteristicSpecification." }, "extensible":{ "type":"boolean", "description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource." }, "isUnique":{ "type":"boolean", "description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality":{ "type":"integer", "description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." }, "minCardinality":{ "type":"integer", "description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." }, "name":{ "type":"string", "description":"A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." }, "version":{ "type":"string", "description":"The current version of the characteristic specification." }, "regex":{ "type":"string", "description":"A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "charSpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecificationRelationship" }, "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." }, "characteristicValueSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicValueSpecification" }, "description":"A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period of time for which a characteristic is applicable." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "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" }, "@valueSchemaLocation":{ "type":"string", "description":"This (optional) field provides a link to the schema describing the value type." } }, "required":[ "@type" ] }, "CharacteristicSpecificationOracle":{ "title":"CharacteristicSpecificationOracle", "allOf":[ { "$ref":"#/components/schemas/CharacteristicSpecification" }, { "properties":{ "applicationName":{ "type":"string", "description":"Name of the external application." } } } ] }, "DesignParameterOracle":{ "title":"DesignParameterOracle", "type":"object", "description":"This class defines the design parameter variant of characteristic.", "allOf":[ { "$ref":"#/components/schemas/CharacteristicSpecification" } ] }, "DeliveryParameterOracle":{ "title":"deliveryParameterOracle", "type":"object", "description":"This class defines the delivery parameter variant of characteristic.", "allOf":[ { "$ref":"#/components/schemas/CharacteristicSpecification" } ] }, "CharacteristicSpecificationRelationship":{ "type":"object", "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID.", "properties":{ "characteristicSpecificationId":{ "type":"string", "description":"Unique identifier of the characteristic within the specification" }, "name":{ "type":"string", "description":"Name of the target characteristic within the specification" }, "parentSpecificationHref":{ "type":"string", "format":"uri", "description":"Hyperlink reference to the parent specification containing the target characteristic" }, "parentSpecificationId":{ "type":"string", "description":"Unique identifier of the parent specification containing the target characteristic" }, "relationshipType":{ "type":"string", "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which the object is valid" }, "@type":{ "type":"string", "description":"class type of the product specification" } }, "discriminator":{ "propertyName":"@type", "mapping":{ "CharacteristicSpecificationRelationship":"#/components/schemas/CharacteristicSpecificationRelationship", "CharacteristicSpecificationRelationshipOracle":"#/components/schemas/CharacteristicSpecificationRelationshipOracle" } } }, "ProductSpecifications":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductSpecificationOracle" }, "minItems":1, "maxItems":50 }, "ServiceSpecifications":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceSpecificationOracle" }, "minItems":1, "maxItems":50 }, "ResourceSpecification":{ "type":"object", "description":"Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.", "x-implements":[ "oracle.communications.psr.service.tmf.api.Specification" ], "required":[ "name", "@type" ], "discriminator":{ "propertyName":"@type", "mapping":{ "ResourceSpecification":"#/components/schemas/ResourceSpecification", "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle" } }, "properties":{ "id":{ "type":"string", "description":"Unique identifier of this REST resource" }, "href":{ "type":"string", "description":"Hyperlink reference to this REST resource" }, "category":{ "type":"string", "description":"Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on." }, "description":{ "type":"string", "description":"Description of this REST resource" }, "isBundle":{ "type":"boolean", "description":"A flag indicates that if this resource specification is a bundled specification (true) or single (false)." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"Date and time of the last update of this REST resource" }, "lifecycleStatus":{ "type":"string", "description":"A string. Used to indicate the current lifecycle status of the service specification.", "enum":[ "In design", "In test", "Launched", "Active", "Rejected", "Retired", "Obsolete", "Ready to publish", "Awaiting retirement", "Awaiting obsolete" ] }, "name":{ "type":"string", "description":"Name given to this REST resource" }, "version":{ "type":"string", "description":"Resource Specification version" }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue" }, "description":"Complements the description of an element (for instance a resource) through video, pictures ..." }, "featureSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/FeatureSpecification" }, "description":"A list of Features for this specification." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef" }, "description":"A related party defines party or party role linked to a specific entity." }, "resourceSpecCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecification" }, "description":"A characteristic quality or distinctive feature of a ResourceSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." }, "resourceSpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationRelationship" }, "description":"A migration, substitution, dependency or exclusivity relationship between/among resource specifications." }, "targetResourceSchema":{ "$ref":"#/components/schemas/TargetResourceSchema", "description":"A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which this REST resource is valid" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" }, "intentSpecification":{ "$ref":"#/components/schemas/IntentSpecificationRef" }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier" } } } }, "ResourceSpecificationOracle":{ "title":"ResourceSpecificationOracle", "allOf":[ { "$ref":"#/components/schemas/ResourceSpecification" }, { "properties":{ "project":{ "$ref":"#/components/schemas/ProjectRef" }, "created":{ "type":"string", "format":"date-time", "description":"Date and time of the creation" }, "createdBy":{ "type":"string", "description":"name of the person who created item" }, "lastUpdatedBy":{ "type":"string", "description":"name of the person who updated item" }, "relatedPlaceRefOrValue":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPlaceRefOrValue" } }, "serviceSpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceSpecRelationship" } }, "specificationType":{ "type":"string", "description":"type of resource specification", "enum":[ "CONNECTIVITY_SPECIFICATION_STRUCTURE", "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE", "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE", "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE", "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE", "FLOW_INTERFACE_SPECIFICATION_STRUCTURE", "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV4NETWORK_RESOURCE_EXTENSION_STRUCTURE", "IPV4SUBNET_RESOURCE_EXTENSION_STRUCTURE", "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV6NETWORK_RESOURCE_EXTENSION_STRUCTURE", "IPV6SUBNET_RESOURCE_EXTENSION_STRUCTURE", "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE", "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE", "MEDIA_STREAM_SPECIFICATION_STRUCTURE", "NETWORK_SPECIFICATION_STRUCTURE", "NETWORK_ADDRESS_DOMAIN_SPECIFICATION_STRUCTURE", "OTHER_RESOURCE", "PIPE_SPECIFICATION_STRUCTURE", "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE" ] } }, "required":[ "name", "project", "@type" ] } ] }, "TargetResourceSchema":{ "type":"object", "description":"The reference object to the schema and type of target resource which is described by resource specification", "required":[ "@schemaLocation", "@type" ], "properties":{ "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "description":"This field provides a link to the schema describing the target resource" }, "@type":{ "type":"string", "description":"Class type of the target resource" } } }, "ResourceSpecificationCharacteristic":{ "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.ResourceCharacteristic" ], "description":"This class defines the characteristic features of a resource specification. Every ResourceSpecification has a variety of important attributes, methods, constraints, and\nrelationships, which distinguish a resource specification from other resource specifications.", "properties":{ "id":{ "type":"string", "description":"Unique ID for the characteristic" }, "configurable":{ "type":"boolean", "description":"If true, the Boolean indicates that the ResourceSpecCharacteristic is configurable" }, "description":{ "type":"string", "description":"A narrative that explains the CharacteristicSpecification." }, "extensible":{ "type":"boolean", "description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource." }, "isUnique":{ "type":"boolean", "description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality":{ "type":"integer", "description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." }, "minCardinality":{ "type":"integer", "description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." }, "name":{ "type":"string", "description":"A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." }, "regex":{ "type":"string", "description":"A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "resourceSpecCharRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationCharacteristicRelationship" }, "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." }, "resourceSpecCharacteristicValue":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationCharacteristicValue" }, "description":"A ResourceSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ResourceSpecificationCharacteristic object. The values of the attributes in the ResourceSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ResourceSpecificationCharacteristic object can take on." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period of time for which a characteristic is applicable." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" }, "@valueSchemaLocation":{ "type":"string", "description":"This (optional) field provides a link to the schema describing the value type." } } }, "ResourceDesignParameterOracle":{ "title":"ResourceDesignParameterOracle", "type":"object", "description":"This class defines a Oracle's extension for Resource specification Characteristic.", "allOf":[ { "$ref":"#/components/schemas/ResourceSpecificationCharacteristic" } ] }, "ResourceDeliveryParameterOracle":{ "title":"ResourceDeliveryParameterOracle", "type":"object", "description":"This class defines a Oracle's extension for Resource specification Characteristic.", "allOf":[ { "$ref":"#/components/schemas/ResourceSpecificationCharacteristic" } ] }, "ResourceSpecificationRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"A migration, substitution, dependency or exclusivity relationship between/among resource specifications.", "discriminator":{ "propertyName":"@type", "mapping":{ "ResourceSpecificationRelationship":"#/components/schemas/ResourceSpecificationRelationship", "ResourceSpecificationRelationshipOracle":"#/components/schemas/ResourceSpecificationRelationshipOracle" } }, "properties":{ "id":{ "type":"string", "description":"Unique identifier of target ResourceSpecification" }, "href":{ "type":"string", "description":"Reference of the target ResourceSpecification" }, "defaultQuantity":{ "type":"integer", "description":"The default number of the related resource that should be instantiated, for example a rack would typically have 4 cards, although it could support more." }, "maximumQuantity":{ "type":"integer", "description":"The maximum number of the related resource that should be instantiated, for example a rack supports a maximum of 16 cards" }, "minimumQuantity":{ "type":"integer", "description":"The minimum number of the related resource that should be instantiated, for example a rack must have at least 1 card" }, "name":{ "type":"string", "description":"The name given to the target resource specification instance" }, "relationshipType":{ "type":"string", "description":"Type of relationship such as migration, substitution, dependency, exclusivity" }, "role":{ "type":"string", "description":"The association role for this resource specification" }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceSpecificationCharacteristic" }, "description":"A characteristic that refines the relationship. For example, consider the relationship between a slot and a card. For a half-height card it is important to know the position at which the card is inserted, so a characteristic Position might be defined on the relationship to allow capturing of this in the inventory" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which the ResourceSpecRelationship is valid" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" } } } ] }, "ResourceSpecificationRelationshipOracle":{ "title":"ResourceSpecificationRelationshipOracle", "allOf":[ { "$ref":"#/components/schemas/ResourceSpecificationRelationship" }, { "properties":{ "specificationType":{ "type":"string", "description":"type of resource specification", "enum":[ "CONNECTIVITY_SPECIFICATION_STRUCTURE", "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE", "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE", "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE", "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE", "FLOW_INTERFACE_SPECIFICATION_STRUCTURE", "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV4NETWORK_RESOURCE_EXTENSION_STRUCTURE", "IPV4SUBNET_RESOURCE_EXTENSION_STRUCTURE", "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV6NETWORK_RESOURCE_EXTENSION_STRUCTURE", "IPV6SUBNET_RESOURCE_EXTENSION_STRUCTURE", "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE", "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE", "MEDIA_STREAM_SPECIFICATION_STRUCTURE", "NETWORK_SPECIFICATION_STRUCTURE", "NETWORK_ADDRESS_DOMAIN_SPECIFICATION_STRUCTURE", "OTHER_RESOURCE", "PIPE_SPECIFICATION_STRUCTURE", "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE" ] } }, "required":[ "name", "specificationType" ] } ] }, "ResourceSpecificationCharacteristicValue":{ "type":"object", "x-implements":[ "oracle.communications.psr.service.tmf.api.Characteristic.CharacteristicValue" ], "description":"A number or text that can be assigned to a ResourceSpecCharacteristic.", "properties":{ "isDefault":{ "type":"boolean", "description":"If true, the Boolean Indicates if the value is the default value for a characteristic" }, "rangeInterval":{ "type":"string", "description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "regex":{ "type":"string", "description":"A regular expression constraint for given value" }, "unitOfMeasure":{ "type":"string", "description":"A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." }, "valueFrom":{ "type":"integer", "description":"The low range value that a characteristic can take on" }, "valueTo":{ "type":"integer", "description":"The upper range value that a characteristic can take on" }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic value can take on, such as numeric, text and so forth" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period of time for which a value is applicable." }, "value":{ "type":"object", "description":"A discrete value that the characteristic can take on, or the actual value of the characteristic" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" } } }, "RelatedPlaceRefOrValue":{ "type":"object", "description":"Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the place" }, "href":{ "type":"string", "description":"Unique reference of the place" }, "name":{ "type":"string", "description":"A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role":{ "type":"string" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "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" }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } } }, "ResourceSpecificationCharacteristicRelationship":{ "type":"object", "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among ResourceSpecificationCharacteristics. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID.", "properties":{ "characteristicSpecificationId":{ "type":"string", "description":"Unique identifier of the characteristic within the specification" }, "name":{ "type":"string", "description":"Name of the target characteristic within the specification" }, "relationshipType":{ "type":"string", "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" }, "resourceSpecificationHref":{ "type":"string", "description":"Hyperlink reference to the resource specification containing the target characteristic" }, "resourceSpecificationId":{ "type":"string", "description":"Unique identifier of the resource specification containing the target characteristic" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"The period for which the object is valid" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class" }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name" } } }, "AttachmentRefOrValue":{ "type":"object", "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself", "oneOf":[ { "$ref":"#/components/schemas/Attachment" }, { "$ref":"#/components/schemas/AttachmentRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentRef":"#/components/schemas/AttachmentRef" } } }, "Addressable":{ "type":"object", "description":"Base schema for adressable entities", "properties":{ "href":{ "type":"string", "description":"Hyperlink reference" }, "id":{ "type":"string", "description":"unique identifier" } } }, "RelatedPartyRefOrPartyRoleRef":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity", "properties":{ "role":{ "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'", "type":"string" }, "partyOrPartyRole":{ "$ref":"#/components/schemas/PartyRefOrPartyRoleRef" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPartyRefOrPartyRoleRef":"#/components/schemas/RelatedPartyRefOrPartyRoleRef" } } }, "PartyRefOrPartyRoleRef":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef" }, { "$ref":"#/components/schemas/PartyRoleRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } } }, "PartyRef":{ "type":"object", "description":"A Party reference", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef" } } }, "Entity":{ "type":"object", "description":"Base entity schema for use in TMForum Open-APIs. Property.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/Addressable" } ] }, "EntityRef":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/Addressable" }, { "type":"object", "description":"Entity reference schema to be use for all entityRef class.", "properties":{ "id":{ "type":"string", "description":"The identifier of the referred entity." }, "href":{ "type":"string", "description":"The URI 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." } }, "required":[ "id" ] } ] }, "PartyRoleRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Party role reference. A party role represents the part played by a party in a given context.", "properties":{ "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." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRoleRef":"#/components/schemas/PartyRoleRef" } } }, "IntentSpecificationRef":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentSpecificationRef":"#/components/schemas/IntentSpecificationRef" } } }, "ExternalIdentifier":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.", "properties":{ "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." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ExternalIdentifier":"#/components/schemas/ExternalIdentifier" } } }, "PolicyRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Reference to managed Policy object", "properties":{ "id":{ "type":"string", "description":"unique identifier" }, "href":{ "type":"string", "description":"Hyperlink reference" }, "version":{ "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" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PolicyRef":"#/components/schemas/PolicyRef" } } }, "CharacteristicSpecificationRelationshipOracle":{ "title":"CharacteristicSpecificationRelationshipOracle", "allOf":[ { "$ref":"#/components/schemas/CharacteristicSpecificationRelationship" }, { "type":"object", "properties":{ "specificationType":{ "type":"string", "description":"Indicates parent resource type of the charSpecRelationship" }, "version":{ "type":"string", "description":"Indicates version of resource in charSpecRelationship" }, "conversion":{ "$ref":"#/components/schemas/Conversion" }, "charValueSpecRelationship":{ "type":"array", "description":"Map of input to output values for conversion.", "items":{ "$ref":"#/components/schemas/CharacteristicValueSpecificationRelationshipOracle" } } } } ] }, "CharacteristicValueSpecificationRelationshipOracle":{ "title":"CharacteristicValueSpecificationRelationshipOracle", "description":"A number or text that can be assigned to a CharacteristicValueSpecificationRelationship.", "type":"object", "properties":{ "value":{ "type":"string", "description":"A discrete value that the characteristicValueRelationship can take on. the value type is defined by 'valueType' characteristic." }, "valueType":{ "type":"string", "description":"A kind of value that the characteristic can take on, such as numeric, text, and so forth.", "enum":[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "URL" ] }, "parentValue":{ "type":"string", "description":"A discrete value that the parent characteristicValueRelationship can take on. the value type is defined by 'valueType' characteristic." }, "relationshipType":{ "type":"string", "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity", "enum":[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "MAPS_TO" ] } } }, "Conversion":{ "type":"object", "title":"CoversionBase", "discriminator":{ "propertyName":"type", "mapping":{ "MEASUREMENT":"#/components/schemas/MeasurementConversion", "VALUEMAP":"#/components/schemas/ValueMapConversion" } }, "properties":{ "id":{ "type":"string", "description":"Unique identifier for the conversion." }, "name":{ "type":"string", "description":"Name of the conversion." }, "type":{ "type":"string", "description":"Type of conversion (Measurement or ValueMap)." } }, "required":[ "id", "name" ] }, "MeasurementConversion":{ "title":"Measurement Conversion", "allOf":[ { "$ref":"#/components/schemas/Conversion" } ], "properties":{ "convertFrom":{ "type":"string", "description":"The unit to convert from." }, "convertTo":{ "type":"string", "description":"The unit to convert to." }, "UoMs":{ "type":"array", "description":"Units of measure with conversions.", "items":{ "$ref":"#/components/schemas/UoM" } } } }, "ValueMapConversion":{ "title":"Value Map Conversion", "type":"object", "allOf":[ { "$ref":"#/components/schemas/Conversion" } ], "properties":{ "valueMap":{ "type":"array", "description":"Map of input to output values for conversion.", "items":{ "$ref":"#/components/schemas/ValueMap" } } }, "example":{ "id":"valueMapConv-567", "name":"ContryCodeMap", "type":"VALUEMAP", "valueMap":[ { "input":"IN", "output":"India" }, { "input":"US", "output":"United States" }, { "input":"CA", "output":"Canada" } ] } }, "ValueMap":{ "type":"object", "properties":{ "input":{ "type":"string", "description":"Input value." }, "output":{ "type":"string", "description":"Output value." } } }, "UoM":{ "type":"object", "properties":{ "fromUnit":{ "type":"string", "description":"Unit to convert from." }, "toValue":{ "type":"string", "description":"Value to convert to." } } }, "ServiceSpecificationReleaseEvent":{ "type":"object", "properties":{ "event":{ "$ref":"#/components/schemas/ServiceSpecificationReleaseEventPayload" }, "eventId":{ "type":"string", "description":"The identifier of the notification." }, "eventTime":{ "type":"string", "description":"Time of the event occurrence.", "format":"date-time" }, "eventType":{ "type":"string", "description":"The type of the notification." }, "correlationId":{ "type":"string", "description":"The correlation id for this event." }, "domain":{ "type":"string", "description":"The domain of the event." }, "title":{ "type":"string", "description":"The title of the event." }, "description":{ "type":"string", "description":"An explnatory of the event." }, "priority":{ "type":"string", "description":"A priority." }, "timeOcurred":{ "type":"string", "description":"The time the event occured.", "format":"date-time" } }, "description":"The notification data structure" }, "ServiceSpecificationReleaseEventPayload":{ "type":"object", "properties":{ "project":{ "$ref":"#/components/schemas/ServiceSpecificationReleaseEventProjectPayload" } } }, "ServiceSpecificationReleaseEventProjectPayload":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The identifier of the project." }, "href":{ "type":"string", "description":"The canoncial URL of the project." }, "name":{ "type":"string", "description":"The name of the project." }, "lifecycleStatus":{ "type":"string", "description":"The lifecycle stage of the project." }, "acknowledgementUrl":{ "type":"string", "description":"The callback url for acknowledgement." }, "@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" }, "projectItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceSpecificationRef" } } }, "required":[ "id", "lifecycleStatus", "projectItems" ] }, "EventAcknowledgement":{ "type":"object", "properties":{ "projectItemsStatus":{ "type":"array", "description":"List of project item statuses for each CFS", "items":{ "$ref":"#/components/schemas/ProjectItemStatus" } }, "eventId":{ "type":"string", "description":"The identifier of the notification." }, "eventType":{ "type":"string", "description":"The type of the notification." }, "projectId":{ "type":"string", "description":"The identifier of the project." }, "message":{ "type":"string", "description":"The optional message for the event acknowledgement." }, "status":{ "type":"string", "description":"The status of the event acknowledgement.", "enum":[ "SUCCESS", "FAILURE" ] } }, "description":"The event acknowledgement data structure" }, "ProjectItemStatus":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The identifier of the project item." }, "version":{ "type":"string", "description":"The version of the project item." }, "status":{ "type":"string", "description":"The status of the event acknowledgement.", "enum":[ "SUCCESS", "FAILURE" ] }, "message":{ "type":"string", "description":"The optional message for the project item." }, "@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" }, "ProjectStateChangeEvent":{ "type":"object", "properties":{ "event":{ "$ref":"#/components/schemas/ProjectStateChangeEventPayload" }, "eventId":{ "type":"string", "description":"The identifier of the notification." }, "eventTime":{ "type":"string", "description":"Time of the event occurrence.", "format":"date-time" }, "eventType":{ "type":"string", "description":"The type of the notification." }, "correlationId":{ "type":"string", "description":"The correlation id for this event." }, "domain":{ "type":"string", "description":"The domain of the event." }, "title":{ "type":"string", "description":"The title of the event." }, "description":{ "type":"string", "description":"An explnatory of the event." }, "priority":{ "type":"string", "description":"A priority." }, "timeOcurred":{ "type":"string", "description":"The time the event occured.", "format":"date-time" } }, "description":"The notification data structure" }, "ProjectStateChangeEventPayload":{ "type":"object", "properties":{ "project":{ "$ref":"#/components/schemas/ProjectStateChangeEventProjectPayload" } } }, "ProjectStateChangeEventProjectPayload":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The identifier of the project." }, "href":{ "type":"string", "description":"The canoncial URL of the project." }, "name":{ "type":"string", "description":"The name of the project." }, "lifecycleStatus":{ "type":"string", "description":"The lifecycle stage of the project." }, "contextEventId":{ "type":"string", "description":"The identifier of the notification that initiates the project." }, "@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" } }, "required":[ "id", "lifecycleStatus", "contextEventId" ] }, "EventSubscription":{ "required":[ "callback", "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"Id of the listener" }, "callback":{ "type":"string", "description":"The callback being registered." }, "query":{ "type":"string", "description":"additional data to be passed" } }, "description":"Sets the communication endpoint address the service instance must use to deliver notification information" } } } }