DeploymentDashboardApi

getAllDashboards

Get all deployment dashboards.


Endpoint	/app/rest/deploymentDashboards
Produces	`application/xml` `application/json`
Parameters	`locator: string<DeploymentDashboardLocator>` `fields: string`
Response	`DeploymentDashboards`

Create a new deployment dashboard.


Endpoint	/app/rest/deploymentDashboards
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: DeploymentDashboard`
Response	`DeploymentDashboard`

Delete the deployment dashboard matching the locator.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>`

Get the deployment dashboard matching the locator.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}
Produces	`application/xml` `application/json`
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>` `fields: string`
Response	`DeploymentDashboard`

Get deployment instances for a given deployment dashboard.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances
Produces	`application/xml` `application/json`
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>` `locator: string<DeploymentInstanceLocator>` `fields: string`
Response	`DeploymentInstances`

Create a new deployment instance.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>` `body: DeploymentInstance`
Response	`DeploymentInstance`

Delete the deployment instance matching the locator.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>` `deploymentInstanceLocator: string<DeploymentInstanceLocator>`

Get the deployment instance matching the locator.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}
Produces	`application/xml` `application/json`
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>` `deploymentInstanceLocator: string<DeploymentInstanceLocator>` `fields: string`
Response	`DeploymentInstance`

Report a new deployment for instance.


Endpoint	/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`deploymentDashboardLocator: string<DeploymentDashboardLocator>` `deploymentInstanceLocator: string<DeploymentInstanceLocator>` `body: DeploymentStateEntry`
Response	`DeploymentInstance`

Last modified: 04 July 2024