Jump to

• Request
• Response

getPublishingHistoricals

get

/ccadmin/v1/publishingHistory

Get Publishing History. Get a list of publishing historical items.

Request

Supported Media Types

• application/json

Query Parameters

• limit: integer
  Limit of number of publishing historical items.
• q: string
  Query String used to limit publishing historical items.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPublishingHistoricals_response

Type: object

Show Source

• items: array items
  Items of publishing historical.
• limit: integer
  Limit of number of publishing historical items.
• offset: integer
  Offset.
• sort: array sort
  Sort information of the publishing historical items.
• totalResults: integer
  Total number of publishing historical items.

{
    "properties":{
        "totalResults":{
            "description":"Total number of publishing historical items.",
            "type":"integer"
        },
        "offset":{
            "description":"Offset.",
            "type":"integer"
        },
        "limit":{
            "description":"Limit of number of publishing historical items.",
            "type":"integer"
        },
        "sort":{
            "description":"Sort information of the publishing historical items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"Property of publishing historical say endTime.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order of publishing historical items.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"Items of publishing historical.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "publishInitiator":{
                        "description":"Publish initiator with format as: initiator'ID:initiator's first name,initiator's last name.",
                        "type":"string"
                    },
                    "numberOfHistoricalChanges":{
                        "description":"Number of high level changes",
                        "type":"string"
                    },
                    "eventName":{
                        "description":"Event name of the publish",
                        "type":"string"
                    },
                    "operationType":{
                        "description":"Operation Type of publishing historical: selective_publish or publish.",
                        "type":"string"
                    },
                    "startTime":{
                        "description":"Start time of the publish.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of publishing historical.",
                        "type":"string"
                    },
                    "endTime":{
                        "description":"End time of the publish",
                        "type":"string"
                    },
                    "publishInitiatorProfileType":{
                        "description":"Profile type of the publish initiator",
                        "type":"string"
                    },
                    "worksetId":{
                        "description":"Workset name of the publish",
                        "type":"string"
                    },
                    "authors":{
                        "description":"Array of authors of the publish changes 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 historical.

Show Source

• Array of: object items

{
    "description":"Items of publishing historical.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "publishInitiator":{
                "description":"Publish initiator with format as: initiator'ID:initiator's first name,initiator's last name.",
                "type":"string"
            },
            "numberOfHistoricalChanges":{
                "description":"Number of high level changes",
                "type":"string"
            },
            "eventName":{
                "description":"Event name of the publish",
                "type":"string"
            },
            "operationType":{
                "description":"Operation Type of publishing historical: selective_publish or publish.",
                "type":"string"
            },
            "startTime":{
                "description":"Start time of the publish.",
                "type":"string"
            },
            "id":{
                "description":"ID of publishing historical.",
                "type":"string"
            },
            "endTime":{
                "description":"End time of the publish",
                "type":"string"
            },
            "publishInitiatorProfileType":{
                "description":"Profile type of the publish initiator",
                "type":"string"
            },
            "worksetId":{
                "description":"Workset name of the publish",
                "type":"string"
            },
            "authors":{
                "description":"Array of authors of the publish changes 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 publishing historical items.

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• authors: array authors
  Array of authors of the publish changes with format as: author'ID:author's first name,author's last name.
• endTime: string
  End time of the publish
• eventName: string
  Event name of the publish
• id: string
  ID of publishing historical.
• numberOfHistoricalChanges: string
  Number of high level changes
• operationType: string
  Operation Type of publishing historical: selective_publish or publish.
• publishInitiator: string
  Publish initiator with format as: initiator'ID:initiator's first name,initiator's last name.
• publishInitiatorProfileType: string
  Profile type of the publish initiator
• startTime: string
  Start time of the publish.
• worksetId: string
  Workset name of the publish

{
    "type":"object",
    "properties":{
        "publishInitiator":{
            "description":"Publish initiator with format as: initiator'ID:initiator's first name,initiator's last name.",
            "type":"string"
        },
        "numberOfHistoricalChanges":{
            "description":"Number of high level changes",
            "type":"string"
        },
        "eventName":{
            "description":"Event name of the publish",
            "type":"string"
        },
        "operationType":{
            "description":"Operation Type of publishing historical: selective_publish or publish.",
            "type":"string"
        },
        "startTime":{
            "description":"Start time of the publish.",
            "type":"string"
        },
        "id":{
            "description":"ID of publishing historical.",
            "type":"string"
        },
        "endTime":{
            "description":"End time of the publish",
            "type":"string"
        },
        "publishInitiatorProfileType":{
            "description":"Profile type of the publish initiator",
            "type":"string"
        },
        "worksetId":{
            "description":"Workset name of the publish",
            "type":"string"
        },
        "authors":{
            "description":"Array of authors of the publish changes 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 publish changes with format as: author'ID:author's first name,author's last name.

Show Source

• Array of: string

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

Nested Schema : items

Type: object

Show Source

• order: string
  Order of publishing historical items.
• property: string
  Property of publishing historical say endTime.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"Property of publishing historical say endTime.",
            "type":"string"
        },
        "order":{
            "description":"Order of publishing historical items.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"endTime",
            "order":"desc"
        }
    ],
    "items":[
        {
            "publishInitiator":"admin:User,Admin",
            "worksetName":"default",
            "eventName":"default",
            "numberOfHistoricalChanges":1,
            "startTime":"2022-03-03T19:02:35.000Z",
            "operationType":"selective_publish",
            "id":"publish30002",
            "endTime":"2022-03-03T19:02:45.356Z",
            "publishInitiatorProfileType":"adminUI",
            "authors":[
                "admin:User,Admin"
            ],
            "worksetId":"default"
        }
    ]
}

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

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