Oracle Cloud Infrastructure Documentation

Get File Details

Use this API to fetch details of a file.

API

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

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}, {serviceType}, {product}, and {field} 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 to identify whether a file is archived or active.

Verb

GET

Parameters

Name Type Description Mandatory
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
serviceType Path parameter Service type (For example, EBSO, EBSZ, EBSI) Yes
product Path parameter Specifies the short name of the custom product (For example, xbol) Yes
field Path parameter Specifies the ID for the uploaded file in ACE Yes
includeContent Query parameter Default value = N No

Sample response 

{
  "fileId": 10882,
  "fileName": "XxExpenseReportLineEO.xml",
  "fileContent": "QUNFIHRlc3QgUGF0Y2g=",
  "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-10-18T17:22:14Z"
}