REST API for Oracle Commerce Cloud December 2017

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: Type: string

Flag to return the last publish.
reset: Type: string

Reset the publish operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPublishStatus_response

Properties

adminInitialDatasource: Type: string

Admin initial datasource of the publish.
currentPhase: Type: integer

Current phase of publish.
errorMessage: Type: string

Error message if any for the publish.
errorPhase: Type: integer

Error phase in the publish.
firstName: Type: string

First name of the publish initiator.
lastCompletedPhase: Type: integer

Last completed phase of publish.
lastName: Type: string

Last name of the publish initiator.
numberOfChanges: Type: integer

Number of changes in the publish.
operationType: Type: string

Operation type of the publish.
publishId: Type: string

Publish Id for the publish.
publishInitiator: Type: string

Publish initiator for the publish.
publishRunning: Type: boolean

Tells weather Publish is running.
statusMessage: Type: string

Status message of publish.
storeInitialDatasource: Type: string

Store initial datasource of publish.

Example application/json


{
    "publishInitiator":"admin",
    "adminInitialDatasource":"catA",
    "publishRunning":true,
    "currentPhase":500,
    "errorMessage":"",
    "lastCompletedPhase":420,
    "operationType":"publish",
    "numberOfChanges":6,
    "storeInitialDatasource":"catB",
    "errorPhase":0,
    "statusMessage":"",
    "publishId":"publish10002"
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "publishInitiator": "admin",
  "adminInitialDatasource": "catA",
  "publishRunning": true,
  "currentPhase": 500,
  "errorMessage": "",
  "lastCompletedPhase": 420,
  "operationType": "publish",
  "numberOfChanges": 6,
  "storeInitialDatasource": "catB",
  "errorPhase": 0,
  "statusMessage": "",
  "publishId": "publish10002"
}