Jump to

• Request
• Response

doGetPromoteStatus

get

/ccadmin/v1/serverExtensions/promoteStatus

Get promote status for last successfully initiated promote operation.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : doGetPromoteStatus_response

Type: object

Show Source

• extensions: array extensions
  An array of provided SSE files name which was to be promoted from preview to live environment.
• failedExtensions: array failedExtensions
  An array of SSE files name which failed to get promoted from preview to live environment.
• lastSuccessfulPhase: string
  The last successful promote phase. It can be either none, pre-promote, promote or post-promote.
• links: array links
  List of navigation links.
• promotePhaseRolledBack: boolean
  Whether promote phase is successfully rolled back on a failure or not. This property should be considered only if 'lastSuccessfulPhase' is not 'none' and 'success' is 'false'.
• state: string
  Current state of last successfully initiated promote operation. It can be either in-progress or completed.
• success: boolean
  Whether the extension files are promoted successfully from preview to live environment or not.
• workRequestId: string
  The tracking id which can be used to track status of extension server restart which happens as part of promote operation via CSM. It will be null (not present) if restart via CSM is disabled.

{
    "properties":{
        "extensions":{
            "description":"An array of provided SSE files name which was to be promoted from preview to live environment.",
            "type":"array",
            "items":{
                "description":"File name",
                "type":"string"
            }
        },
        "lastSuccessfulPhase":{
            "description":"The last successful promote phase. It can be either none, pre-promote, promote or post-promote.",
            "type":"string"
        },
        "failedExtensions":{
            "description":"An array of SSE files name which failed to get promoted from preview to live environment.",
            "type":"array",
            "items":{
                "description":"File name",
                "type":"string"
            }
        },
        "success":{
            "description":"Whether the extension files are promoted successfully from preview to live environment or not.",
            "type":"boolean"
        },
        "links":{
            "description":"List of navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The link's relation to the current page of results: next, prev or self.",
                        "type":"string"
                    },
                    "href":{
                        "description":"The URL of the link.",
                        "type":"string"
                    }
                }
            }
        },
        "state":{
            "description":"Current state of last successfully initiated promote operation. It can be either in-progress or completed.",
            "type":"string"
        },
        "workRequestId":{
            "description":"The tracking id which can be used to track status of extension server restart which happens as part of promote operation via CSM. It will be null (not present) if restart via CSM is disabled.",
            "type":"string"
        },
        "promotePhaseRolledBack":{
            "description":"Whether promote phase is successfully rolled back on a failure or not. This property should be considered only if 'lastSuccessfulPhase' is not 'none' and 'success' is 'false'.",
            "type":"boolean"
        }
    },
    "example":{
        "extensions":[
            "itunes.zip",
            "helloWorld.zip",
            "httplib.zip"
        ],
        "lastSuccessfulPhase":"post-promote",
        "failedExtensions":[
        ],
        "success":true,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadminui/v1/serverExtensions/promoteStatus"
            }
        ],
        "state":"completed",
        "isPromotePhaseRolledBack":false,
        "workRequestId":"mblNhrQ2D2"
    }
}

Example:

{
    "extensions":[
        "itunes.zip",
        "helloWorld.zip",
        "httplib.zip"
    ],
    "lastSuccessfulPhase":"post-promote",
    "failedExtensions":[
    ],
    "success":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/serverExtensions/promoteStatus"
        }
    ],
    "state":"completed",
    "isPromotePhaseRolledBack":false,
    "workRequestId":"mblNhrQ2D2"
}

Nested Schema : extensions

Type: array

An array of provided SSE files name which was to be promoted from preview to live environment.

Show Source

• Array of: string
  File name

{
    "description":"An array of provided SSE files name which was to be promoted from preview to live environment.",
    "type":"array",
    "items":{
        "description":"File name",
        "type":"string"
    }
}

Nested Schema : failedExtensions

Type: array

An array of SSE files name which failed to get promoted from preview to live environment.

Show Source

• Array of: string
  File name

{
    "description":"An array of SSE files name which failed to get promoted from preview to live environment.",
    "type":"array",
    "items":{
        "description":"File name",
        "type":"string"
    }
}

Nested Schema : links

Type: array

List of navigation links.

Show Source

• Array of: object items

{
    "description":"List of navigation links.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"The link's relation to the current page of results: next, prev or self.",
                "type":"string"
            },
            "href":{
                "description":"The URL of the link.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href: string
  The URL of the link.
• rel: string
  The link's relation to the current page of results: next, prev or self.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The link's relation to the current page of results: next, prev or self.",
            "type":"string"
        },
        "href":{
            "description":"The URL of the link.",
            "type":"string"
        }
    }
}

Default Response

The error response.

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