REST API for Oracle Communications Service Catalog and Design

URL Structure

Access the Service Catalog and Design REST resources using this URL structure:

curl -X GET https://hostname:port/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification -H "authorization: Bearer Token"

where:

hostname is the URL for your Service Catalog and Design REST server.
port is the port for your Service Catalog and Design REST server.
Bearer Token is the bearer token that is obtained from the authenticator that you use.

For example, the URL for accessing a service specification is:

curl -X GET https://hostname:port/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification

Supported Methods

The Service Catalog and Design REST API supports these HTTP methods:

HTTP Method	Description
`GET`	Get information about: Service specifications Resource specification
`POST`	Create the following: Service specifications Resource specification
`PATCH`	Update an existing resource or service specification (change field values, add characteristics, and so on)
`DELETE`	Delete resource, and service specifications. This isn't a temporary suspension or status change; it's a permanent deletion of an entire specification.

Not all endpoints support all methods.

Media Types

The Service Catalog and Design REST API accepts requests in application/json and application/merge-patch+json and sends responses in the application/json media type.

Supported Headers

The Service Catalog and Design REST API supports these headers in the HTTP request.

Header Description Example

Header	Description	Example
`Authorization`	The type of authorization. The Service Catalog and Design REST API uses HTTP Bearer authentication.	`Authorization: Bearer token` where token is the token that is used to authenticate your requests.
`Content-Type`	The media type of the body of the request. Required for POST requests. The Service Catalog and Design REST API accepts only application/json. For PATCH requests, the following can be used: Merge patch: application/merge-patch+json	`Content-Type: application/json` `Content-Type: application/merge-patch+json`

Authorization

The type of authorization. The Service Catalog and Design REST API uses HTTP Bearer authentication.

Authorization: Bearer token

where token is the token that is used to authenticate your requests.

Content-Type

The media type of the body of the request. Required for POST requests. The Service Catalog and Design REST API accepts only application/json. For PATCH requests, the following can be used:

Merge patch: application/merge-patch+json

Content-Type: application/json

Content-Type: application/merge-patch+json

The Service Catalog and Design REST API responds with these headers in the HTTP response.

Header	Description	Example
`Authorization`	The type of authorization. The Service Catalog and Design REST API uses Bearer Token.	`Authorization: Bearer token` where token is the token that is used to authenticate your requests.
`Content-Type`	The media type of the body of the response. The Service Catalog and Design Designer REST API accepts only application/json.	`Content-Type: application/json`

Additional Parameters

The Service Catalog and Design REST API supports filtering, selection, sorting, expansion, and pagination parameters for some endpoints. Each endpoint described in this document lists which parameters are supported.

The additional parameters are:

Parameter type	Parameter	Method	Description
Filtering		GET	Filters the search results that are returned in GET responses.
Selection	`fields`	GET	Specifies the list of attributes to return as part of a partial representation of the response. Attribute selection is enabled for all first-level attributes. For example, fields=name,description.
Pagination	`limit`	GET	Sets the maximum number of results to return in a single response. The default is 50. The limit can't exceed 10000.
Pagination	`offset`	GET	Sets the number of results to offset the response by. The default is 0. For example, you submit a request without setting offset and you get results 0-50, but there are 100 results. Setting offset to 50 shows the remaining results.

Here is an example:

[
  {
    "project": {
      "id": "101001",
      "name": "Samples"
    },
    "type": "ServiceSpecificationOracle",
    "id": "XX_103-876",
    "href": "/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/XX_103-876",
    "description": "This is a fictitious service provided simply to illustrate patterns that apply to the definition of any real ITC service, and to enable a simple sanity test of standard SNO processing\n",
    "isBundle": false,
    "lastUpdate": "2023-07-31T15:28:26.838Z",
    "lifecycleStatus": "In design",
    "name": "Smoke_Test_RFS",
    "version": "1.0",
    "resourceSpecification": [
      {
        "id": "XX_103-932",
        "href": "/scd/tmf-api/resourceCatalogManagement/v4/resourceSpecification/XX_103-932",
        "name": "Smoke_Test_Resource",
        "@referredType": "Resource Component"
      },
      {
        "id": "XX_103-912",
        "href": "/scd/tmf-api/resourceCatalogManagement/v4/resourceSpecification/XX_103-912",
        "name": "Smoke_Test_Network_Element",
        "@referredType": "Resource Component"
      }
    ],
    "specCharacteristic": [
      {
        "maxCardinality": 1,
        "minCardinality": 0,
        "name": "Primary_Attr",
        "valueType": "NUMBER",
        "@type": "CharacteristicSpecification"
      },
      {
        "maxCardinality": 1,
        "minCardinality": 0,
        "name": "Primary_Name",
        "valueType": "STRING",
        "@type": "CharacteristicSpecification"
      }
    ],
    "targetEntitySchema": {
      "@type": "RFS"
    },
    "@type": "ServiceSpecificationOracle"
  }
]

Filtering

REST Criteria Operator	Example
`=`	`lifecycleStatus=In design`