Jump to

• Request
• Response

publishChangeLists

post

/ccadmin/v1/publishingChangeLists/publish

Publish Change Lists. Start or schedule a publish operation.

Request

Supported Media Types

• application/json

Body ()

Root Schema : publishChangeLists_request

Type: object

Show Source

• changeListId: string
  Change list ID to represent the list of change item IDs to use for selective publishing
• dateTime: string
  Timestamp (ISO 8601) to schedule the publish operation. Not valid when operationType is selective_publish
• eventName: string
  An optional name for the selective publishing event
• operationType: string
  Type of publish operation to perform. One of publish or selective_publish
• repeatEndTime: string
  An optional timestamp (ISO 8601) to end the repeated publishing event. Use in conjuction with repeatFrequency. Repeat will occur forever if no end time is provided.
• repeatFrequency: integer
  Optionally enables this publishing event to occur repeatedly. Use one of these frequency codes: 100 (hourly), 101 (daily), 102 (weekly), 103 (monthtly) or 104 (yearly).
• worksetId: string
  Workset ID to represent the workset Id to use for selective publishing. If worksetId is specified, changelistId will be ignored.

{
    "properties":{
        "dateTime":{
            "description":"Timestamp (ISO 8601) to schedule the publish operation. Not valid when operationType is selective_publish",
            "type":"string"
        },
        "repeatFrequency":{
            "description":"Optionally enables this publishing event to occur repeatedly.  Use one of these frequency codes: 100 (hourly), 101 (daily), 102 (weekly), 103 (monthtly) or 104 (yearly).",
            "type":"integer"
        },
        "repeatEndTime":{
            "description":"An optional timestamp (ISO 8601) to end the repeated publishing event.  Use in conjuction with repeatFrequency.  Repeat will occur forever if no end time is provided.",
            "type":"string"
        },
        "eventName":{
            "description":"An optional name for the selective publishing event",
            "type":"string"
        },
        "operationType":{
            "description":"Type of publish operation to perform. One of publish or selective_publish",
            "type":"string"
        },
        "changeListId":{
            "description":"Change list ID to represent the list of change item IDs to use for selective publishing",
            "type":"string"
        },
        "worksetId":{
            "description":"Workset ID to represent the workset Id to use for selective publishing. If worksetId is specified, changelistId will be ignored.",
            "type":"string"
        }
    },
    "example":"POST /ccadmin/v1/publishingChangeLists/publish"
}

Example:

POST /ccadmin/v1/publishingChangeLists/publish

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : publishChangeLists_response

Type: object

Show Source

• publishRunning: boolean
  Tells whether publish is running.
• statusMessage: string
  Status Message of publish.

{
    "properties":{
        "publishRunning":{
            "description":"Tells whether publish is running.",
            "type":"boolean"
        },
        "statusMessage":{
            "description":"Status Message of publish.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "publishRunning":true,
    "statusMessage":"A publish has been successfully initiated."
}

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| |------------------|------------------| |31021|A scheduled publish already exists with the specified date and time: {0}| |31020|The scheduled publish date and time: {0} is invalid.| |31022|An internal error occurred while scheduling a publishing operation.| |31033|Invalid input error.| |31030|Could not start publish operation. Another publish operation is currently in progress.| |31047|full_publish is not a valid operationType. Use publish or selective_publish.|

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