Archive or Restore a File
Use this API to archive or restore 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 allows a specific file upload to UMP relevant to a customer, service, and product.
{supportIdentifier}
,{serviceType}
,{product}
, and{fileId}
can be retrieved from the dependency mentioned.- Request payload to include type of action to be performed.
- Response returns a success or failure code.
Verb
PUT
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 |
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 | Yes |
Sample request
{
"action": "<archive/restore>"
}
Sample response
HTTP response code : 200