Dateien auflisten

Mit dieser API können Sie eine Liste der Dateien abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können auf diese Informationen für Ihre Kunden-CSI und den verfügbaren serviceType zugreifen.
  • Sie können die CEMLI-Datei-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 zeigt eine Liste der Dateien von UMP an, die für einen Kunden und einen Service relevant sind.
  • {supportIdentifier} und {serviceType} können aus der angegebenen Abhängigkeit abgerufen werden.
  • Antwortfelder, für die eine Erläuterung erforderlich ist:
    • fileId ist die eindeutige ID für eine Datei zum Abrufen von Dateidetails.
    • fileType ist der Dateityp wie SQL, Java, XML Publisher XLF-Datei.
    • parameters sind weitere Eingabeparameter für die Dateiverarbeitung.
    • Mit archived wird angegeben, ob eine Datei archiviert oder aktiv ist.
    Hinweis

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

Verb

GET

Parameter

Name Typ Beschreibung Obligatorisch
supportIdentifier Pfadparameter CSI-Nummer Ja
serviceType Pfadparameter Servicetyp (z.B. EBSO, EBSZ oder EBSI) Ja
includeArchived Abfrageparameter Archivierte Dateien in die Liste aufnehmen oder nicht (Standardwert = N) Nein
excludeOafzip Abfrageparameter OAF-ZIP-Dateien aus der Liste ausschließen oder nicht (Standardwert = Y) Nein
filename Abfrageparameter Dateiname Nein
description Abfrageparameter Beschreibung der Datei Nein
product Abfrageparameter Produktname (Beispiel: xbol) Nein
objectType Abfrageparameter Dateityp (Beispiel: xdf, sql oder java) Nein
parameters Abfrageparameter Liste der Eingabeparameter für die Dateiverarbeitung Nein
version Abfrageparameter Aktuelle Version der Datei Nein
language Abfrageparameter NLS-Sprache (Beispiel: US, FR) Nein
uploadedBy Abfrageparameter E-Mail-ID des Benutzers, der die Datei hochgeladen hat. Nein
uploadedOn Abfrageparameter Uploaddatum Nein
fileLocation Abfrageparameter Speicherort der hochgeladenen Datei Nein

Beispielantwort

[
  {
    "fileId": 10882,
    "fileName": "XxExpenseReportLineEO.xml",
    "description": "CEMLI XML XLF Patch File",
    "version": "121.000001",
    "language": "US",
    "product": {
      "name": "xbol"
    },
    "fileType": {
      "code": "xmlp_xlf",
      "description": "XML Publisher XLF file"
    },
    "archived": false,
    "parameters": [
      {
        "name": "APPS_SHORT_NAME",
        "value": "xbol",
        "type": "TEXT"
      },
      {
        "name": "TEMPLATE_CODE",
        "value": "APXCCPUT",
        "type": "TEXT"
      }
    ],
    "uploadedBy": "<user e-mail>",
    "uploadedOn": "2020-08-26T10:53:51-07:00"
  },
  {
    "fileId": 10886,
    "fileName": "XMLP_PUB_XLF_TILE.xmlp_xlf",
    "description": "CEMLI XML XLF Patch File Upload",
    "version": "121.000001",
    "language": "US",
    "product": {
      "name": "xbol"
    },
    "fileType": {
      "code": "xmlp_xlf",
      "description": "XML Publisher XLF file"
    },
    "archived": false,
    "parameters": [
      {
        "name": "APPS_SHORT_NAME",
        "value": "xbol",
        "type": "TEXT"
      },
      {
        "name": "TEMPLATE_CODE",
        "value": "APXCCPUT",
        "type": "TEXT"
      }
    ],
    "uploadedBy": "<user's e-mail>",
    "uploadedOn": "2020-08-26T10:53:51-07:00"
  },
  {
    "fileId": 10980,
    "fileName": "APXCCPUT_XML.xlf",
    "description": "CEMLI XML XLF",
    "version": "121.000001",
    "language": "US",
    "product": {
      "name": "xxeis"
    },
    "fileType": {
      "code": "xmlp_xlf",
      "description": "XML Publisher XLF file"
    },
    "archived": false,
    "parameters": [
      {
        "name": "APPS_SHORT_NAME",
        "value": "xxeis",
        "type": "TEXT"
      },
      {
        "name": "TEMPLATE_CODE",
        "value": "template",
        "type": "TEXT"
      }
    ],
    "uploadedBy": "<user e-mail>",
    "uploadedOn": "2020-08-26T10:53:51-07:00"
  }
]