Oracle Cloud Infrastructure Documentation

Retrieve All Products for a Service

Use this API to get a list of all products for a service.

API

/cemli/v1/customers/{supportIdentifier}/services/{serviceType}/products

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can retrieve all products for a service only for your customer support identifier and service type.
  • You can use CEMLI product API only if your customer has opted-in for CEMLI functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/cemli/v1/

Dependency

Functionality

  • This API returns a list of products for a service identified using serviceType and Customer Support Identifier (CSI) combination.

Verb

GET

Parameters

Name Type Description Mandatory Comments
serviceType Path parameter Service type Yes
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
productId Query parameter No If passed, can be used in with other optional parameters such as productName, applicationId, dbSchema, and active with AND condition.
productName Query parameter No If passed, can be used with other optional parameters such as productId, applicationId, dbSchema, and active with AND condition.
applicationId Query parameter No If passed, can be used with other optional parameters such as productId, productName, dbSchema, and active with AND condition.
dbSchema Query parameter No If passed, can be used with other optional parameters such as productId, productName, applicationId, and active with AND condition.
active Query parameter No If passed, possible values TRUE or FALSE returns active products with other optional parameters such as productId, productName, applicationId, and dbSchema with AND condition.
q Query parameter No If passed, it overrides other optional parameters such as productId, productName, applicationId, dbSchema, and active and search is performed based on value passed here. match is done against all search fields listed at productName and dbSchema at backend with OR condition.
Note

Pagination is supported. For more information, see Pagination section.

Sample response

[
  {
    "productId": 2540,
    "productName": "xbol",
    "description": "xbol custom top",
    "applicationId": 27000,
    "dbSchema": "bolinf",
    "active": true,
    "createdBy": "<user's email ID>",
    "createdDate": "2020-08-26T10:53:51-07:00"
  }
]