Répertorier les fichiers

Utilisez cette API pour extraire la liste des fichiers.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder à ces informations pour votre numéro CSI client et pour le type serviceType disponible.
  • Vous ne pouvez utiliser l'API de fichier CEMLI que si le client a activé la fonctionnalité CEMLI.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/cemli/v1/

Dépendance

Fonctionnalité

  • Cette API expose la liste des fichiers UMP pertinents pour un client et un service.
  • {supportIdentifier} et {serviceType} peuvent être extraits de la dépendance mentionnée.
  • Champs de réponse nécessitant une explication :
    • fileId est l'identificateur unique d'un fichier utilisé pour extraire les détails de fichier.
    • fileType est le type de fichier, tel que SQL, Java ou XML Publisher XLF.
    • parameters correspond à d'autres paramètres d'entrée applicables au traitement de fichier.
    • archived permet de déterminer si un fichier est archivé ou actif.
    Remarque

    La pagination est prise en charge. Pour plus d'informations, reportez-vous à Pagination.

Verbe

GET

Paramètres

Nom Type Description Obligatoire
supportIdentifier Paramètre de chemin Numéro CSI Oui
serviceType Paramètre de chemin Type de service (par exemple, EBSO, EBSZ ou EBSI) Oui
includeArchived Paramètre de requête Inclure ou non les fichiers archivés dans la liste (valeur par défaut = N) Non
excludeOafzip Paramètre de requête Exclure ou non les fichiers ZIP OAF de la liste (valeur par défaut = Y) Non
filename Paramètre de requête Nom de fichier Non
description Paramètre de requête Description de fichier Non
product Paramètre de requête Nom de produit (par exemple, xbol) Non
objectType Paramètre de requête Type de fichier (par exemple, xdf, sql ou java) Non
parameters Paramètre de requête Liste des paramètres d'entrée à utiliser pour le traitement de fichier Non
version Paramètre de requête Version de fichier en cours Non
language Paramètre de requête Langue NLS (par exemple, US, FR) Non
uploadedBy Paramètre de requête Utilisateur par lequel le fichier a été téléchargé (adresse électronique de l'utilisateur) Non
uploadedOn Paramètre de requête Date de téléchargement Non
fileLocation Paramètre de requête Emplacement du fichier téléchargé Non

Exemple de réponse

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