REST API for Oracle Commerce Cloud

getAllPublishingChangeApplications

get

/ccadmin/v1/publishingChangeApplications

Get All Publishing Change Applications. Get all applications who made publishing changes

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getAllPublishingChangeApplications_response

Type: object

Show Source

items: array items

Items of applications.
totalResults: integer

Total number of applications.

{
    "properties":{
        "totalResults":{
            "description":"Total number of applications.",
            "type":"integer"
        },
        "items":{
            "description":"Items of applications.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "context":{
                        "description":"The application context",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name of the application",
                        "type":"string"
                    },
                    "id":{
                        "description":"The ID of the application",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Items of applications.

Show Source

Array of: object items

{
    "description":"Items of applications.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "context":{
                "description":"The application context",
                "type":"string"
            },
            "name":{
                "description":"The name of the application",
                "type":"string"
            },
            "id":{
                "description":"The ID of the application",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

context: string

The application context
id: string

The ID of the application
name: string

The name of the application

{
    "type":"object",
    "properties":{
        "context":{
            "description":"The application context",
            "type":"string"
        },
        "name":{
            "description":"The name of the application",
            "type":"string"
        },
        "id":{
            "description":"The ID of the application",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "totalResults":2,
    "items":[
        {
            "context":"designStudioApplicationItem:b2c-reference-store",
            "name":"Oracle CX Commerce B2C Reference Storefront Application",
            "id":"b2c-reference-store"
        },
        {
            "context":"designStudioApplicationItem:blank-store",
            "name":"Oracle Cloud Commerce Storefront Template Application",
            "id":"blank-store"
        }
    ]
}

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| |------------------|------------------| |31202|Internal Error|

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