Task 1: Set Up Your REST Client

You need a REST client to create, update, or delete APIs. You can use any REST client available in the market such as cURL, Postman. Refer to the corresponding REST client installation document for downloading the tool.

To help create requests in a client, you can download the Oracle Communications Service Catalog and Design REST API Swagger file and import it into your client. The Swagger file is in JSON format.

Task 2: Obtain Token

You need a bearer token to authenticate your requests. The bearer token can be obtained with user name and password, OIDC client ID, or secret. For using user name and password, create a user in the Identity Access and Management system that you use. The user must be assigned to the /lcm scope that has read/write permissions for the Service Catalog and Design REST API endpoints. See Solution Designer Installation Guide for more details on users and scopes.

After you have a user created and the scope assigned, you need a bearer token to authenticate your requests. To get a bearer token, see the documentation of the authenticator that you use.

Task 3: Make a Sample Request

To check that your connection works, use your REST client to make a simple GET request. Use one of the endpoints your assigned role has read access to. For example, try getting the list of logical devices from Service Catalog and Design environment:

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

where:

• hostname is the URL for the Service Catalog and Design server.
• port is the port for the Service Catalog and Design server.
• Token is the bearer token that is obtained from the authenticator to access REST APIs.

If the request is successful, you'll receive a 200 response with a body as follows:

[
  {
    "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"
  }
]