Get List of Patches

Use this API to get a list of patches.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get a list of CEMLI patches only for your customer.
  • You can use CEMLI patch 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

  • Get the list of patches.
  • supportIdentifier is one of the values from Get all CSI for a user.
  • serviceType is the relevant typeCode value from Get Configuration for a CSI for a given supportIdentifier.
  • patchId is unique identifier for the patch.
  • name is name of the patch.
  • patchNumber is patch number stored at backend.
  • description is patch description.
  • createdBy is email ID of person who created patch.
  • createdOn is timestamp at which patch was created.
  • products.name is name of product.
  • products.files.fileId is the unique identifier for a file, used to fetch file details.
  • products.files.filename is name of the file.
  • products.files.description is description for given file.
  • products.files.version is version number of the given file.
  • products.files.fileType is the type of file like SQL, Java, XML Publisher XLF file.

Verb

GET

Parameters

Name Type Description Mandatory Comments
serviceType Path parameter Service type Yes
supportIdentifier Path parameter Customer CSI Yes
name Query parameter No

If passed, this parameter can be used with other optional parameters such as description, patchFileName,

includeContent, and includeDeletedPatches with AND condition.

description Query parameter No If passed, this parameter is used with other optional parameters such as name, patchFileName, includeContent, and includeDeletedPatches with AND condition.
patchFileName Query parameter No If passed, this parameter is used with other optional parameters such as name, description, includeContent, and includeDeletedPatches with AND condition.
includeDetails Query parameter No If passed, possible values TRUE or FALSE, returns or does not return product details.
includeContent Query parameter No If passed, possible values TRUE or FALSE returns or does not return PatchFile content as Base64 value.
includeDeletedPatches Query parameter No If passed, this parameter is used with other optional parameters such as name, description, includeContent, and includeDeletedPatches with AND condition. If true, API returns deleted patches.
createdBy Query parameter No If passed, this parameter is used with other optional parameters such as name, description, patchFileName, and includeDeletedPatches with AND condition.
createdOn Query parameter No If passed, this parameter is used with other optional parameters such as name, description, patchFileName, and includeContent with AND condition.
q Query parameter No If passed, it overrides other optional parameters such as name, description, patchFileName, includeContent, and includeDeletedPatches and search is performed based on value passed here. Match is done against all search fields listed at name, description, patchFileName, includeDetails,includeContent, and includeDeletedPatches at backend with OR condition.
patchNumber Query parameter No One or more patch numbers can be passed as query parameter(<URL>?patchNumber= 10000001923&patchNumber =10000001927&patchNumber =10000001922)
Note

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

Sample response

[
  {
    "patchId": 7386,
    "name": "MyManufacturingPatch",
    "patchNumber": 10000002386,
    "patchFileName": "p10000002386_US_R12_cmli.zip",
    "description": "Patch for the myManufacturing module",
    "createdBy": "<user's email ID>",
    "createdOn": "2020-08-26T10:53:51-07:00",
    "products": [
      {
        "name": "xbol",
        "files": [
          {
            "fileId": 10882,
            "fileName": "XxExpenseReportLineEO.xml",
            "description": "CEMLI XML XLF Patch File",
            "version": "121.000001",
            "language": "US",
            "fileType": "xmlp_xlf",
            "phase": "first",
            "sequence": 1
          },
          {
            "fileId": 10886,
            "fileName": "XMLP_PUB_XLF_TILE.xmlp_xlf",
            "description": "CEMLI XML XLF Patch File Upload",
            "version": "121.000001",
            "language": "US",
            "fileType": "xmlp_xlf",
            "phase": "last",
            "sequence": 2
          }
        ]
      },
      {
        "name": "xxeis",
        "files": [
          {
            "fileId": 10980,
            "fileName": "APXCCPUT_XML.xlf",
            "description": "CEMLI XML XLF",
            "version": "121.000001",
            "language": "US",
            "fileType": "xmlp_xlf",
            "phase": "first",
            "sequence": 5
          }
        ]
      }
    ]
  }
]