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: 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:
string
Admin initial datasource of the publish.
-
currentPhase:
integer
Current phase of publish.
-
errorMessage:
string
Error message if any for the publish.
-
errorPhase:
integer
Error phase in the publish.
-
firstName:
string
First name of the publish initiator.
-
lastCompletedPhase:
integer
Last completed phase of publish.
-
lastName:
string
Last name of the publish initiator.
-
numberOfChanges:
integer
Number of changes in the publish.
-
operationType:
string
Operation type of the publish.
-
publishId:
string
Publish Id for the publish.
-
publishInitiator:
string
Publish initiator for the publish.
-
publishRunning:
boolean
Tells weather Publish is running.
-
statusMessage:
string
Status message of publish.
-
storeInitialDatasource:
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:
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
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:
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