Jump to

• Request
• Response

doEnableSSEPreview

post

/ccadmin/v1/serverExtensions/preview/enable

Enables preview environment for server side extension

Request

Supported Media Types

• application/json

Body ()

Root Schema : doEnablePreview_request

Type: object

Show Source

• enable(required): boolean
  The flag specifies that the preview environment should be enabled. The accepted value for this flag is only true. If you want to disable the preview environment for server side extension then please contact the support team.

{
    "properties":{
        "enable":{
            "description":"The flag specifies that the preview environment should be enabled. The accepted value for this flag is only true. If you want to disable the preview environment for server side extension then please contact the support team.",
            "type":"boolean"
        }
    },
    "required":[
        "enable"
    ],
    "example":{
        "enable":true
    }
}

Example:

{
    "enable":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : doEnableSSEPreview_response

Type: object

Show Source

• links: array links
  List of navigation links.
• message: string
  It gives more details about preview status.
• previewEnabled: boolean
  It specifies that preview is enabled or not for server side extension.
• progress: string
  It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.

{
    "properties":{
        "progress":{
            "description":"It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.",
            "type":"string"
        },
        "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"
                    }
                }
            }
        },
        "message":{
            "description":"It gives more details about preview status.",
            "type":"string"
        },
        "previewEnabled":{
            "description":"It specifies that preview is enabled or not for server side extension.",
            "type":"boolean"
        }
    },
    "example":{
        "progress":"provisioning_complete",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
            }
        ],
        "message":"Preview is enabled.",
        "previewEnabled":true
    }
}

Example:

{
    "progress":"provisioning_complete",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
        }
    ],
    "message":"Preview is enabled.",
    "previewEnabled":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"
        }
    }
}

202 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : doEnableSSEPreview_server_creation_response

Type: object

Show Source

• links: array links
  List of navigation links.
• message: string
  It gives more details about preview status.
• previewEnabled: boolean
  It specifies that preview is enabled or not for server side extension.
• progress: string
  It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.

{
    "properties":{
        "progress":{
            "description":"It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.",
            "type":"string"
        },
        "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"
                    }
                }
            }
        },
        "message":{
            "description":"It gives more details about preview status.",
            "type":"string"
        },
        "previewEnabled":{
            "description":"It specifies that preview is enabled or not for server side extension.",
            "type":"boolean"
        }
    },
    "example":{
        "progress":"provisioning",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
            }
        ],
        "message":"SSE preview environment is being provisioned. This process will take 5-10 minutes, please do not upload or delete any extensions until the provisioning process is complete.",
        "previewEnabled":false
    }
}

Example:

{
    "progress":"provisioning",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
        }
    ],
    "message":"SSE preview environment is being provisioned. This process will take 5-10 minutes, please do not upload or delete any extensions until the provisioning process is complete.",
    "previewEnabled":false
}

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"
        }
    }
}

400 Response

Following model is returned when preview is already enabled.

Body ()

Root Schema : doEnableSSEPreview_badRequest_response

Type: object

Show Source

• links: array links
  List of navigation links.
• message: string
  It gives more details about preview status.
• previewEnabled: boolean
  It specifies that preview is enabled or not for server side extension.
• progress: string
  It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.

{
    "properties":{
        "progress":{
            "description":"It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.",
            "type":"string"
        },
        "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"
                    }
                }
            }
        },
        "message":{
            "description":"It gives more details about preview status.",
            "type":"string"
        },
        "previewEnabled":{
            "description":"It specifies that preview is enabled or not for server side extension.",
            "type":"boolean"
        }
    },
    "example":{
        "progress":"provisioning_complete",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
            }
        ],
        "message":"Preview is already enabled.",
        "previewEnabled":true
    }
}

Example:

{
    "progress":"provisioning_complete",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
        }
    ],
    "message":"Preview is already enabled.",
    "previewEnabled":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| |------------------|------------------| |100322|Preview cannot be enabled| |100330|Request payload is invalid. Please refer to the documentation for this feature.|

Body ()

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"
        }
    }
}

Back to Top