Alle Produkte für einen Service abrufen

Mit dieser API können Sie eine Liste aller Produkte für einen Service abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können alle Produkte für einen Service nur für Ihre Kundensupport-ID und Ihren Servicetyp abrufen.
  • Sie können die CEMLI-Produkt-API nur verwenden, wenn sich Ihr Kunde für die CEMLI-Funktionalität angemeldet hat.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/cemli/v1/

Abhängigkeit

Funktionalität

  • Diese API gibt eine Liste der Produkte für einen Service zurück, der mit der Kombination aus serviceType und CSI-(Customer Support Identifier-)Nummer identifiziert wird.

Verb

GET

Parameter

Name Typ Beschreibung Obligatorisch Anmerkungen
serviceType Pfadparameter Servicetyp Ja
supportIdentifier Pfadparameter CSI-Nummer Ja
productId Abfrageparameter Nein Wenn dieser Parameter übergeben wird, kann er mit anderen optionalen Parametern wie productName, applicationId, dbSchema und active mit AND-Bedingung verwendet werden.
productName Abfrageparameter Nein Wenn dieser Parameter übergeben wird, kann er mit anderen optionalen Parametern wie productId, applicationId, dbSchema und active mit AND-Bedingung verwendet werden.
applicationId Abfrageparameter Nein Wenn dieser Parameter übergeben wird, kann er mit anderen optionalen Parametern wie productId, productName, dbSchema und active mit AND-Bedingung verwendet werden.
dbSchema Abfrageparameter Nein Wenn dieser Parameter übergeben wird, kann er mit anderen optionalen Parametern wie productId, productName, applicationId und active mit AND-Bedingung verwendet werden.
active Abfrageparameter Nein Wenn der Wert "TRUE" oder "FALSE" übergeben wird, werden aktive Produkte mit anderen optionalen Parametern zurückgegeben, wie productId, productName, applicationId und dbSchema mit AND-Bedingung.
q Abfrageparameter Nein Wenn dieser Parameter übergeben wird, setzt er andere optionale Parameter, wie productId, productName, applicationId, dbSchema und active außer Kraft, und die Suche wird basierend auf dem hier übergebenen Wert durchgeführt. Die Übereinstimmung wird mit allen Suchfeldern geprüft, die unter productName und dbSchema im Backend mit OR-Bedingung aufgeführt sind.
Hinweis

Die Paginierung wird unterstützt. Weitere Informationen finden Sie im Abschnitt Paginierung.

Beispielantwort

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