Jump to

• Request
• Response

getPublishingHistoricalChanges

get

/ccadmin/v1/publishingHistory/{id}/changes

Get Publishing Historical Changes. Get a list of high level publishing change items.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the publishing historical to retrieve.

Query Parameters

• limit(optional): integer
  Limit of number of change items.
• q(optional): string
  Query String used to limit change items.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPublishingHistoricalChanges_response

Type: object

Show Source

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

{
    "properties":{
        "totalResults":{
            "description":"Total number of change items.",
            "type":"integer"
        },
        "offset":{
            "description":"Offset.",
            "type":"integer"
        },
        "limit":{
            "description":"Limit of number of change items.",
            "type":"integer"
        },
        "sort":{
            "description":"Sort information of the change items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"Property of the change items say display name.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order of change items.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"Items of publishing changes.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"Last Name the of the last author of the publishing change.",
                        "type":"string"
                    },
                    "authorProfileType":{
                        "description":"The profile type of the author",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display name of the publishing change.",
                        "type":"string"
                    },
                    "author":{
                        "description":"Last author ID of publishing change.",
                        "type":"string"
                    },
                    "changeType":{
                        "description":"Change type of the publishing change. 0: UPDATE, 1: DELETE, 2: CREATE.",
                        "type":"integer"
                    },
                    "subsystem":{
                        "description":"The subsystem involved in the change",
                        "type":"string"
                    },
                    "assetType":{
                        "description":"Asset type of the publishing change.",
                        "type":"string"
                    },
                    "changeDetails":{
                        "description":"Change Details.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "changeTime":{
                                    "description":"Changing time of the publishing change.",
                                    "type":"string"
                                },
                                "author":{
                                    "description":"Author ID of the publishing change.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "changeTime":{
                        "description":"Changing time of the publishing change.",
                        "type":"string"
                    },
                    "assetTypeDisplayName":{
                        "description":"Asset type display name of the publishing change.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"First Name of the last author of the publishing change.",
                        "type":"string"
                    },
                    "assetId":{
                        "description":"Asset Id of the publishing change.",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of the publishing change.",
                        "type":"string"
                    },
                    "authors":{
                        "description":"Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Items of publishing changes.

Show Source

• Array of: object items

{
    "description":"Items of publishing changes.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "lastName":{
                "description":"Last Name the of the last author of the publishing change.",
                "type":"string"
            },
            "authorProfileType":{
                "description":"The profile type of the author",
                "type":"string"
            },
            "displayName":{
                "description":"Display name of the publishing change.",
                "type":"string"
            },
            "author":{
                "description":"Last author ID of publishing change.",
                "type":"string"
            },
            "changeType":{
                "description":"Change type of the publishing change. 0: UPDATE, 1: DELETE, 2: CREATE.",
                "type":"integer"
            },
            "subsystem":{
                "description":"The subsystem involved in the change",
                "type":"string"
            },
            "assetType":{
                "description":"Asset type of the publishing change.",
                "type":"string"
            },
            "changeDetails":{
                "description":"Change Details.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "changeTime":{
                            "description":"Changing time of the publishing change.",
                            "type":"string"
                        },
                        "author":{
                            "description":"Author ID of the publishing change.",
                            "type":"string"
                        }
                    }
                }
            },
            "changeTime":{
                "description":"Changing time of the publishing change.",
                "type":"string"
            },
            "assetTypeDisplayName":{
                "description":"Asset type display name of the publishing change.",
                "type":"string"
            },
            "firstName":{
                "description":"First Name of the last author of the publishing change.",
                "type":"string"
            },
            "assetId":{
                "description":"Asset Id of the publishing change.",
                "type":"string"
            },
            "id":{
                "description":"Id of the publishing change.",
                "type":"string"
            },
            "authors":{
                "description":"Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : sort

Type: array

Sort information of the change items.

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• assetId(optional): string
  Asset Id of the publishing change.
• assetType(optional): string
  Asset type of the publishing change.
• assetTypeDisplayName(optional): string
  Asset type display name of the publishing change.
• author(optional): string
  Last author ID of publishing change.
• authorProfileType(optional): string
  The profile type of the author
• authors(optional): array authors
  Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.
• changeDetails(optional): array changeDetails
  Change Details.
• changeTime(optional): string
  Changing time of the publishing change.
• changeType(optional): integer
  Change type of the publishing change. 0: UPDATE, 1: DELETE, 2: CREATE.
• displayName(optional): string
  Display name of the publishing change.
• firstName(optional): string
  First Name of the last author of the publishing change.
• id(optional): string
  Id of the publishing change.
• lastName(optional): string
  Last Name the of the last author of the publishing change.
• subsystem(optional): string
  The subsystem involved in the change

{
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last Name the of the last author of the publishing change.",
            "type":"string"
        },
        "authorProfileType":{
            "description":"The profile type of the author",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the publishing change.",
            "type":"string"
        },
        "author":{
            "description":"Last author ID of publishing change.",
            "type":"string"
        },
        "changeType":{
            "description":"Change type of the publishing change. 0: UPDATE, 1: DELETE, 2: CREATE.",
            "type":"integer"
        },
        "subsystem":{
            "description":"The subsystem involved in the change",
            "type":"string"
        },
        "assetType":{
            "description":"Asset type of the publishing change.",
            "type":"string"
        },
        "changeDetails":{
            "description":"Change Details.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "changeTime":{
                        "description":"Changing time of the publishing change.",
                        "type":"string"
                    },
                    "author":{
                        "description":"Author ID of the publishing change.",
                        "type":"string"
                    }
                }
            }
        },
        "changeTime":{
            "description":"Changing time of the publishing change.",
            "type":"string"
        },
        "assetTypeDisplayName":{
            "description":"Asset type display name of the publishing change.",
            "type":"string"
        },
        "firstName":{
            "description":"First Name of the last author of the publishing change.",
            "type":"string"
        },
        "assetId":{
            "description":"Asset Id of the publishing change.",
            "type":"string"
        },
        "id":{
            "description":"Id of the publishing change.",
            "type":"string"
        },
        "authors":{
            "description":"Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : authors

Type: array

Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.

Show Source

• Array of: string

{
    "description":"Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : changeDetails

Type: array

Change Details.

Show Source

• Array of: object items

{
    "description":"Change Details.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "changeTime":{
                "description":"Changing time of the publishing change.",
                "type":"string"
            },
            "author":{
                "description":"Author ID of the publishing change.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• author(optional): string
  Author ID of the publishing change.
• changeTime(optional): string
  Changing time of the publishing change.

{
    "type":"object",
    "properties":{
        "changeTime":{
            "description":"Changing time of the publishing change.",
            "type":"string"
        },
        "author":{
            "description":"Author ID of the publishing change.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  Order of change items.
• property(optional): string
  Property of the change items say display name.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"Property of the change items say display name.",
            "type":"string"
        },
        "order":{
            "description":"Order of change items.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"User",
            "authorProfileType":"adminUI",
            "displayName":"The Girl with the Dragon Tattoo",
            "author":"admin",
            "changeType":0,
            "subsystem":"OCCS-Admin",
            "assetType":"product",
            "changeDetails":[
                {
                    "changeTime":"2022-03-03T19:01:32.000Z",
                    "author":"admin"
                },
                {
                    "changeTime":"2022-03-03T19:01:39.000Z",
                    "author":"admin"
                },
                {
                    "changeTime":"2022-03-03T19:01:44.000Z",
                    "author":"admin"
                }
            ],
            "changeTime":"2022-03-03T19:01:44.000Z",
            "assetTypeDisplayName":"Product: Base Product",
            "firstName":"Admin",
            "assetId":"Product_36Exy",
            "id":"change30004",
            "authors":[
                "admin:User,Admin"
            ]
        }
    ]
}

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| |------------------|------------------| |31402|Internal Error| |31410|No publishing historical found with id: {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