UI Cloud Platform Deployment Management Service v2.0.0

This schema defines the REST API for the Deployment Management Database, which stores deployment objects according to their defined Deployment Types.

Contact: Cloud Operations

Operations

Tag: deployments

get-deployments

Operation Id: get-deployments

Action: GET /deployments

Summary: Retrieve list of existing deployments

Parameters

Name	In	Type	Required	Description
byType	query	array[string]	false	Filter deployments by deployment type identifier
expand	query	array[string]	false	Expand (fill) specific fields for a deployment object which are not returned by default
includeDeleted	query	boolean	false	Also include deleted deployments in the list of returned deployments
dontResolveReferences	query	boolean	false	Don't resolve parameter value references into their respective values

Enumerated Values

Parameter	Value
expand	all
expand	provisioningStateHistory
expand	outputs

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeploymentList
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/deployments HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/deployments \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/deployments', headers = headers)

print(r.json())

create-deployment

Operation Id: create-deployment

Action: POST /deployments

Summary: Create a new deployment

Body parameter

{
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "container": {
    "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
  },
  "type": "workspace",
  "provisioningState": "Accepted",
  "data": {
    "dependencies": [
      {
        "type": "environment.v1",
        "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
      }
    ],
    "parameters": {},
    "outputs": [
      {
        "id": "string",
        "sensitive": false,
        "value": null
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Deployment	true	none

Responses

Status	Meaning	Description	Schema
201	Created	Created	DeploymentRef
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
409	Conflict	Conflict	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

POST http://localhost:3000/deployments HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST http://localhost:3000/deployments \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:3000/deployments', headers = headers)

print(r.json())

get-deployment

Operation Id: get-deployment

Action: GET /deployments/{id}

Summary: Retrieve existing deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
expand	query	array[string]	false	Expand (fill) specific fields for a deployment object which are not returned by default
dontResolveReferences	query	boolean	false	Don't resolve parameter value references into their respective values

Enumerated Values

Parameter	Value
expand	all
expand	provisioningStateHistory
expand	outputs

Responses

Status	Meaning	Description	Schema
200	OK	OK	Deployment
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/deployments/{id} HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/deployments/{id} \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/deployments/{id}', headers = headers)

print(r.json())

create-child

Operation Id: create-child

Action: POST /deployments/{id}

Summary: Create a new child deployment

Description: Create a new (child) deployment inside a container. If the target deployment is not a container a HTTP 400 Bad Request will be returned.

Body parameter

{
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "container": {
    "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
  },
  "type": "workspace",
  "provisioningState": "Accepted",
  "data": {
    "dependencies": [
      {
        "type": "environment.v1",
        "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
      }
    ],
    "parameters": {},
    "outputs": [
      {
        "id": "string",
        "sensitive": false,
        "value": null
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
body	body	Deployment	true	none

Responses

Status	Meaning	Description	Schema
201	Created	Created	DeploymentRef
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
409	Conflict	Conflict	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

POST http://localhost:3000/deployments/{id} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST http://localhost:3000/deployments/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:3000/deployments/{id}', headers = headers)

print(r.json())

update-deployment

Operation Id: update-deployment

Action: PATCH /deployments/{id}

Summary: Update deployment

Body parameter

{
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "container": {
    "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
  },
  "type": "workspace",
  "provisioningState": "Accepted",
  "data": {
    "dependencies": [
      {
        "type": "environment.v1",
        "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
      }
    ],
    "parameters": {},
    "outputs": [
      {
        "id": "string",
        "sensitive": false,
        "value": null
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
body	body	Deployment	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Deployment
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

PATCH http://localhost:3000/deployments/{id} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PATCH http://localhost:3000/deployments/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:3000/deployments/{id}', headers = headers)

print(r.json())

delete-deployment

Operation Id: delete-deployment

Action: DELETE /deployments/{id}

Summary: Delete deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

DELETE http://localhost:3000/deployments/{id} HTTP/1.1
Host: localhost:3000
Accept: application/problem+json

# You can also use wget
curl -X DELETE http://localhost:3000/deployments/{id} \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Accept': 'application/problem+json'
}

r = requests.delete('http://localhost:3000/deployments/{id}', headers = headers)

print(r.json())

list-deployment-contents

Operation Id: list-deployment-contents

Action: GET /deployments/{id}/contents

Summary: Get the contents of a deployment container

Description: The method will return the contents (children) of a deployment which is of type container. If the deployment is not a container a HTTP 400 Bad Request will be returned.

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
byType	query	array[string]	false	Filter deployments by deployment type identifier
expand	query	array[string]	false	Expand (fill) specific fields for a deployment object which are not returned by default
includeDeleted	query	boolean	false	Also include deleted deployments in the list of returned deployments
dontResolveReferences	query	boolean	false	Don't resolve parameter value references into their respective values

Enumerated Values

Parameter	Value
expand	all
expand	provisioningStateHistory
expand	outputs

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeploymentList
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/deployments/{id}/contents HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/deployments/{id}/contents \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/deployments/{id}/contents', headers = headers)

print(r.json())

get-deployment-provisioning-state

Operation Id: get-deployment-provisioning-state

Action: GET /deployments/{id}/provisioning-state

Summary: Get the provisioning state of a deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeploymentProvisioningState
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/deployments/{id}/provisioning-state HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/deployments/{id}/provisioning-state \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/deployments/{id}/provisioning-state', headers = headers)

print(r.json())

update-deployment-provisioning-state

Operation Id: update-deployment-provisioning-state

Action: PATCH /deployments/{id}/provisioning-state

Summary: Update the provisioning state of a deployment

Body parameter

"Accepted"

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
body	body	ProvisioningState	true	none

Enumerated Values

Parameter	Value
body	Accepted
body	Canceled
body	Created
body	Creating
body	Deleted
body	Deleting
body	Failed
body	NotSpecified
body	Ready
body	Running
body	Succeeded
body	Updating

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

PATCH http://localhost:3000/deployments/{id}/provisioning-state HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/problem+json

# You can also use wget
curl -X PATCH http://localhost:3000/deployments/{id}/provisioning-state \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/problem+json'
}

r = requests.patch('http://localhost:3000/deployments/{id}/provisioning-state', headers = headers)

print(r.json())

list-deployment-outputs

Operation Id: list-deployment-outputs

Action: GET /deployments/{id}/outputs

Summary: Get the outputs of a deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeploymentOutputList
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/deployments/{id}/outputs HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/deployments/{id}/outputs \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/deployments/{id}/outputs', headers = headers)

print(r.json())

set-deployment-outputs

Operation Id: set-deployment-outputs

Action: POST /deployments/{id}/outputs

Summary: Set the outputs of a deployment

Body parameter

[
  {
    "id": "string",
    "sensitive": false,
    "value": null
  }
]

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
body	body	DeploymentOutputList	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

POST http://localhost:3000/deployments/{id}/outputs HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/problem+json

# You can also use wget
curl -X POST http://localhost:3000/deployments/{id}/outputs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/problem+json'
}

r = requests.post('http://localhost:3000/deployments/{id}/outputs', headers = headers)

print(r.json())

update-deployment-outputs

Operation Id: update-deployment-outputs

Action: PATCH /deployments/{id}/outputs

Summary: Update the outputs of a deployment

Body parameter

[
  {
    "id": "string",
    "sensitive": false,
    "value": null
  }
]

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
body	body	DeploymentOutputList	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

PATCH http://localhost:3000/deployments/{id}/outputs HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/problem+json

# You can also use wget
curl -X PATCH http://localhost:3000/deployments/{id}/outputs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/problem+json'
}

r = requests.patch('http://localhost:3000/deployments/{id}/outputs', headers = headers)

print(r.json())

delete-deployment-outputs

Operation Id: delete-deployment-outputs

Action: DELETE /deployments/{id}/outputs

Summary: Delete the outputs of a deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

DELETE http://localhost:3000/deployments/{id}/outputs HTTP/1.1
Host: localhost:3000
Accept: application/problem+json

# You can also use wget
curl -X DELETE http://localhost:3000/deployments/{id}/outputs \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Accept': 'application/problem+json'
}

r = requests.delete('http://localhost:3000/deployments/{id}/outputs', headers = headers)

print(r.json())

get-deployment-output

Operation Id: get-deployment-output

Action: GET /deployments/{id}/outputs/{outputId}

Summary: Get a specific output of a deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
outputId	path	DeploymentOutputId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	DeploymentOutput
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/deployments/{id}/outputs/{outputId} HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/deployments/{id}/outputs/{outputId} \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/deployments/{id}/outputs/{outputId}', headers = headers)

print(r.json())

create-deployment-output

Operation Id: create-deployment-output

Action: POST /deployments/{id}/outputs/{outputId}

Summary: Create a specific output of a deployment

Body parameter

{
  "id": "string",
  "sensitive": false,
  "value": null
}

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
outputId	path	DeploymentOutputId	true	none
body	body	DeploymentOutput	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
409	Conflict	Conflict	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

POST http://localhost:3000/deployments/{id}/outputs/{outputId} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/problem+json

# You can also use wget
curl -X POST http://localhost:3000/deployments/{id}/outputs/{outputId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/problem+json'
}

r = requests.post('http://localhost:3000/deployments/{id}/outputs/{outputId}', headers = headers)

print(r.json())

update-deployment-output

Operation Id: update-deployment-output

Action: PATCH /deployments/{id}/outputs/{outputId}

Summary: Update a specific output of a deployment

Body parameter

{
  "id": "string",
  "sensitive": false,
  "value": null
}

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
outputId	path	DeploymentOutputId	true	none
body	body	DeploymentOutput	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

PATCH http://localhost:3000/deployments/{id}/outputs/{outputId} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/problem+json

# You can also use wget
curl -X PATCH http://localhost:3000/deployments/{id}/outputs/{outputId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/problem+json'
}

r = requests.patch('http://localhost:3000/deployments/{id}/outputs/{outputId}', headers = headers)

print(r.json())

delete-deployment-output

Operation Id: delete-deployment-output

Action: DELETE /deployments/{id}/outputs/{outputId}

Summary: Delete a specific output of a deployment

Parameters

Name	In	Type	Required	Description
id	path	Id	true	none
outputId	path	DeploymentOutputId	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

DELETE http://localhost:3000/deployments/{id}/outputs/{outputId} HTTP/1.1
Host: localhost:3000
Accept: application/problem+json

# You can also use wget
curl -X DELETE http://localhost:3000/deployments/{id}/outputs/{outputId} \
  -H 'Accept: application/problem+json'

import requests
headers = {
  'Accept': 'application/problem+json'
}

r = requests.delete('http://localhost:3000/deployments/{id}/outputs/{outputId}', headers = headers)

print(r.json())

Schemas

InnerError

{
  "code": "string",
  "innererror": {
    "code": "string",
    "innererror": {
      "code": "string",
      "innererror": {
        "code": "string",
        "innererror": {
          "code": null,
          "innererror": null
        }
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
innererror	InnerError	false	none	none

Error

{
  "code": "string",
  "message": "string",
  "target": "string",
  "details": [
    {
      "code": "string",
      "message": "string",
      "target": "string",
      "details": [
        {
          "code": "string",
          "message": "string",
          "target": "string",
          "details": [
            {}
          ],
          "innererror": {
            "code": null,
            "innererror": null
          }
        }
      ],
      "innererror": {
        "code": "string",
        "innererror": {
          "code": "string",
          "innererror": {}
        }
      }
    }
  ],
  "innererror": {
    "code": "string",
    "innererror": {
      "code": "string",
      "innererror": {
        "code": "string",
        "innererror": {
          "code": null,
          "innererror": null
        }
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
message	string	false	none	none
target	string	false	none	none
details	[Error]	false	none	none
innererror	InnerError	false	none	none

Problem

{
  "type": "/some/uri-reference",
  "title": "some title for the error situation",
  "status": 100,
  "detail": "some description for the error situation",
  "instance": "/some/uri-reference#specific-occurrence-context",
  "cause": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string",
        "details": [
          {
            "code": null,
            "message": null,
            "target": null,
            "details": null,
            "innererror": null
          }
        ],
        "innererror": {
          "code": "string",
          "innererror": {}
        }
      }
    ],
    "innererror": {
      "code": "string",
      "innererror": {
        "code": "string",
        "innererror": {
          "code": null,
          "innererror": null
        }
      }
    }
  }
}

https://datatracker.ietf.org/doc/html/rfc7807

Properties

Name	Type	Required	Restrictions	Description
type	string(uri)	true	none	A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
title	string	false	none	A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
status	integer(int32)	false	none	The HTTP status code generated by the origin server for this occurrence of the problem.
detail	string	false	none	A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
instance	string(uri-reference)	false	none	A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
cause	Error	false	none	none

ProvisioningState

"Accepted"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Accepted
anonymous	Canceled
anonymous	Created
anonymous	Creating
anonymous	Deleted
anonymous	Deleting
anonymous	Failed
anonymous	NotSpecified
anonymous	Ready
anonymous	Running
anonymous	Succeeded
anonymous	Updating

ProvisioningStateHistoryItem

{
  "state": "Accepted",
  "timeStamp": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
state	ProvisioningState	true	none	none
timeStamp	string(date-time)	true	none	none

Id

"d7b048bd-efad-437a-aa76-a38004f24db3"

The id of the deployment of the specified deployment type

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(uuid)	false	none	The id of the deployment of the specified deployment type

DeploymentTypeId

"workspace"

The unique identifier of a deployment type

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The unique identifier of a deployment type

DeploymentQueryExpand

"all"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	all
anonymous	provisioningStateHistory
anonymous	outputs

DeploymentPath

"/workload.v1/myworkload/environment.v1/test"

Contains the path of the deployment, which can be used as a relative URL to access the deployment instead of it's ID

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	read-only	Contains the path of the deployment, which can be used as a relative URL to access the deployment instead of it's ID

DeploymentRef

{
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "path": "/workload.v1/myworkload/environment.v1/test"
}

Properties

Name	Type	Required	Restrictions	Description
id	Id	false	none	The id of the deployment of the specified deployment type
path	DeploymentPath	false	none	Contains the path of the deployment, which can be used as a relative URL to access the deployment instead of it's ID

Deployment

{
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "path": "/workload.v1/myworkload/environment.v1/test",
  "container": {
    "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
    "path": "/workload.v1/myworkload/environment.v1/test"
  },
  "etag": "string",
  "type": "workspace",
  "provisioningStateHistory": [
    {
      "state": "Accepted",
      "timeStamp": "2019-08-24T14:15:22Z"
    }
  ],
  "provisioningState": "Accepted",
  "data": {
    "dependencies": [
      {
        "type": "environment.v1",
        "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
        "path": "/workload.v1/myworkload/environment.v1/test"
      }
    ],
    "parameters": {},
    "outputs": [
      {
        "id": "string",
        "sensitive": false,
        "value": null
      }
    ]
  }
}

Deployment

Properties

Name	Type	Required	Restrictions	Description
id	Id	false	none	The id of the deployment of the specified deployment type
path	DeploymentPath	false	none	Contains the path of the deployment, which can be used as a relative URL to access the deployment instead of it's ID
container	DeploymentRef	false	none	none
etag	string	false	read-only	none
type	DeploymentTypeId	false	none	The unique identifier of a deployment type
provisioningStateHistory	[ProvisioningStateHistoryItem]	false	read-only	none
provisioningState	ProvisioningState	false	none	none
data	DeploymentData	false	none	none

DeploymentList

[
  {
    "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
    "type": "workspace.v1",
    "provisioningState": "Ready"
  },
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "environment.v1",
    "provisioningState": "Ready",
    "data": {
      "dependencies": [
        {
          "type": "workspace.v1",
          "id": "d7b048bd-efad-437a-aa76-a38004f24db3"
        }
      ],
      "parameters": {},
      "outputs": {}
    }
  },
  {
    "id": "6dc9fd24-c816-4d37-b9b5-1892486f741f",
    "type": "workspace.v2",
    "provisioningState": "Ready"
  }
]

DeploymentList

Properties

Name	Type	Required	Restrictions	Description
DeploymentList	[Deployment]	false	none	none

DeploymentDependency

{
  "type": "environment.v1",
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "path": "/workload.v1/myworkload/environment.v1/test"
}

DeploymentDependency

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	The deployment type which is a dependency for this deployment
id	Id	false	none	The id of the deployment of the specified deployment type
path	DeploymentPath	false	none	Contains the path of the deployment, which can be used as a relative URL to access the deployment instead of it's ID

DeploymentData

{
  "dependencies": [
    {
      "type": "environment.v1",
      "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
      "path": "/workload.v1/myworkload/environment.v1/test"
    }
  ],
  "parameters": {},
  "outputs": [
    {
      "id": "string",
      "sensitive": false,
      "value": null
    }
  ]
}

DeploymentData

Properties

Name	Type	Required	Restrictions	Description
dependencies	[DeploymentDependency]	false	none	none
parameters	object	false	none	none
outputs	DeploymentOutputList	false	none	none

DeploymentProvisioningState

{
  "id": "d7b048bd-efad-437a-aa76-a38004f24db3",
  "path": "/workload.v1/myworkload/environment.v1/test",
  "provisioningState": "Accepted"
}

DeploymentProvisioningState

Properties

Name	Type	Required	Restrictions	Description
id	Id	false	none	The id of the deployment of the specified deployment type
path	DeploymentPath	false	none	Contains the path of the deployment, which can be used as a relative URL to access the deployment instead of it's ID
provisioningState	ProvisioningState	true	none	none

DeploymentOutputId

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

DeploymentOutput

{
  "id": "string",
  "sensitive": false,
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
id	DeploymentOutputId	false	none	none
sensitive	boolean	false	none	none
value	any	false	none	none

DeploymentOutputList

[
  {
    "id": "string",
    "sensitive": false,
    "value": null
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[DeploymentOutput]	false	none	none