Elenca file

Utilizzare questa interfaccia API per recuperare una lista di file.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • Puoi accedere a queste informazioni per il tuo CSI cliente e disponibile all'indirizzo serviceType.
  • È possibile utilizzare l'API del file CEMLI solo se il cliente ha optato per la funzionalità CEMLI.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/cemli/v1/

Dipendenza

Funzionalità

  • Questa API espone l'elenco dei file da UMP rilevanti per un cliente e un servizio.
  • È possibile recuperare {supportIdentifier} e {serviceType} dalla dipendenza indicata.
  • Campi di risposta che richiedono una spiegazione:
    • fileId è l'identificativo univoco di un file utilizzato per recuperare i dettagli del file.
    • fileType è il tipo di file, ad esempio SQL, Java, XML Publisher XLF.
    • parameters sono più parametri di input applicabili con l'elaborazione dei file.
    • archived viene utilizzato per identificare se un file è archiviato o attivo.
    Nota

    L'impaginazione è supportata. Per ulteriori informazioni, vedere la sezione Paginazione.

Verbo

GET

Parametri

Nome Digita descrizione; obbligatorio
supportIdentifier Parametro percorso Identificativo CSI (Customer Support Identifier)
serviceType Parametro percorso Tipo di servizio (ad esempio EBSO, EBSZ o EBSI)
includeArchived Parametro della query Includere o meno i file archiviati nell'elenco (valore predefinito = N) No
excludeOafzip Parametro della query Escludi o meno i file zip OAF dall'elenco (valore predefinito = Y) No
filename Parametro della query Nome file No
description Parametro della query Descrizione file No
product Parametro della query Nome del prodotto (ad esempio, xbol) No
objectType Parametro della query Tipo di file (ad esempio, xdf, sql o java) No
parameters Parametro della query Elenco dei parametri di input da utilizzare per l'elaborazione dei file No
version Parametro della query Versione file corrente No
language Parametro della query Lingua NLS (ad esempio, US, FR) No
uploadedBy Parametro della query Utente da cui è stato caricato il file che è l'ID di posta elettronica utente. No
uploadedOn Parametro della query Data caricamento No
fileLocation Parametro della query Posizione del file caricato No

Risposta di esempio

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