Jump to

• Request
• Response

getPublishChanges

get

/ccadmin/v1/publish/changes

Get Publish Changes. Get a list of publishing change items. Optionally takes the x-ccasset-language header to get translated content in another language. Deprecated.

Request

Supported Media Types

• application/json

Query Parameters

• filterString(optional): string
  String used to filter the returned change items.

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPublishChanges_response

Type: object

Show Source

• items(optional): array items
  Items of publish changes.
• limit(optional): integer
  Limit of number of changes.
• offset(optional): integer
  Offset.
• sort(optional): array sort
  Sort information of the publishing changes.
• total(optional): integer
  Total number of changes published. Deprecated.
• totalResults(optional): integer
  Total number of changes published.

{
    "properties":{
        "total":{
            "description":"Total number of changes published. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total number of changes published.",
            "type":"integer"
        },
        "offset":{
            "description":"Offset.",
            "type":"integer"
        },
        "limit":{
            "description":"Limit of number of changes.",
            "type":"integer"
        },
        "sort":{
            "description":"Sort information of the publishing changes.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"Property of changes say display name.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order of publishing changes.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"Items of publish changes.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"Last Name the of Author of publishing changes.",
                        "type":"string"
                    },
                    "itemType":{
                        "description":"Item type of publishing changes.",
                        "type":"string"
                    },
                    "author":{
                        "description":"Author of publishing changes.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display name of publishing chnages.",
                        "type":"string"
                    },
                    "changeType":{
                        "description":"Change type of publishing changes. 0: UPDATE, 1: DELETE, 2: CREATE.",
                        "type":"integer"
                    },
                    "assetType":{
                        "description":"Asset type of publishing changes.",
                        "type":"string"
                    },
                    "assetTypeDisplayName":{
                        "description":"Asset type display name of publishing changes.",
                        "type":"string"
                    },
                    "changeTime":{
                        "description":"Changing time of publishing changes.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"First Name of the Author of publishing changes.",
                        "type":"string"
                    },
                    "componentPath":{
                        "description":"Component path of publishing changes.",
                        "type":"string"
                    },
                    "assetId":{
                        "description":"Asset Id of publishing changes.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository Id of publishing changes.",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of publishing changes.",
                        "type":"string"
                    },
                    "parentAssetType":{
                        "description":"Parent asset type of publishing changes.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Items of publish changes.

Show Source

• Array of: object items

{
    "description":"Items of publish changes.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "lastName":{
                "description":"Last Name the of Author of publishing changes.",
                "type":"string"
            },
            "itemType":{
                "description":"Item type of publishing changes.",
                "type":"string"
            },
            "author":{
                "description":"Author of publishing changes.",
                "type":"string"
            },
            "displayName":{
                "description":"Display name of publishing chnages.",
                "type":"string"
            },
            "changeType":{
                "description":"Change type of publishing changes. 0: UPDATE, 1: DELETE, 2: CREATE.",
                "type":"integer"
            },
            "assetType":{
                "description":"Asset type of publishing changes.",
                "type":"string"
            },
            "assetTypeDisplayName":{
                "description":"Asset type display name of publishing changes.",
                "type":"string"
            },
            "changeTime":{
                "description":"Changing time of publishing changes.",
                "type":"string"
            },
            "firstName":{
                "description":"First Name of the Author of publishing changes.",
                "type":"string"
            },
            "componentPath":{
                "description":"Component path of publishing changes.",
                "type":"string"
            },
            "assetId":{
                "description":"Asset Id of publishing changes.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository Id of publishing changes.",
                "type":"string"
            },
            "id":{
                "description":"Id of publishing changes.",
                "type":"string"
            },
            "parentAssetType":{
                "description":"Parent asset type of publishing changes.",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sort information of the publishing changes.

Show Source

• Array of: object items

{
    "description":"Sort information of the publishing changes.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"Property of changes say display name.",
                "type":"string"
            },
            "order":{
                "description":"Order of publishing changes.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assetId(optional): string
  Asset Id of publishing changes.
• assetType(optional): string
  Asset type of publishing changes.
• assetTypeDisplayName(optional): string
  Asset type display name of publishing changes.
• author(optional): string
  Author of publishing changes.
• changeTime(optional): string
  Changing time of publishing changes.
• changeType(optional): integer
  Change type of publishing changes. 0: UPDATE, 1: DELETE, 2: CREATE.
• componentPath(optional): string
  Component path of publishing changes.
• displayName(optional): string
  Display name of publishing chnages.
• firstName(optional): string
  First Name of the Author of publishing changes.
• id(optional): string
  Id of publishing changes.
• itemType(optional): string
  Item type of publishing changes.
• lastName(optional): string
  Last Name the of Author of publishing changes.
• parentAssetType(optional): string
  Parent asset type of publishing changes.
• repositoryId(optional): string
  Repository Id of publishing changes.

{
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last Name the of Author of publishing changes.",
            "type":"string"
        },
        "itemType":{
            "description":"Item type of publishing changes.",
            "type":"string"
        },
        "author":{
            "description":"Author of publishing changes.",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of publishing chnages.",
            "type":"string"
        },
        "changeType":{
            "description":"Change type of publishing changes. 0: UPDATE, 1: DELETE, 2: CREATE.",
            "type":"integer"
        },
        "assetType":{
            "description":"Asset type of publishing changes.",
            "type":"string"
        },
        "assetTypeDisplayName":{
            "description":"Asset type display name of publishing changes.",
            "type":"string"
        },
        "changeTime":{
            "description":"Changing time of publishing changes.",
            "type":"string"
        },
        "firstName":{
            "description":"First Name of the Author of publishing changes.",
            "type":"string"
        },
        "componentPath":{
            "description":"Component path of publishing changes.",
            "type":"string"
        },
        "assetId":{
            "description":"Asset Id of publishing changes.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository Id of publishing changes.",
            "type":"string"
        },
        "id":{
            "description":"Id of publishing changes.",
            "type":"string"
        },
        "parentAssetType":{
            "description":"Parent asset type of publishing changes.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  Order of publishing changes.
• property(optional): string
  Property of changes say display name.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"Property of changes say display name.",
            "type":"string"
        },
        "order":{
            "description":"Order of publishing changes.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"Amber",
            "itemType":"repository",
            "author":"admin",
            "displayName":"Men",
            "changeType":0,
            "assetType":"category",
            "assetTypeDisplayName":"Collection",
            "changeTime":"2014-03-10T13:06:06.075Z",
            "firstName":"Admin",
            "componentPath":"/atg/commerce/catalog/ProductCatalog",
            "assetId":"catMen",
            "repositoryId":"change30449",
            "id":"change30449",
            "parentAssetType":""
        }
    ]
}

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| |------------------|------------------| |50011|{0} is a restricted property to use for sorting| |50012|{0} is an invalid sort property for this operation| |10002|Invalid value [ {1} ] for parameter: {0}.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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