doPromoteSSEFiles
post
/ccadmin/v1/serverExtensions/promoteFiles
Initiate promote operation for specified SSE files from preview to live environment. The promote status can be fetched using promoteStatus endpoint
Request
Supported Media Types
- application/json
Root Schema : doPromoteSSEFiles_request
Type:
Show Source
object
-
paths(required):
array paths
An array of SSE files name which is to be promoted from preview to live environment. It should contain non-empty and valid files name which are present on preview environment.
Example:
{
"paths":[
"helloapp.zip",
"itunes.zip"
]
}
Nested Schema : paths
Type:
array
An array of SSE files name which is to be promoted from preview to live environment. It should contain non-empty and valid files name which are present on preview environment.
Show Source
-
Array of:
string
File name without path.
Response
Supported Media Types
- application/json
202 Response
Following model is returned when operation succeeds.
Root Schema : doPromoteSSEFiles_response
Type:
Show Source
object
-
links:
array links
List of navigation links.
-
promoteInitiated:
boolean
Whether promote operation is initiated successfully or not. If promote config & promote request are valid and no conflicting operation is running then only initiation is set to true.
Example:
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/serverExtensions/promoteFiles"
}
],
"promoteInitiated":true
}
Nested Schema : items
Type:
Show Source
object
-
href:
string
The URL of the link.
-
rel:
string
The link's relation to the current page of results: next, prev or self.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100323|Promote action can not be triggered as preview environment is disabled|
|160004|Invalid shared directory path. Please set a valid shared directory path.|
|100327|The server extensions path array cannot be null|
|100328|The server extensions path array cannot be empty.|
|100329|Promote action can not be triggered as SSE isolation lock is not acquired. Please try after sometime.|
|14000|The request cannot be accepted right now, as the extension server restart is in progress. Please retry after some time.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code