Jump to

• Request
• Response

listApplicationDeployments

get

/ccadmin/v1/applicationDeployment

Get Application Deployments. Returns any Application Deployments matching an appName

Request

Supported Media Types

• application/json

Query Parameters

• appName(required): string
  The application name to retrieve deployments for.
• deploymentStatus: string
  This is used to list successful and unsuccessful deployments, as well as 'all' deployments by default. A 'successful deployment' refers to a scenario where the deployment is completed successfully at the preview controller and asset validation.

  Default Value: all
• version: string
  Used to list deployments that match the specified application version.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listApplicationDeployments_response

Type: object

Show Source

• items: array items
  list of application deployments

{
    "properties":{
        "items":{
            "description":"list of application deployments",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessages":{
                        "description":"error messages for application deployment",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "warningMessages":{
                        "description":"warning messages for application deployment",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "metadata":{
                        "description":"application deployment metadata.",
                        "type":"string"
                    },
                    "creationTime":{
                        "description":"time application deployment was created in ISO 8601 format",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"repository ID for application deployment",
                        "type":"string"
                    },
                    "infoMessages":{
                        "description":"information messages for application deployment",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "state":{
                        "description":"state of application deployment - accepted or rejected",
                        "type":"string"
                    },
                    "clusterId":{
                        "description":"cluster ID for application deployment",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID for application deployment",
                        "type":"string"
                    },
                    "applicationId":{
                        "description":"application ID for application deployment",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of application deployments

Show Source

• Array of: object items

{
    "description":"list of application deployments",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessages":{
                "description":"error messages for application deployment",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "warningMessages":{
                "description":"warning messages for application deployment",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "metadata":{
                "description":"application deployment metadata.",
                "type":"string"
            },
            "creationTime":{
                "description":"time application deployment was created in ISO 8601 format",
                "type":"string"
            },
            "repositoryId":{
                "description":"repository ID for application deployment",
                "type":"string"
            },
            "infoMessages":{
                "description":"information messages for application deployment",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "state":{
                "description":"state of application deployment - accepted or rejected",
                "type":"string"
            },
            "clusterId":{
                "description":"cluster ID for application deployment",
                "type":"string"
            },
            "id":{
                "description":"ID for application deployment",
                "type":"string"
            },
            "applicationId":{
                "description":"application ID for application deployment",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• applicationId: string
  application ID for application deployment
• clusterId: string
  cluster ID for application deployment
• creationTime: string
  time application deployment was created in ISO 8601 format
• errorMessages: array errorMessages
  error messages for application deployment
• id: string
  ID for application deployment
• infoMessages: array infoMessages
  information messages for application deployment
• metadata: string
  application deployment metadata.
• repositoryId: string
  repository ID for application deployment
• state: string
  state of application deployment - accepted or rejected
• warningMessages: array warningMessages
  warning messages for application deployment

{
    "type":"object",
    "properties":{
        "errorMessages":{
            "description":"error messages for application deployment",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "warningMessages":{
            "description":"warning messages for application deployment",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "metadata":{
            "description":"application deployment metadata.",
            "type":"string"
        },
        "creationTime":{
            "description":"time application deployment was created in ISO 8601 format",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository ID for application deployment",
            "type":"string"
        },
        "infoMessages":{
            "description":"information messages for application deployment",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "state":{
            "description":"state of application deployment - accepted or rejected",
            "type":"string"
        },
        "clusterId":{
            "description":"cluster ID for application deployment",
            "type":"string"
        },
        "id":{
            "description":"ID for application deployment",
            "type":"string"
        },
        "applicationId":{
            "description":"application ID for application deployment",
            "type":"string"
        }
    }
}

Nested Schema : errorMessages

Type: array

error messages for application deployment

Show Source

• Array of: string

{
    "description":"error messages for application deployment",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : infoMessages

Type: array

information messages for application deployment

Show Source

• Array of: string

{
    "description":"information messages for application deployment",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : warningMessages

Type: array

warning messages for application deployment

Show Source

• Array of: string

{
    "description":"warning messages for application deployment",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

[
    {
        "errorMessages":[
        ],
        "warningMessages":[
        ],
        "metadata":"{\"appName\":\"core-commerce-reference-store\",\"appDir\":\"packages/apps/core-commerce-reference-store\",\"tags\":[]}",
        "repositoryId":"5600001",
        "infoMessages":[
        ],
        "state":"ACCEPTED",
        "clusterId":"storefront",
        "id":"5600001",
        "applicationId":"core-commerce-reference-store",
        "creationDate":"2021-09-21T11:01:39.296Z"
    }
]

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