Jump to

• Request
• Response

listServerSideExtensions

get

/ccadmin/v1/sse

Lists the OOTB Server Side Extensions

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listServerSideExtensions_response

Type: object

Show Source

• items: array items
  List of all OOTB server Side Extensions

{
    "properties":{
        "items":{
            "description":"List of all OOTB server Side Extensions",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fileName":{
                        "description":"Name of the OOTB Server Side Extension File",
                        "type":"string"
                    },
                    "name":{
                        "description":"name of the file",
                        "type":"string"
                    },
                    "description":{
                        "description":"Description of the OOTB Server Side Extension",
                        "type":"string"
                    },
                    "id":{
                        "description":"Repository ID of the OOTB Server Side Extension",
                        "type":"string"
                    },
                    "version":{
                        "description":"version of the OOTB Server Side Extension",
                        "type":"string"
                    },
                    "directory":{
                        "description":"Directory in which OOTB Server Side Extension resides",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of all OOTB server Side Extensions

Show Source

• Array of: object items

{
    "description":"List of all OOTB server Side Extensions",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fileName":{
                "description":"Name of the OOTB Server Side Extension File",
                "type":"string"
            },
            "name":{
                "description":"name of the file",
                "type":"string"
            },
            "description":{
                "description":"Description of the OOTB Server Side Extension",
                "type":"string"
            },
            "id":{
                "description":"Repository ID of the OOTB Server Side Extension",
                "type":"string"
            },
            "version":{
                "description":"version of the OOTB Server Side Extension",
                "type":"string"
            },
            "directory":{
                "description":"Directory in which OOTB Server Side Extension resides",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Description of the OOTB Server Side Extension
• directory: string
  Directory in which OOTB Server Side Extension resides
• fileName: string
  Name of the OOTB Server Side Extension File
• id: string
  Repository ID of the OOTB Server Side Extension
• name: string
  name of the file
• version: string
  version of the OOTB Server Side Extension

{
    "type":"object",
    "properties":{
        "fileName":{
            "description":"Name of the OOTB Server Side Extension File",
            "type":"string"
        },
        "name":{
            "description":"name of the file",
            "type":"string"
        },
        "description":{
            "description":"Description of the OOTB Server Side Extension",
            "type":"string"
        },
        "id":{
            "description":"Repository ID of the OOTB Server Side Extension",
            "type":"string"
        },
        "version":{
            "description":"version of the OOTB Server Side Extension",
            "type":"string"
        },
        "directory":{
            "description":"Directory in which OOTB Server Side Extension resides",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "fileName":"punchout-app.zip",
        "name":"@oracle-commerce-cloud/punchout-app",
        "description":"ssePunchoutApp",
        "id":"sse100001",
        "version":"18.4.0",
        "directory":"punchout"
    },
    {
        "fileName":"punchout-lib.zip",
        "name":"@oracle-commerce-cloud/punchout-lib",
        "description":"ssePunchoutLib",
        "id":"sse100002",
        "version":"18.4.0",
        "directory":"punchout"
    }
]

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| |------------------|------------------| |13201||

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