getPublishStatus
get
/ccadmin/v1/publish
Get Publish Status. Get the status of the current publish operation.
Request
Supported Media Types
- application/json
Query Parameters
-
lastPublished(optional): string
Flag to return the last publish.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPublishStatus_response
Type:
Show Source
object
-
adminInitialDatasource(optional):
string
Admin initial datasource of the publish.
-
currentPhase(optional):
integer
Current phase of publish.
-
errorMessage(optional):
string
Error message if any for the publish.
-
errorPhase(optional):
integer
Error phase in the publish.
-
firstName(optional):
string
First name of the publish initiator.
-
lastCompletedPhase(optional):
integer
Last completed phase of publish.
-
lastName(optional):
string
Last name of the publish initiator.
-
numberOfChanges(optional):
integer
Number of changes in the publish.
-
operationType(optional):
string
Operation type of the publish.
-
publishId(optional):
string
Publish Id for the publish.
-
publishInitiator(optional):
string
Publish initiator for the publish.
-
publishRunning(optional):
boolean
Tells weather Publish is running.
-
statusMessage(optional):
string
Status message of publish.
-
storeInitialDatasource(optional):
string
Store initial datasource of publish.
Example Response (application/json)
{
"errorMessage":"",
"storeInitialDatasource":"catB",
"statusMessage":"",
"publishId":"publish10002",
"publishInitiator":"admin",
"adminInitialDatasource":"catA",
"publishRunning":true,
"currentPhase":500,
"lastCompletedPhase":420,
"eventName":"My publish",
"operationType":"publish",
"numberOfChanges":6,
"errorPhase":0
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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