Oracle Cloud Infrastructure Documentation

List Files

Use this API to fetch a list of files.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access this information for your customer CSI and available serviceType.
  • You can use CEMLI file API only if your customer has opted-in for CEMLI functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/cemli/v1/

Dependency

Functionality

  • This API exposes the list of files from UMP relevant to a customer and service.
  • {supportIdentifier} and {serviceType} can be retrieved from the dependency mentioned.
  • Response fields that require explanation:
    • fileId is the unique identifier for a file used to fetch file details.
    • fileType is the type of file like SQL, Java, XML Publisher XLF file.
    • parameters are more input parameters applicable with file processing.
    • archived is used to identify whether a file is archived or active.
    Note

    Pagination is supported. For more information, see Pagination section.

Verb

GET

Parameters

Name Type Description Mandatory
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
serviceType Path parameter Service type (For example, EBSO, EBSZ, or EBSI) Yes
includeArchived Query parameter Include archived files in the list or not (Default Value = N) No
excludeOafzip Query parameter Exclude OAF zip files from the list or not (Default Value = Y) No
filename Query parameter File name No
description Query parameter File description No
product Query parameter Product name (For example, xbol) No
objectType Query parameter File type (For example, xdf, sql, or java) No
parameters Query parameter List of input parameters to be used for file processing No
version Query parameter Current file version No
language Query parameter NLS language (For example, US, FR) No
uploadedBy Query parameter User by whom the file was uploaded that is user email ID. No
uploadedOn Query parameter Date of upload No
fileLocation Query parameter Location of the uploaded file No

Sample response 

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