Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPublishStatus_response

Type: object

Show Source

• 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.

{
    "properties":{
        "lastName":{
            "description":"Last name of the publish initiator.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Error message if any for the publish.",
            "type":"string"
        },
        "storeInitialDatasource":{
            "description":"Store initial datasource of publish.",
            "type":"string"
        },
        "statusMessage":{
            "description":"Status message of publish.",
            "type":"string"
        },
        "publishId":{
            "description":"Publish Id for the publish.",
            "type":"string"
        },
        "publishInitiator":{
            "description":"Publish initiator for the publish.",
            "type":"string"
        },
        "firstName":{
            "description":"First name of the publish initiator.",
            "type":"string"
        },
        "adminInitialDatasource":{
            "description":"Admin initial datasource of the publish.",
            "type":"string"
        },
        "publishRunning":{
            "description":"Tells weather Publish is running.",
            "type":"boolean"
        },
        "currentPhase":{
            "description":"Current phase of publish.",
            "type":"integer"
        },
        "lastCompletedPhase":{
            "description":"Last completed phase of publish.",
            "type":"integer"
        },
        "operationType":{
            "description":"Operation type of the publish.",
            "type":"string"
        },
        "numberOfChanges":{
            "description":"Number of changes in the publish.",
            "type":"integer"
        },
        "errorPhase":{
            "description":"Error phase in the publish.",
            "type":"integer"
        }
    }
}

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

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