サービスの全製品の取得
このAPIを使用して、サービスのすべての製品のリストを取得します。
API
/cemli/v1/customers/{supportIdentifier}/services/{serviceType}/products
スコープおよび認可
- このAPIにアクセスするには、
mcs:oci:api:Userスコープが必要です。 - カスタマ・サポートIDおよびサービス・タイプについてのみサービスの全製品を取得できます。
- 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI製品APIを使用できます。
ヘッダー
- Authorization: Bearer <Token>
<Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。
- Identifier: <JWKS Identifier>
<JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。
ベース・パス
/cemli/v1/
依存関係
機能
- このAPIは、serviceTypeとカスタマ・サポートID (CSI)の組合せを使用して識別されたサービスの製品のリストを返します。
動詞
GET
パラメータ
| 名前 | タイプ | 説明 | 必須 | コメント |
|---|---|---|---|---|
serviceType
|
パス・パラメータ | サービス・タイプ | はい | |
supportIdentifier
|
パス・パラメータ | カスタマ・サポートID (CSI) | はい | |
productId
|
問合せパラメータ | いいえ | 渡された場合、productName、applicationId、dbSchema、activeなどの他のオプション・パラメータとともにAND条件で使用されます。 | |
productName
|
問合せパラメータ | いいえ | 渡された場合、productId、applicationId、dbSchema、activeなどの他のオプション・パラメータとともにAND条件で使用されます。 | |
applicationId
|
問合せパラメータ | いいえ | 渡された場合、productId、productName、dbSchema、activeなどの他のオプション・パラメータとともにAND条件で使用されます。 | |
dbSchema
|
問合せパラメータ | いいえ | 渡された場合、productId、productName、applicationId、activeなどの他のオプション・パラメータとともにAND条件で使用されます。 | |
active
|
問合せパラメータ | いいえ | 渡された場合、有効な値(TRUEまたはFALSE)は、productId、productName、applicationId、dbSchemaなどのその他のオプションパラメータとともにAND条件でアクティブな製品を返します。 | |
q
|
問合せパラメータ | いいえ | 渡された場合、productId、productName、applicationId、dbSchema、activeなどの他のオプション・パラメータがオーバーライドされ、ここで渡された値に基づいて検索が実行されます。一致は、バックエンドでproductNameおよびdbSchemaにリストされているすべての検索フィールドに対してOR条件で行われます。 |
サンプル・レスポンス
[
{
"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"
}
]