REST API for Oracle Commerce Cloud

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: object

Show Source

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.

{
    "properties":{
        "paths":{
            "description":"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.",
            "type":"array",
            "items":{
                "description":"File name without path.",
                "type":"string"
            }
        }
    },
    "required":[
        "paths"
    ],
    "example":{
        "paths":[
            "helloapp.zip",
            "itunes.zip"
        ]
    }
}

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.

{
    "description":"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.",
    "type":"array",
    "items":{
        "description":"File name without path.",
        "type":"string"
    }
}

Response

Supported Media Types

application/json

202 Response

Following model is returned when operation succeeds.

Root Schema : doPromoteSSEFiles_response

Type: object

Show Source

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.

{
    "properties":{
        "links":{
            "description":"List of navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The link's relation to the current page of results: next, prev or self.",
                        "type":"string"
                    },
                    "href":{
                        "description":"The URL of the link.",
                        "type":"string"
                    }
                }
            }
        },
        "promoteInitiated":{
            "description":"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.",
            "type":"boolean"
        }
    },
    "example":{
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadminui/v1/serverExtensions/promoteFiles"
            }
        ],
        "promoteInitiated":true
    }
}

Example:

{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/serverExtensions/promoteFiles"
        }
    ],
    "promoteInitiated":true
}

Nested Schema : links

Type: array

List of navigation links.

Show Source

Array of: object items

{
    "description":"List of navigation links.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"The link's relation to the current page of results: next, prev or self.",
                "type":"string"
            },
            "href":{
                "description":"The URL of the link.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

href: string

The URL of the link.
rel: string

The link's relation to the current page of results: next, prev or self.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The link's relation to the current page of results: next, prev or self.",
            "type":"string"
        },
        "href":{
            "description":"The URL of the link.",
            "type":"string"
        }
    }
}

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: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}