PublishStatusInfo

PublishStatusInfo
Publish Status Info

Generic publish status information that can be used across different publishable entities (environments, applications, groups, etc...). Contains the current publish status, action being performed, and optional error/progress information.

JSON Example
{
    "publish_status": "READY_TO_PUBLISH",
    "overall_publish_status": "READY_TO_PUBLISH"
}
publish_status
Read-Only  

Status of a publish operation for a proposed object.

  • READY_TO_PUBLISH: Object is ready to be published
  • IN_PROGRESS: Publication is currently in progress
  • PUBLISH_SUCCESS: Publication completed successfully
  • PUBLISH_FAILED: Publication failed with errors
  • PUBLISH_CANCELED: Publication was canceled by user
Enumeration: READY_TO_PUBLISH, IN_PROGRESS, PUBLISH_SUCCESS, PUBLISH_FAILED, PUBLISH_CANCELED
string
error_message
Read-Only  

Error message if publication failed

overall_publish_status
Read-Only  

Status of a publish operation for a proposed object.

  • READY_TO_PUBLISH: Object is ready to be published
  • IN_PROGRESS: Publication is currently in progress
  • PUBLISH_SUCCESS: Publication completed successfully
  • PUBLISH_FAILED: Publication failed with errors
  • PUBLISH_CANCELED: Publication was canceled by user
Enumeration: READY_TO_PUBLISH, IN_PROGRESS, PUBLISH_SUCCESS, PUBLISH_FAILED, PUBLISH_CANCELED