witboost API (1.0.0)

Download OpenAPI specification:Download

Collection of the APIs from witboost modules

Builder Module

API endpoints useful for the extensibility of the builder module

Update the status of a hook

Request Body schema: application/json

A resource to be evaluated

One of

status required	string Enum: "KO" "OK" Represents the desired state of the hook. OK means the third-party interaction has been completed with a positive result, KO on the other hand can be used to represent a negative result. If the hook is attached to an action, signaling KO could prevent the action's callback to be invoked
hookInfo	object A free-form object that will be stored as the hook's response data

Responses

Request samples

Payload

Content type

application/json

{"status": "KO",
"hookInfo": {"tracking": {"id": "string",
"url": "string"
}
}
}

Response samples

200
404
409
500

Content type

application/json

{"hookId": "string",
"hookName": "string",
"actionId": "string",
"actionName": "string",
"creationAt": "2019-08-24T14:15:22Z",
"updateAt": "2019-08-24T14:15:22Z",
"status": "WAITING"
}

Data Catalog Plugin

Microservice for provisioning and unprovisioning metadata in Data Catalog

Formally validate the provisioning request for the output ports metadata. In details, validates the format and the existence of glossary terms and of classification tags

Request Body schema: application/json

Details of a provisioning request to be validated

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"
descriptor required	string A provisioning request in yaml format

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string"
}

Response samples

202
400
500

Content type

application/json

"string"

Get status and results of an async validation operation

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING",
"info": {"publicInfo": {"valid": true,
"error": {"errors": ["string"
]
}
}
}
}

Validate a provisioning request

Request Body schema: application/json

Details of a provisioning request to be validated

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"
descriptor required	string A provisioning request in yaml format

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string"
}

Response samples

200
500

Content type

application/json

{"valid": true,
"error": {"errors": ["string"
]
}
}

Provisioning of metadata in Data Catalog from input descriptor

Request Body schema: application/json

A Data Product descriptor, enriched with components' provisioning results, wrapped as a string into a simple object

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"
descriptor required	string A provisioning request in yaml format

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string"
}

Response samples

200
202
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { }
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Get the status for a provisioning request

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500
501

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { }
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Unprovisioning of metadata in Data Catalog from input descriptor

Request Body schema: application/json

A data product descriptor and the provisioning results wrapped as simple object

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"
descriptor required	string A provisioning request in yaml format

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string"
}

Response samples

200
202
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { }
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Returns references (id, links, etc) to the data catalog entity that refers to the provided output port id

query Parameters

componentId

required

string

the id of the output port

Responses

Response samples

200
500

Content type

application/json

{"reference": "string"
}

Provisioning Coordinator

All the data product related operations

Validate a deployment request

Request Body schema: application/json

A deployment request descriptor wrapped as a string into a simple object

descriptor

required

string

Responses

Request samples

Payload

Content type

application/json

{"descriptor": "string"
}

Response samples

202
400
500

Content type

application/json

"string"

Validate a deployment request

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING",
"validationSummaryStatus": {"results": [{"validationPhaseKind": "INTERNAL_VALIDATION_PHASE",
"validatedDescriptor": "string",
"errors": {"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
},
"status": "RUNNING"
}
]
}
}

Retrieve the provisioning status of a deployment unit in a given environment

path Parameters

deployment-unit-id

required

string

Example: my-system:2

query Parameters

environment required	string Example: environment=development
include-descriptor required	boolean Default: false Whether the response should include the deployed deployment unit descriptor

Responses

Response samples

200
400
500

Content type

application/json

{"status": "DEPLOYED",
"provisioningDetails": {"descriptorVersion": "2.7.1",
"descriptor": {"id": "my-system:2",
"name": "my-system",
"version": "2.7.1",
"components": [{"id": "my-component-1",
"name": "My Component 1",
"dependsOn": [ ]
},
{"id": "my-component-2",
"name": "My Component 2",
"dependsOn": [ ]
},
{"id": "my-component-3",
"name": "My Component 3",
"dependsOn": ["my-component-1"
]
}
]
},
"componentsStatus": [{"componentId": "my-component-1",
"status": "DEPLOYED"
}
]
}
}

Computes the preview of all the deploy/undeploy operations that will be executed on the different components of a deployment unit

path Parameters

deployment-unit-id

required

string

Example: my-system:2

query Parameters

environment

required

string

Example: environment=development

Request Body schema: application/json

Provisioning request

descriptor required	object Deployment unit descriptor
required	Array of objects Desired provisioning status on the different components
removeData	boolean Default: false Used to indicate to the tech adapters of components that are going to be undeployed, whether the underlying infrastructural data are to be removed as well. Actions `UNDEPLOY` and `UNDEPLOY_AND_REMOVE_DATA` in `targetStatus` overwrite this indication at component-level
preventRedeploy	boolean Default: false If true, when a component is already deployed and its descriptor has remained unchanged, it will not be marked as to redeploy. Actions `DEPLOY` and `NO_ACTION` in `targetStatus` overwrite this indication at component-level

Responses

Request samples

Payload

Content type

application/json

{"descriptor": {"id": "my-system:2",
"name": "my-system",
"version": "2.7.1",
"components": [{"id": "my-component-1",
"name": "My Component 1",
"dependsOn": [ ]
},
{"id": "my-component-2",
"name": "My Component 2",
"dependsOn": [ ]
},
{"id": "my-component-3",
"name": "My Component 3",
"dependsOn": ["my-component-1"
]
}
]
},
"targetStatus": [{"componentId": "my-component-1",
"targetStatus": "DEPLOYED",
"action": "DEPLOY"
}
],
"removeData": false,
"preventRedeploy": false
}

Response samples

200
400
500

Content type

application/json

{"outcome": "OK",
"operations": [{"componentId": "my-component-1",
"targetStatus": "DEPLOYED",
"action": "DEPLOY",
"reason": "REQUEST",
"dependencyOf": ["my-component-3"
],
"dependantOn": ["my-component-4"
]
}
],
"conflictingOperations": [ ]
}

Validates and executes a provisioning plan

path Parameters

deployment-unit-id

required

string

Example: my-system:2

query Parameters

environment required	string Example: environment=development
unsafe	boolean Default: false If set to false, the request body is required to specify the desired provisioning status for each component in the descriptor. When set to true, any missing target status indications will be automatically inferred by trying to preserve the current provisioning status of the component.

Request Body schema: application/json

Provisioning request

descriptor required	object Deployment unit descriptor
required	Array of objects Desired provisioning status on the different components
removeData	boolean Default: false Used to indicate to the tech adapters of components that are going to be undeployed, whether the underlying infrastructural data are to be removed as well. Actions `UNDEPLOY` and `UNDEPLOY_AND_REMOVE_DATA` in `targetStatus` overwrite this indication at component-level
preventRedeploy	boolean Default: false If true, when a component is already deployed and its descriptor has remained unchanged, it will not be marked as to redeploy. Actions `DEPLOY` and `NO_ACTION` in `targetStatus` overwrite this indication at component-level

Responses

Request samples

Payload

Content type

application/json

{"descriptor": {"id": "my-system:2",
"name": "my-system",
"version": "2.7.1",
"components": [{"id": "my-component-1",
"name": "My Component 1",
"dependsOn": [ ]
},
{"id": "my-component-2",
"name": "My Component 2",
"dependsOn": [ ]
},
{"id": "my-component-3",
"name": "My Component 3",
"dependsOn": ["my-component-1"
]
}
]
},
"targetStatus": [{"componentId": "my-component-1",
"targetStatus": "DEPLOYED",
"action": "DEPLOY"
}
],
"removeData": false,
"preventRedeploy": false
}

Response samples

202
400
422
500

Content type

application/json

"aa53de04-f563-4bd3-9407-fb963a00d26b"

Terminates a running provisioning operation on the provided deployment unit

Interrupts any ongoing provisioning operation on the provided deployment unit. If the operation is associated with an active execution plan, the termination request will seamlessly pass to the plan. This last scenario mirrors a direct invocation of the v1/execution-plans/{token}/terminate endpoint.

path Parameters

deployment-unit-id

required

string

Example: my-system:2

query Parameters

environment

required

string

Example: environment=development

mode

string

Default: "safe"

Enum: "safe" "forced"

Example: mode=safe

safe - when the operation is linked to an active execution plan, all running tasks within the plan will receive an abort signal, prompting the plan to wait until each task undergoes a managed termination routine. If certain tasks do not support termination, the plan will wait until they are finished. The execution of tasks in a waiting status will not be prevented.
forced - when the operation is linked to an active execution plan, the plan's execution will be abruptly halted without the transmission of any abort signals.

Responses

Response samples

400
500

Content type

application/json

{"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

Validate a deployment request

Request Body schema: application/json

A deployment request descriptor wrapped as a string into a simple object

descriptor required	string Data Product descriptor in yaml format
removeData	boolean Default: false If true and the `data-deletion` configuration is enabled for the data product's environment, then, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptor": "string",
"removeData": false
}

Response samples

200
400
500

Content type

application/json

{"results": [{"validationPhaseKind": "INTERNAL_VALIDATION_PHASE",
"validatedDescriptor": "string",
"errors": {"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
},
"status": "RUNNING"
}
]
}

Fetching logs for the specified provisioning plan

path Parameters

provisioning_plan_id

required

string

The id of the plan for which we want to fetch the logs

query Parameters

level	string Filter for logs severity level to be displayed
task_id	string Filter for the Id of the task that generated the logs to be retrieved

Responses

Response samples

200
400
500

Content type

application/json

[{"timestamp": "2019-08-24T14:15:22Z",
"severity": "DEBUG",
"task": "string",
"message": "string",
"phase": "string"
}
]

Deploy a data product starting from its descriptor Deprecated

Deprecation notice: Replaced by v2/deployment-units/{deployment-unit-id}/provisioning

Request Body schema: application/json

A data product descriptor wrapped as a string into a simple object

descriptor required	string Data Product descriptor in yaml format
removeData	boolean Default: false If true and the `data-deletion` configuration is enabled for the data product's environment, then, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptor": "string",
"removeData": false
}

Response samples

202
400
500

Content type

application/json

"string"

Undeploy a data product starting from its descriptor Deprecated

Deprecation notice: Replaced by v2/deployment-units/{deployment-unit-id}/provisioning

Request Body schema: application/json

A data product descriptor wrapped as a string into a simple object

descriptor required	string Data Product descriptor in yaml format
removeData	boolean Default: false If true and the `data-deletion` configuration is enabled for the data product's environment, then, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptor": "string",
"removeData": false
}

Response samples

202
400
500

Content type

application/json

"string"

Get the status of an execution plan

path Parameters

token

required

string

execution plan token

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING"
}

Terminate the execution plan associated to the provided token

path Parameters

token

required

string

token that identifies the execution plan

query Parameters

mode	string Default: "safe" Enum: "safe" "forced" Example: mode=safe it describe the termination mode

Responses

Response samples

200
400
500

Content type

application/json

"string"

Get the provisioning plans associated to a data product id and an environment of the environments list

query Parameters

data-product-id required	string the id of the data product
environments required	string the environments to filter
version	string the data product version to filter
operations	string the operations to filter
include-descriptors	boolean Default: true whether to include the data product descriptor along with other task details
include-snapshot	boolean Default: true whether to retrieve also snapshot versions
offset	integer offset value
limit	integer limit value
ordering	string Enum: "asc" "desc" Sort order, default is desc

Responses

Response samples

200
400
500

Content type

application/json

{"provisioningPlans": [{"environment": "string",
"dag": {"id": "string",
"displayName": "string",
"name": "string",
"componentName": "string",
"descriptor": "string",
"version": "string",
"status": "RUNNING",
"action": "PROVISION",
"result": "string",
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [{ }
],
"subPlanId": "string"
}
}
],
"page": {"offset": 0,
"limit": 0,
"count": 0
}
}

Get the status for a deployment request Deprecated

Deprecation notice: Replaced by v1/execution-plans/{token}/status

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { }
}
}

Get the provisioning plan associated to a specific deploy request

path Parameters

token

required

string

token that identifies the request

query Parameters

include-descriptors

boolean

Default: true

whether to include the data product descriptor along with other task details

Responses

Response samples

200
400
500

Content type

application/json

{"environment": "string",
"dag": {"id": "string",
"displayName": "string",
"name": "string",
"componentName": "string",
"descriptor": "string",
"version": "string",
"status": "RUNNING",
"action": "PROVISION",
"result": "string",
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [{ }
],
"subPlanId": "string"
}
}

Terminate the plan with the provided token Deprecated

Deprecation notice: Replaced by v1/execution-plans/{token}/terminate

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

"string"

Crate a new template metadata item

Request Body schema: application/json

An object containing the template metadata

id required	string
name required	string
description required	string
version required	string
infrastructureIdRef	string
url	string
environment	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": "string",
"infrastructureIdRef": "string",
"url": "string",
"environment": "string"
}

Response samples

200
400
500

Content type

application/json

"string"

Reload the configuration

Responses

Get the current log level

Responses

Response samples

200

Content type

application/json

"TRACE"

Change the log level

path Parameters

level

required

string

Enum: "TRACE" "DEBUG" "INFO" "WARN" "ERROR" "OFF"

Log level

Responses

Response samples

200

Content type

application/json

"TRACE"

Request the access to a specific provisioner and saves the result inside the Marketplace proxy.

Request Body schema: application/json

An object containing the access request

dataProductUrn required	string
outputPortId required	integer
outputPortUrn required	string
requestId required	string
identities required	Array of strings
environment required	string
accessControlFields	object

Responses

Request samples

Payload

Content type

application/json

{"dataProductUrn": "string",
"outputPortId": 0,
"outputPortUrn": "string",
"requestId": "string",
"identities": ["string"
],
"environment": "string",
"accessControlFields": { }
}

Response samples

202
400
500

Content type

application/json

"string"

Find resources

query Parameters

environment	string environment name
id	string deployment unit id
offset	integer number of items to skip before retrieving data.
limit	integer <= 50 Default: 5 maximum number of items to return

Responses

Response samples

200
400
404
500

Content type

application/json

{"content": ["string"
],
"page": {"offset": 0,
"limit": 0,
"count": 0
}
}

Execute a reverse provisioning operation

Request Body schema: application/json

useCaseTemplateId required	string Component's use case template id
infrastructureTemplateIds required	Array of strings non-empty IDs of all the infrastructure templates involved in the component's provisioning
environment required	string Environment of the specific provisioners (infrastructure templates) to be involved in the reverse provisioning process
params	object Reverse provisioning input params
catalogInfo	object Content of the current `catalog-info.yaml` of the component

Responses

Request samples

Payload

Content type

application/json

{"useCaseTemplateId": "urn:dmb:utm:op-standard:0.0.0",
"infrastructureTemplateIds": ["urn:dmb:itm:op-provisioner:0"
],
"environment": "production",
"params": {"inputA": "value A",
"inputB": 1
},
"catalogInfo": { }
}

Response samples

202
400
500

Content type

application/json

"string"

Get the execution plan associated to a reverse provisioning run

path Parameters

token

required

string

token that identifies the execution plan

Responses

Response samples

200
400
500

Content type

application/json

{"environment": "string",
"dag": {"id": "string",
"displayName": "string",
"name": "string",
"status": "RUNNING",
"result": { },
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [ ]
}
}

Fetch all the descriptors deployed with success from lastDeploymentTime until now

query Parameters

kind required	string Value: "pre-deployed" the kind related to the descriptor that we want to take. "pre-deployed" for having a descriptor without deploy and build info
lastDeploymentTime	string <date-time> the time after which the coordinator must search for descriptors
limit required	integer the number of descriptors that the coordinator must return

Responses

Response samples

200
400
500

Content type

application/json

{"descriptors": [{"descriptor": "string",
"operation": "Provision"
}
],
"lastDeploymentTime": "2019-08-24T14:15:22Z"
}

Specific Provisioner

All the provisioning related operations

Starts the termination process

path Parameters

token

required

string

token that identifies the tech adapter task

Responses

Response samples

200
400
500
501

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Asynchronously validate a provisioning request

Request Body schema: application/json

Details of a provisioning request to be validated

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "COMPONENT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS" Values: `DATAPRODUCT_DESCRIPTOR` - Complete descriptor of a data product. It is used in the data product level provisioning workflow. `COMPONENT_DESCRIPTOR` - Provisioning descriptor for a single data product component. Includes both the complete data product descriptor (`dataProduct` object field) and the id of the component to be provisioned (`componentIdToProvision` string field). `DATAPRODUCT_DESCRIPTOR_WITH_RESULTS` - This value is not currently used in the scope of a specific provisioner.
descriptor required	string Descriptor specification in yaml format. Its structure changes according to `descriptorKind`.
latestEnrichedDescriptor	string Filled only in case of provision/unprovison requests. Complete data product descriptor (YAML format), enriched with provisioning info provided by the specific provisioners during the latest (successful or failed) provisioning/unprovisioning operation for each component. If available, provisioning information is reported in the `info` fields at both the data product and component levels. The base schema for the `info` object is the same as Info, but additional fields may be included, such as the `latestProvisioningOperation` object. This object contains information about the most recent provisioning operation performed on the component, including the operation type (e.g. Deploy, Undeploy) in the `operation` field, as well as the status of the operation (e.g. NotStarted, Failed, Successful) in the `status` field. Please note that the information contained in a `info` object represents the most recent data provided by a specific provisioner for the corresponding component. However, this information may not have been provided during the last data product provisioning operation. For example, if the provisioning operation fails and the component's specific provisioner is not called, the information doesn't change. Only the `latestProvisioningOperation` object always refers to the most recent provisioning operation on the data product.
removeData required	boolean Default: false If true, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string",
"latestEnrichedDescriptor": "string",
"removeData": false
}

Response samples

202
400
500

Content type

application/json

"string"

Get status and results of an async validation operation

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING",
"info": {"publicInfo": {"valid": true,
"error": {"errors": ["string"
]
}
}
}
}

Deploy a data product or a single component starting from a provisioning descriptor

Request Body schema: application/json

Provisioning descriptor

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "COMPONENT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS" Values: `DATAPRODUCT_DESCRIPTOR` - Complete descriptor of a data product. It is used in the data product level provisioning workflow. `COMPONENT_DESCRIPTOR` - Provisioning descriptor for a single data product component. Includes both the complete data product descriptor (`dataProduct` object field) and the id of the component to be provisioned (`componentIdToProvision` string field). `DATAPRODUCT_DESCRIPTOR_WITH_RESULTS` - This value is not currently used in the scope of a specific provisioner.
descriptor required	string Descriptor specification in yaml format. Its structure changes according to `descriptorKind`.
latestEnrichedDescriptor	string Filled only in case of provision/unprovison requests. Complete data product descriptor (YAML format), enriched with provisioning info provided by the specific provisioners during the latest (successful or failed) provisioning/unprovisioning operation for each component. If available, provisioning information is reported in the `info` fields at both the data product and component levels. The base schema for the `info` object is the same as Info, but additional fields may be included, such as the `latestProvisioningOperation` object. This object contains information about the most recent provisioning operation performed on the component, including the operation type (e.g. Deploy, Undeploy) in the `operation` field, as well as the status of the operation (e.g. NotStarted, Failed, Successful) in the `status` field. Please note that the information contained in a `info` object represents the most recent data provided by a specific provisioner for the corresponding component. However, this information may not have been provided during the last data product provisioning operation. For example, if the provisioning operation fails and the component's specific provisioner is not called, the information doesn't change. Only the `latestProvisioningOperation` object always refers to the most recent provisioning operation on the data product.
removeData required	boolean Default: false If true, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string",
"latestEnrichedDescriptor": "string",
"removeData": false
}

Response samples

200
202
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Get the status of a provisioning request

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Undeploy a data product or a single component given the provisioning descriptor relative to the latest complete provisioning request

Request Body schema: application/json

Provisioning descriptor

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "COMPONENT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS" Values: `DATAPRODUCT_DESCRIPTOR` - Complete descriptor of a data product. It is used in the data product level provisioning workflow. `COMPONENT_DESCRIPTOR` - Provisioning descriptor for a single data product component. Includes both the complete data product descriptor (`dataProduct` object field) and the id of the component to be provisioned (`componentIdToProvision` string field). `DATAPRODUCT_DESCRIPTOR_WITH_RESULTS` - This value is not currently used in the scope of a specific provisioner.
descriptor required	string Descriptor specification in yaml format. Its structure changes according to `descriptorKind`.
latestEnrichedDescriptor	string Filled only in case of provision/unprovison requests. Complete data product descriptor (YAML format), enriched with provisioning info provided by the specific provisioners during the latest (successful or failed) provisioning/unprovisioning operation for each component. If available, provisioning information is reported in the `info` fields at both the data product and component levels. The base schema for the `info` object is the same as Info, but additional fields may be included, such as the `latestProvisioningOperation` object. This object contains information about the most recent provisioning operation performed on the component, including the operation type (e.g. Deploy, Undeploy) in the `operation` field, as well as the status of the operation (e.g. NotStarted, Failed, Successful) in the `status` field. Please note that the information contained in a `info` object represents the most recent data provided by a specific provisioner for the corresponding component. However, this information may not have been provided during the last data product provisioning operation. For example, if the provisioning operation fails and the component's specific provisioner is not called, the information doesn't change. Only the `latestProvisioningOperation` object always refers to the most recent provisioning operation on the data product.
removeData required	boolean Default: false If true, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string",
"latestEnrichedDescriptor": "string",
"removeData": false
}

Response samples

200
202
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Validate a provisioning request

Request Body schema: application/json

Details of a provisioning request to be validated

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "COMPONENT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS" Values: `DATAPRODUCT_DESCRIPTOR` - Complete descriptor of a data product. It is used in the data product level provisioning workflow. `COMPONENT_DESCRIPTOR` - Provisioning descriptor for a single data product component. Includes both the complete data product descriptor (`dataProduct` object field) and the id of the component to be provisioned (`componentIdToProvision` string field). `DATAPRODUCT_DESCRIPTOR_WITH_RESULTS` - This value is not currently used in the scope of a specific provisioner.
descriptor required	string Descriptor specification in yaml format. Its structure changes according to `descriptorKind`.
latestEnrichedDescriptor	string Filled only in case of provision/unprovison requests. Complete data product descriptor (YAML format), enriched with provisioning info provided by the specific provisioners during the latest (successful or failed) provisioning/unprovisioning operation for each component. If available, provisioning information is reported in the `info` fields at both the data product and component levels. The base schema for the `info` object is the same as Info, but additional fields may be included, such as the `latestProvisioningOperation` object. This object contains information about the most recent provisioning operation performed on the component, including the operation type (e.g. Deploy, Undeploy) in the `operation` field, as well as the status of the operation (e.g. NotStarted, Failed, Successful) in the `status` field. Please note that the information contained in a `info` object represents the most recent data provided by a specific provisioner for the corresponding component. However, this information may not have been provided during the last data product provisioning operation. For example, if the provisioning operation fails and the component's specific provisioner is not called, the information doesn't change. Only the `latestProvisioningOperation` object always refers to the most recent provisioning operation on the data product.
removeData required	boolean Default: false If true, when a component is undeployed, its underlying data will also be deleted

Responses

Request samples

Payload

Content type

application/json

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string",
"latestEnrichedDescriptor": "string",
"removeData": false
}

Response samples

200
500

Content type

application/json

{"valid": true,
"error": {"errors": ["string"
]
}
}

Request the access to a specific provisioner component

Request Body schema: application/json

An access request object. The provisoning info reported in provisionInfo refer to the latest complete provisioning workflow of the target component

refs required	Array of strings Identities (i.e. users and groups) involved in the ACL update request
required	object Information related to the provisioning workflow of a data product component
accessControlFields	object

Responses

Request samples

Payload

Content type

application/json

{"refs": ["user:alice",
"user:bob",
"group:groupA",
"group:groupB",
"group:groupC"
],
"provisionInfo": {"request": "string",
"result": "string"
},
"accessControlFields": { }
}

Response samples

200
202
400
500

Content type

application/json

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Execute a reverse provisioning operation

Request Body schema: application/json

useCaseTemplateId required	string Component's use case template id
environment required	string Target environment
params	object Reverse provisioning input params
catalogInfo	object Content of the current `catalog-info.yaml` of the component

Responses

Request samples

Payload

Content type

application/json

{"useCaseTemplateId": "urn:dmb:utm:op-standard:0.0.0",
"environment": "production",
"params": {"inputA": "value A",
"inputB": 1
},
"catalogInfo": { }
}

Response samples

200
202
400
500

Content type

application/json

{"status": "RUNNING",
"updates": {"metadata.fieldA": "Value A",
"spec.mesh.description": "Updated value",
"spec.fieldB": {"subfieldA": "Value A",
"subfieldB": 1
}
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Get status and results of a reverse provisioning operation

path Parameters

token

required

string

token that identifies the request

Responses

Response samples

200
400
500

Content type

application/json

{"status": "RUNNING",
"updates": {"metadata.fieldA": "Value A",
"spec.mesh.description": "Updated value",
"spec.fieldB": {"subfieldA": "Value A",
"subfieldB": 1
}
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

Governance Platform

All the governance platform related operations

Evaluate a resource against all policy that apply to its resource_type

Request Body schema: application/json

A resource to be evaluated

id required	string A unique identifier of the resource.
displayName	string
environment required	string
resourceType required	string
descriptor required	string
labels	Array of strings Labels to be attached to the evaluation report.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string",
"labels": ["string"
]
}

Response samples

202
400
500

Content type

application/json

{"reportId": "string"
}

Registers a new Metric in the Computational Governance Platform

Request Body schema: application/json

A metric object to be registered

name required	string Name of the metric. This is also used for display purposes.
description required	string Description of the metric
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this metric
tags required	Array of strings Descriptive tags to add contextual information on the metric
environment required	string Environment where this metric gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string The external URL to be contacted to trigger the execution of the metric
	object
required	object
additionalMetadata required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"domain": {"lowerBound": 0,
"upperBound": 0
},
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"additionalMetadata": "string"
}

Response samples

202
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Updates a metric status in the Computational Governance Platform

path Parameters

id

required

string

metric unique ID

Request Body schema: application/json

The desired status for the metric

status

required

string

Enum: "draft" "grace" "disabled_grace" "enabled" "disabled" "deprecated" "deleted"

Status of the governance entity

Responses

Request samples

Payload

Content type

application/json

{"status": "draft"
}

Response samples

202
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Updates a metric

path Parameters

id

required

string

metric unique ID

Request Body schema: application/json

A metric object to be update

groupId required	string
name required	string Name of the metric. This is also used for display purposes.
version required	integer
description required	string Description of the metric
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this metric
tags required	Array of strings Descriptive tags to add contextual information on the metric
environment required	string Environment where this metric gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string The external URL to be contacted to trigger the execution of the metric
	object
	object
additionalMetadata required	string

Responses

Request samples

Payload

Content type

application/json

{"groupId": "string",
"name": "string",
"version": 0,
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"domain": {"lowerBound": 0,
"upperBound": 0
},
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"additionalMetadata": "string"
}

Response samples

202
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Clones a metric and bumps its version

path Parameters

id

required

string

metric unique ID

Responses

Response samples

200
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Test a metric against its resource perimeter

path Parameters

id

required

string

Metric ID

Request Body schema: application/json

Additional options for the test

Array of objects

Additional selectors to restrict the resources perimeter

Array

description required	string
path required	string
values required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"description": "string",
"path": "string",
"values": ["string"
]
}
]
}

Response samples

202
400
404
500

Content type

application/json

{"reportId": "string"
}

Push a set of evaluation results for a metric in the Governance Platform

path Parameters

id

required

string

passive metric unique ID

query Parameters

environment

required

string

Environment to which these evaluation correspond to

Request Body schema: application/json

A list of evaluation results to generate a report. Each result is the consequence of a metric evaluating a resource.

Array

required	object
required	object

Responses

Request samples

Payload

Content type

application/json

[{"resource": {"id": "string",
"displayName": "string",
"descriptor": "string"
},
"result": {"value": 0,
"errors": ["string"
],
"details": { }
}
}
]

Response samples

201
400
422
500

Content type

application/json

{"id": "string",
"environment": "string",
"evaluationScope": "evaluation",
"evaluationResults": [{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}
],
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"status": "completedWithSuccess"
}

Registers a new Policy in the Computational Governance Platform

Request Body schema: application/json

A policy object to be registered

name required	string Name of the policy. This is also used for display purposes.
description required	string Description of the policy
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this policy
tags required	Array of strings Descriptive tags to add contextual information on the policy
environment required	string Environment where this policy gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string If engine is remote, this field contains the external URL to be contacted to trigger the execution of the policy
cueScript	string If engine is cue, this field contains the CUE script
severity required	string Enum: "info" "warning" "error" Describes the severity of the governance entity in case of a failing condition
additionalMetadata required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"cueScript": "string",
"severity": "info",
"additionalMetadata": "string"
}

Response samples

202
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Updates a policy status

path Parameters

id

required

string

policy unique ID

Request Body schema: application/json

The desired status for the policy

status

required

string

Enum: "draft" "grace" "disabled_grace" "enabled" "disabled" "deprecated" "deleted"

Status of the governance entity

Responses

Request samples

Payload

Content type

application/json

{"status": "draft"
}

Response samples

202
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Test a policy against its resource perimeter

path Parameters

id

required

string

Policy ID

Request Body schema: application/json

Additional options for the test

Array of objects

Additional selectors to restrict the resources perimeter

Array

description required	string
path required	string
values required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"description": "string",
"path": "string",
"values": ["string"
]
}
]
}

Response samples

202
400
404
500

Content type

application/json

{"reportId": "string"
}

Updates a policy

path Parameters

id

required

string

policy unique ID

Request Body schema: application/json

A policy object to be update

groupId required	string
name required	string Name of the policy. This is also used for display purposes.
version required	integer
description required	string Description of the policy
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this policy
tags required	Array of strings Descriptive tags to add contextual information on the policy
environment required	string Environment where this policy gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string If engine is remote, this field contains the external URL to be contacted to trigger the execution of the policy
cueScript	string If engine is cue, this field contains the CUE script
severity required	string Enum: "info" "warning" "error" Describes the severity of the governance entity in case of a failing condition
additionalMetadata required	string

Responses

Request samples

Payload

Content type

application/json

{"groupId": "string",
"name": "string",
"version": 0,
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"cueScript": "string",
"severity": "info",
"additionalMetadata": "string"
}

Response samples

202
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Clones a policy and bumps its version

path Parameters

id

required

string

policy unique ID

Responses

Response samples

200
400
500

Content type

application/json

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

Push a set of evaluation results for a policy in the Governance Platform

path Parameters

id

required

string

passive policy unique ID

query Parameters

environment

required

string

Environment to which these evaluation correspond to

Request Body schema: application/json

A list of evaluation results to generate a report. Each result is the consequence of a policy evaluating a resource.

Array

required	object
required	object

Responses

Request samples

Payload

Content type

application/json

[{"resource": {"id": "string",
"displayName": "string",
"descriptor": "string"
},
"result": {"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
}
}
]

Response samples

201
400
422
500

Content type

application/json

{"id": "string",
"environment": "string",
"evaluationScope": "evaluation",
"evaluationResults": [{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}
],
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"status": "completedWithSuccess"
}

Get evaluation reports by applying filters

query Parameters

policyId	string Policy id
resourceName	string Resource name. Not yet supported

Responses

Response samples

200
400
500

Content type

application/json

{"evaluationReports": [{"id": "string",
"environment": "string",
"evaluationScope": "evaluation",
"evaluationResults": [{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}
],
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"status": "completedWithSuccess"
}
]
}

Get an evaluation report by ID

path Parameters

id

required

string

Policy id

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"environment": "string",
"evaluationScope": "evaluation",
"evaluationResults": [{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}
],
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"status": "completedWithSuccess"
}

Find and schedule active policies with an attached cron expression

Responses

Response samples

500

Content type

application/json

{"error": "string",
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

Gets the list of the existing Resource types

Responses

Response samples

200
400
500

Content type

application/json

{"resource_types": ["string"
]
}

Computes a list of policies with the highest failure rate in a given date interval

Request Body schema: application/json

environment required	string
limit required	integer [ 1 .. 50 ] Default: 10 Maximum number of policies to be returned.
startDate required	string <date-time> Lower bound of the date interval (inclusive)
endDate required	string <date-time> Upper bound of the date interval (inclusive)
includePolicyDetails required	boolean Default: false Whether to include full policy details in the results or just policy ids (faster)

Responses

Request samples

Payload

Content type

application/json

{"environment": "string",
"limit": 10,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"includePolicyDetails": false
}

Response samples

200
400
500

Content type

application/json

[{"policyId": "string",
"failureRate": 0.8,
"policy": {"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}
}
]

Computes policy execution stats

Request Body schema: application/json

environment required	string
startDate required	string <date-time> Lower bound of the date interval (inclusive)
endDate required	string <date-time> Upper bound of the date interval (inclusive)

Responses

Request samples

Payload

Content type

application/json

{"environment": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}

Response samples

200
400
500

Content type

application/json

[{"resourceType": "string",
"failed": 0,
"total": 0,
"noResult": 0
}
]

Computes failed policy evaluation stats

Request Body schema: application/json

environment required	string
startDate required	string <date-time> Lower bound of the date interval (inclusive)
endDate required	string <date-time> Upper bound of the date interval (inclusive)
reportLabels	Array of strings If defined, only failed executions linked to an evaluation report containing all these labels will be included in the computation

Responses

Request samples

Payload

Content type

application/json

{"environment": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"reportLabels": ["deployment"
]
}

Response samples

200
400
500

Content type

application/json

[{"resourceType": "string",
"failedEvaluations": 0
}
]

Retrieves the most recent evaluation results that meet the specified filters for each governance entity (in a state among "grace", "enabled", "deprecated") associated with the provided resources. For instance, if governance entity A has undergone three evaluations on resource A, and governance entity B has been evaluated twice on the same resource, the returned results will include the latest evaluation result that matches the filters for governance entity A on resource A, as well as the latest evaluation result that satisfies the filters for governance entity B on resource any

Request Body schema: application/json

resources required	Array of strings Resource names
environment required	string
governanceEntityType required	string Enum: "metric" "policy"
outcomes	Array of strings Items Enum: "ok" "error" "warning" "info" "pending" "not_blocking_error" "not_executed" Evaluation result outcomes to filter by
startDate	string <date-time> Lower bound of the date interval (inclusive)
endDate	string <date-time> Upper bound of the date interval (inclusive)
includeGovernanceEntityDetails	boolean Default: false Whether to include full governance entity details in the results or not (faster)

Responses

Request samples

Payload

Content type

application/json

{"resources": ["string"
],
"environment": "string",
"governanceEntityType": "metric",
"outcomes": ["ok"
],
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"includeGovernanceEntityDetails": false
}

Response samples

200
400
500

Content type

application/json

[{"resource": "string",
"governanceEntityId": "string",
"outcome": "ok",
"evaluationResultId": 0,
"evaluationResult": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"evaluationTime": "2019-08-24T14:15:22Z",
"governanceEntity": {"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}
}
]

Marketplace Plugin

A proxy towards a market place service

Perform an insert operation of the provisioning results and the Data Product descriptor in the Marketplace DB

Request Body schema: application/json

A data product descriptor and the provisioning results wrapped as simple object

descriptor

required

string

Data Product descriptor in yaml format

Responses

Request samples

Payload

Content type

application/json

{"descriptor": "string"
}

Response samples

200
400
500

Content type

application/json

"string"

Perform a delete operation of the Data Product descriptor references that are in the Marketplace DB

Request Body schema: application/json

A data product descriptor and the provisioning results wrapped as simple object

descriptor

required

string

Data Product descriptor in yaml format

Responses

Request samples

Payload

Content type

application/json

{"descriptor": "string"
}

Response samples

200
400
500

Content type

application/json

"string"

Update the ACL table of the Marketplace database.

Request Body schema: application/json

The request used to update the ACL table.

requestId required	string
outputPortId required	integer
refs required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"outputPortId": 0,
"refs": ["string"
]
}

Response samples

204
400
500

Content type

application/json

"string"

UpdateHookRequest Model

status required	string Enum: "KO" "OK" Represents the desired state of the hook. OK means the third-party interaction has been completed with a positive result, KO on the other hand can be used to represent a negative result. If the hook is attached to an action, signaling KO could prevent the action's callback to be invoked
hookInfo	object A free-form object that will be stored as the hook's response data

{"status": "KO",
"hookInfo": { }
}

TraceableUpdateHookRequest Model

status required	string Enum: "KO" "OK" Represents the desired state of the hook. OK means the third-party interaction has been completed with a positive result, KO on the other hand can be used to represent a negative result. If the hook is attached to an action, signaling KO could prevent the action's callback to be invoked
	object A free-form object that will be stored as the hook's response data with an optional reserved field name for tracking information

{"status": "KO",
"hookInfo": {"tracking": {"id": "string",
"url": "string"
}
}
}

UpdateHookResponse Model

hookId required	string The unique identifier of the hook.
hookName required	string The name of the hook.
actionId	string The unique identifier of the action associated with the hook, if any.
actionName	string The name of the action associated with the hook, if any.
creationAt required	string <date-time> The timestamp indicating when the hook was created.
updateAt required	string <date-time> The timestamp indicating the last update time of the hook.
status required	string Enum: "WAITING" "KO" "OK" The current state of the hook, referencing the HookState schema.

{"hookId": "string",
"hookName": "string",
"actionId": "string",
"actionName": "string",
"creationAt": "2019-08-24T14:15:22Z",
"updateAt": "2019-08-24T14:15:22Z",
"status": "WAITING"
}

RequestedHookState Model

string

Enum: "KO" "OK"

Represents the desired state of the hook. OK means the third-party interaction has been completed with a positive result, KO on the other hand can be used to represent a negative result. If the hook is attached to an action, signaling KO could prevent the action's callback to be invoked

"KO"

HookState Model

string

Enum: "WAITING" "KO" "OK"

The current state of the hook, referencing the HookState schema.

"WAITING"

Error Model

required

object

message required	string An informative user-friendly message that informs about any occured error during the hook update
property name* additional property	any

{"error": {"message": "string"
}
}

ValidationStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED" `RUNNING`: the validation task is still running `COMPLETED`: the operation is complete and the validation result is available (`info.publicInfo` field) `FAILED`: an exception occurred while running the validation task
	object

{"status": "RUNNING",
"info": {"publicInfo": {"valid": true,
"error": {"errors": ["string"
]
}
}
}
}

ValidationResult Model

valid required	boolean Whether the provided descriptor is valid or not
	object Validation error related to a provided descriptor

{"valid": true,
"error": {"errors": ["string"
]
}
}

ValidationError Model

errors

required

Array of strings

{"errors": ["string"
]
}

DescriptorKind Model

string

Enum: "DATAPRODUCT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"

"DATAPRODUCT_DESCRIPTOR"

ProvisioningRequest Model

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"
descriptor required	string A provisioning request in yaml format

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string"
}

ProvisioningStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED"
result required	string Deprecated
	object
	Array of objects

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { }
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

RequestValidationError Model

errors required	Array of strings Deprecated
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"errors": ["string"
],
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

SystemError Model

error required	string Deprecated
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"error": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

ErrorMoreInfo Model

problems required	Array of strings Array of possible multiple problems: i.e. multiple validations failed
solutions required	Array of strings Array of possible solutions that the developer gives to the user to solve the issue

{"problems": ["string"
],
"solutions": ["string"
]
}

EntityReference Model

reference

required

string

{"reference": "string"
}

Info Model

publicInfo required	object Fields to display in the Marketplace UI. Note that only the values compliant to specific structures will be rendered in the "Technical Information" card of the Marketplace pages. Check the documentation for additional details
privateInfo required	object All the values in this object will be stored in the deployed descriptor, but will not be shown in the Marketplace UI

{"publicInfo": { },
"privateInfo": { }
}

ValidationInfo Model

required

object

Result of a validation operation on a provided descriptor

valid required	boolean Whether the provided descriptor is valid or not
	object Validation error related to a provided descriptor

{"publicInfo": {"valid": true,
"error": {"errors": ["string"
]
}
}
}

Log Model

timestamp required	string <date-time>
level required	string Enum: "DEBUG" "INFO" "WARNING" "ERROR" This is the severity level of the log
message required	string
phase	string

{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}

DescriptorsResponse Model

required	Array of objects
lastDeploymentTime	string <date-time>

{"descriptors": [{"descriptor": "string",
"operation": "Provision"
}
],
"lastDeploymentTime": "2019-08-24T14:15:22Z"
}

DescriptorDetails Model

descriptor required	string
operation required	string Enum: "Provision" "Unprovision" "InvalidOperation"

{"descriptor": "string",
"operation": "Provision"
}

ValidationStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"
	object

{"status": "RUNNING",
"validationSummaryStatus": {"results": [{"validationPhaseKind": "INTERNAL_VALIDATION_PHASE",
"validatedDescriptor": "string",
"errors": {"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
},
"status": "RUNNING"
}
]
}
}

DeployResult Model

object

{ }

ValidationRequest Model

descriptor

required

string

{"descriptor": "string"
}

ProvisionLog Model

timestamp required	string <date-time>
severity required	string Enum: "DEBUG" "INFO" "WARNING" "ERROR"
task required	string
message required	string
phase	string

{"timestamp": "2019-08-24T14:15:22Z",
"severity": "DEBUG",
"task": "string",
"message": "string",
"phase": "string"
}

UpdateAclRequest Model

dataProductUrn required	string
outputPortId required	integer
outputPortUrn required	string
requestId required	string
identities required	Array of strings
environment required	string
accessControlFields	object

{"dataProductUrn": "string",
"outputPortId": 0,
"outputPortUrn": "string",
"requestId": "string",
"identities": ["string"
],
"environment": "string",
"accessControlFields": { }
}

TemplateRequest Model

id required	string
name required	string
description required	string
version required	string
infrastructureIdRef	string
url	string
environment	string

{"id": "string",
"name": "string",
"description": "string",
"version": "string",
"infrastructureIdRef": "string",
"url": "string",
"environment": "string"
}

DeploymentRequest Model

descriptor required	string Data Product descriptor in yaml format
removeData	boolean Default: false If true and the `data-deletion` configuration is enabled for the data product's environment, then, when a component is undeployed, its underlying data will also be deleted

{"descriptor": "string",
"removeData": false
}

Task Model

id required	string
displayName required	string
name required	string
componentName required	string
descriptor required	string
version required	string version of the data product
status required	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"
action required	string Enum: "PROVISION" "UNPROVISION" "PROVISION_DATAPRODUCT" "UNPROVISION_DATAPRODUCT" "PROVISION_DATAPRODUCT_CATALOG" "UNPROVISION_DATAPRODUCT_CATALOG" "UPDATEACL" "MARKETPLACE_UPDATE" "VALIDATION" "VALIDATE_DATAPRODUCT" "VALIDATE_COMPONENT" "VALIDATE_DATAPRODUCT_CATALOG" "POLICY_VALIDATE_DATAPRODUCT" "POLICY_VALIDATE_COMPONENT" "VALIDATION_GATEWAY" "NOP"
result	string
startTime required	string <date-time>
stopTime required	string <date-time>
dependsOnTasks required	Array of objects
subPlanId	string

{"id": "string",
"displayName": "string",
"name": "string",
"componentName": "string",
"descriptor": "string",
"version": "string",
"status": "RUNNING",
"action": "PROVISION",
"result": "string",
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [{ }
],
"subPlanId": "string"
}

ProvisioningPlan Model

environment required	string The deploy environment
required	object

{"environment": "string",
"dag": {"id": "string",
"displayName": "string",
"name": "string",
"componentName": "string",
"descriptor": "string",
"version": "string",
"status": "RUNNING",
"action": "PROVISION",
"result": "string",
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [{ }
],
"subPlanId": "string"
}
}

ProvisioningPlanResponse Model

required	Array of objects
	object

{"provisioningPlans": [{"environment": "string",
"dag": {"id": "string",
"displayName": "string",
"name": "string",
"componentName": "string",
"descriptor": "string",
"version": "string",
"status": "RUNNING",
"action": "PROVISION",
"result": "string",
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [{ }
],
"subPlanId": "string"
}
}
],
"page": {"offset": 0,
"limit": 0,
"count": 0
}
}

ValidationPhaseSummary Model

required

Array of objects

Array

validationPhaseKind required	string Enum: "INTERNAL_VALIDATION_PHASE" "POLICY_DATAPRODUCT_VALIDATION_PHASE" "POLICY_COMPONENT_VALIDATION_PHASE" "COMPONENT_VALIDATION_PHASE" "DATAPRODUCT_VALIDATION_PHASE" "DATAPRODUCT_CATALOG_VALIDATION_PHASE"
validatedDescriptor	string
required	object
status	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"

{"results": [{"validationPhaseKind": "INTERNAL_VALIDATION_PHASE",
"validatedDescriptor": "string",
"errors": {"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
},
"status": "RUNNING"
}
]
}

ValidationPhaseResult Model

validationPhaseKind required	string Enum: "INTERNAL_VALIDATION_PHASE" "POLICY_DATAPRODUCT_VALIDATION_PHASE" "POLICY_COMPONENT_VALIDATION_PHASE" "COMPONENT_VALIDATION_PHASE" "DATAPRODUCT_VALIDATION_PHASE" "DATAPRODUCT_CATALOG_VALIDATION_PHASE"
validatedDescriptor	string
required	object
status	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"

{"validationPhaseKind": "INTERNAL_VALIDATION_PHASE",
"validatedDescriptor": "string",
"errors": {"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
},
"status": "RUNNING"
}

NotFoundError Model

errors

required

Array of strings

{"errors": ["string"
]
}

ValidationError Model

errors required	Array of strings Deprecated
code	string Internal error code for the thrown error
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

SystemError Model

error required	string Deprecated
code	string Internal error code for the thrown error
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"error": "string",
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

ErrorMoreInfo Model

problems required	Array of strings Array of possible multiple problems: i.e. multiple validations failed
solutions required	Array of strings Array of possible solutions that the developer gives to the user to solve the issue

{"problems": ["string"
],
"solutions": ["string"
]
}

DeploymentStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"
result	string Deprecated
	object

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { }
}
}

ExecutionPlanStatus Model

status

required

string

Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"

{"status": "RUNNING"
}

PerimeterResource Model

content required	Array of strings
	object

{"content": ["string"
],
"page": {"offset": 0,
"limit": 0,
"count": 0
}
}

TaskStatus Model

string

Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"

"RUNNING"

TaskAction Model

string

Enum: "PROVISION" "UNPROVISION" "PROVISION_DATAPRODUCT" "UNPROVISION_DATAPRODUCT" "PROVISION_DATAPRODUCT_CATALOG" "UNPROVISION_DATAPRODUCT_CATALOG" "UPDATEACL" "MARKETPLACE_UPDATE" "VALIDATION" "VALIDATE_DATAPRODUCT" "VALIDATE_COMPONENT" "VALIDATE_DATAPRODUCT_CATALOG" "POLICY_VALIDATE_DATAPRODUCT" "POLICY_VALIDATE_COMPONENT" "VALIDATION_GATEWAY" "NOP"

"PROVISION"

ValidationPhaseKind Model

string

Enum: "INTERNAL_VALIDATION_PHASE" "POLICY_DATAPRODUCT_VALIDATION_PHASE" "POLICY_COMPONENT_VALIDATION_PHASE" "COMPONENT_VALIDATION_PHASE" "DATAPRODUCT_VALIDATION_PHASE" "DATAPRODUCT_CATALOG_VALIDATION_PHASE"

"INTERNAL_VALIDATION_PHASE"

LogLevel Model

string

Enum: "TRACE" "DEBUG" "INFO" "WARN" "ERROR" "OFF"

"TRACE"

Info Model

publicInfo required	object
privateInfo required	object

{"publicInfo": { },
"privateInfo": { }
}

PaginationModel Model

offset required	integer
limit	integer
count	integer

{"offset": 0,
"limit": 0,
"count": 0
}

ReverseProvisioningRequest Model

useCaseTemplateId required	string Component's use case template id
infrastructureTemplateIds required	Array of strings non-empty IDs of all the infrastructure templates involved in the component's provisioning
environment required	string Environment of the specific provisioners (infrastructure templates) to be involved in the reverse provisioning process
params	object Reverse provisioning input params
catalogInfo	object Content of the current `catalog-info.yaml` of the component

{"useCaseTemplateId": "urn:dmb:utm:op-standard:0.0.0",
"infrastructureTemplateIds": ["urn:dmb:itm:op-provisioner:0"
],
"environment": "production",
"params": {"inputA": "value A",
"inputB": 1
},
"catalogInfo": { }
}

ReverseProvisioningPlan Model

environment required	string
required	object

{"environment": "string",
"dag": {"id": "string",
"displayName": "string",
"name": "string",
"status": "RUNNING",
"result": { },
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [ ]
}
}

ReverseProvisioningTask Model

id required	string
displayName required	string
name required	string
status required	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATED" "NOT_STARTED" "TERMINATING"
result	object
startTime required	string <date-time>
stopTime required	string <date-time>
dependsOnTasks required	Array of objects

{"id": "string",
"displayName": "string",
"name": "string",
"status": "RUNNING",
"result": { },
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z",
"dependsOnTasks": [ ]
}

GetProvisioningStatusResponse Model

status

required

string

Enum: "DEPLOYED" "PARTIALLY_DEPLOYED" "NOT_DEPLOYED" "PROVISIONING_IN_PROGRESS" "CORRUPT"

DEPLOYED - all the components in the descriptor are correctly deployed
PARTIALLY_DEPLOYED - some of the components in the descriptor are correctly deployed. The remaining ones are not deployed. There's no component in a corrupt state
NOT_DEPLOYED - deployment unit not deployed
PROVISIONING_IN_PROGRESS - there's a running provisioning operation on this deployment unit
CORRUPT - the last provisioning operation on this deployment unit has failed. Some of its components might be in a corrupt provisioning status

object

Provided when status is different from NOT_DEPLOYED

{"status": "DEPLOYED",
"provisioningDetails": {"descriptorVersion": "2.7.1",
"descriptor": {"id": "my-system:2",
"name": "my-system",
"version": "2.7.1",
"components": [{"id": "my-component-1",
"name": "My Component 1",
"dependsOn": [ ]
},
{"id": "my-component-2",
"name": "My Component 2",
"dependsOn": [ ]
},
{"id": "my-component-3",
"name": "My Component 3",
"dependsOn": ["my-component-1"
]
}
]
},
"componentsStatus": [{"componentId": "my-component-1",
"status": "DEPLOYED"
}
]
}
}

ProvisioningRequest Model

descriptor required	object Deployment unit descriptor
required	Array of objects Desired provisioning status on the different components
removeData	boolean Default: false Used to indicate to the tech adapters of components that are going to be undeployed, whether the underlying infrastructural data are to be removed as well. Actions `UNDEPLOY` and `UNDEPLOY_AND_REMOVE_DATA` in `targetStatus` overwrite this indication at component-level
preventRedeploy	boolean Default: false If true, when a component is already deployed and its descriptor has remained unchanged, it will not be marked as to redeploy. Actions `DEPLOY` and `NO_ACTION` in `targetStatus` overwrite this indication at component-level

{"descriptor": {"id": "my-system:2",
"name": "my-system",
"version": "2.7.1",
"components": [{"id": "my-component-1",
"name": "My Component 1",
"dependsOn": [ ]
},
{"id": "my-component-2",
"name": "My Component 2",
"dependsOn": [ ]
},
{"id": "my-component-3",
"name": "My Component 3",
"dependsOn": ["my-component-1"
]
}
]
},
"targetStatus": [{"componentId": "my-component-1",
"targetStatus": "DEPLOYED",
"action": "DEPLOY"
}
],
"removeData": false,
"preventRedeploy": false
}

ProvisioningPreviewResponseOperation Model

componentId required	string Id of a component in the provided descriptor or in another version of the same deployment unit (in case of cleanup operations). It could also be the deployment unit id in case of deployment-unit-level provisioning
targetStatus required	string Enum: "DEPLOYED" "NOT_DEPLOYED"
action required	string Enum: "DEPLOY" "UNDEPLOY" "UNDEPLOY_AND_REMOVE_DATA" "NO_ACTION"
reason required	string Enum: "NOT_IN_TARGET_DESCRIPTOR" "CLEANUP" "REQUEST" "DEPENDENCY_OF" "DEPENDANT_ON" `NOT_IN_TARGET_DESCRIPTOR` - the component is currently deployed and is going to be undeployed because no longer in the target descriptor `CLEANUP` - a previous failed or aborted provisioning operation left this component in a corrupt provisioning status. It needs to be undeployed `REQUEST` - a deploy/undeploy operation on this component has been explicitly requested `DEPENDENCY_OF` - this component must be deployed because dependency of another component that is going to be deployed `DEPENDANT_ON` - this component must be undeployed because dependant on another component that is going to be undeployed
dependencyOf	Array of strings Provided only when reason is `DEPENDENCY_OF`. Identifiers of the components that need this component to be deployed
dependantOn	Array of strings Provided only when reason is `DEPENDANT_ON`. Identifiers of the components that cause this component to be undeployed

{"componentId": "my-component-1",
"targetStatus": "DEPLOYED",
"action": "DEPLOY",
"reason": "REQUEST",
"dependencyOf": ["my-component-3"
],
"dependantOn": ["my-component-4"
]
}

ProvisioningPreviewResponse Model

outcome required	string Enum: "OK" "ABORTED_FOR_CONFLICTS" Outcome of the provisioning preview computation. `OK` - Preview successfully generated `ABORTED_FOR_CONFLICTS` - Conflicts have been found while generating the preview. `operations` holds a partial list of generated operations, while `conflictingOperations` details the specific conflicting operations
required	Array of objects Computed provisioning operations. At most one for component id
	Array of objects

{"outcome": "OK",
"operations": [{"componentId": "my-component-1",
"targetStatus": "DEPLOYED",
"action": "DEPLOY",
"reason": "REQUEST",
"dependencyOf": ["my-component-3"
],
"dependantOn": ["my-component-4"
]
}
],
"conflictingOperations": [ ]
}

ValidationStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED" `RUNNING`: the validation task is still running `COMPLETED`: the operation is complete and the validation result is available (`info.publicInfo` field) `FAILED`: an exception occurred while running the validation task
	object

{"status": "RUNNING",
"info": {"publicInfo": {"valid": true,
"error": {"errors": ["string"
]
}
}
}
}

UpdateAclRequest Model

refs required	Array of strings Identities (i.e. users and groups) involved in the ACL update request
required	object Information related to the provisioning workflow of a data product component
accessControlFields	object

{"refs": ["user:alice",
"user:bob",
"group:groupA",
"group:groupB",
"group:groupC"
],
"provisionInfo": {"request": "string",
"result": "string"
},
"accessControlFields": { }
}

DescriptorKind Model

string

Enum: "DATAPRODUCT_DESCRIPTOR" "COMPONENT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS"

Values:

DATAPRODUCT_DESCRIPTOR - Complete descriptor of a data product. It is used in the data product level provisioning workflow.
COMPONENT_DESCRIPTOR - Provisioning descriptor for a single data product component. Includes both the complete data product descriptor (dataProduct object field) and the id of the component to be provisioned (componentIdToProvision string field).
DATAPRODUCT_DESCRIPTOR_WITH_RESULTS - This value is not currently used in the scope of a specific provisioner.

"DATAPRODUCT_DESCRIPTOR"

ProvisioningRequest Model

descriptorKind required	string Enum: "DATAPRODUCT_DESCRIPTOR" "COMPONENT_DESCRIPTOR" "DATAPRODUCT_DESCRIPTOR_WITH_RESULTS" Values: `DATAPRODUCT_DESCRIPTOR` - Complete descriptor of a data product. It is used in the data product level provisioning workflow. `COMPONENT_DESCRIPTOR` - Provisioning descriptor for a single data product component. Includes both the complete data product descriptor (`dataProduct` object field) and the id of the component to be provisioned (`componentIdToProvision` string field). `DATAPRODUCT_DESCRIPTOR_WITH_RESULTS` - This value is not currently used in the scope of a specific provisioner.
descriptor required	string Descriptor specification in yaml format. Its structure changes according to `descriptorKind`.
latestEnrichedDescriptor	string Filled only in case of provision/unprovison requests. Complete data product descriptor (YAML format), enriched with provisioning info provided by the specific provisioners during the latest (successful or failed) provisioning/unprovisioning operation for each component. If available, provisioning information is reported in the `info` fields at both the data product and component levels. The base schema for the `info` object is the same as Info, but additional fields may be included, such as the `latestProvisioningOperation` object. This object contains information about the most recent provisioning operation performed on the component, including the operation type (e.g. Deploy, Undeploy) in the `operation` field, as well as the status of the operation (e.g. NotStarted, Failed, Successful) in the `status` field. Please note that the information contained in a `info` object represents the most recent data provided by a specific provisioner for the corresponding component. However, this information may not have been provided during the last data product provisioning operation. For example, if the provisioning operation fails and the component's specific provisioner is not called, the information doesn't change. Only the `latestProvisioningOperation` object always refers to the most recent provisioning operation on the data product.
removeData required	boolean Default: false If true, when a component is undeployed, its underlying data will also be deleted

{"descriptorKind": "DATAPRODUCT_DESCRIPTOR",
"descriptor": "string",
"latestEnrichedDescriptor": "string",
"removeData": false
}

ProvisioningStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED" "TERMINATING" "TERMINATED" The status of the task that is executed by the tech adapter. It can have different values: - RUNNING: the task execution has not yet finished - COMPLETED: the task execution has finished with success - FAILED: the task execution has finished with some errors - TERMINATING: the task is about to terminate - TERMINATED: the task has been terminated
result required	string Deprecated
	object
	Array of objects

{"status": "RUNNING",
"result": "string",
"info": {"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

ValidationResult Model

valid required	boolean Whether the provided descriptor is valid or not
	object Validation error related to a provided descriptor

{"valid": true,
"error": {"errors": ["string"
]
}
}

ProvisionInfo Model

request required	string Provisioning descriptor of type `COMPONENT_DESCRIPTOR` (see DescriptorKind schema) in JSON format. It had been used to provision the data product component
result required	string Result message (e.g. a provisiong error or a success message returned by the specific provisioner in the ProvisioningStatus)

{"request": "string",
"result": "string"
}

ValidationError Model

errors

required

Array of strings

{"errors": ["string"
]
}

RequestValidationError Model

errors required	Array of strings Deprecated
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"errors": ["string"
],
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

SystemError Model

error required	string Deprecated
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"error": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

ErrorMoreInfo Model

problems required	Array of strings Array of possible multiple problems: i.e. multiple validations failed
solutions required	Array of strings Array of possible solutions that the developer gives to the user to solve the issue

{"problems": ["string"
],
"solutions": ["string"
]
}

Info Model

publicInfo required	object Fields to display in the Marketplace UI. Note that only the values compliant to specific structures will be rendered in the "Technical Information" card of the Marketplace pages. Check the documentation for additional details
privateInfo required	object All the values in this object will be stored in the deployed descriptor, but will not be shown in the Marketplace UI
	Array of objects

{"publicInfo": { },
"privateInfo": { },
"aclInfo": [{"identity": "string",
"locked": true
}
]
}

AclInfo Model

identity required	string User or group who has been granted access to a resource during the provisioning phase
locked required	boolean Describes whether the user or group can be directly manipulated by the access control panel in Witboost

{"identity": "string",
"locked": true
}

ValidationInfo Model

required

object

Result of a validation operation on a provided descriptor

valid required	boolean Whether the provided descriptor is valid or not
	object Validation error related to a provided descriptor

{"publicInfo": {"valid": true,
"error": {"errors": ["string"
]
}
}
}

Log Model

timestamp required	string <date-time>
level required	string Enum: "DEBUG" "INFO" "WARNING" "ERROR" This is the severity level of the log
message required	string
phase	string

{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}

ReverseProvisioningRequest Model

useCaseTemplateId required	string Component's use case template id
environment required	string Target environment
params	object Reverse provisioning input params
catalogInfo	object Content of the current `catalog-info.yaml` of the component

{"useCaseTemplateId": "urn:dmb:utm:op-standard:0.0.0",
"environment": "production",
"params": {"inputA": "value A",
"inputB": 1
},
"catalogInfo": { }
}

ReverseProvisioningStatus Model

status required	string Enum: "RUNNING" "COMPLETED" "FAILED" `RUNNING`: the reverse provisioning operation is still running `COMPLETED`: the operation is complete and the `updates` object is ready `FAILED`: an exception occurred while running the reverse provisioning operation (additional details could be found in the `logs` array)
updates required	object Field updates to be applied to the componenent's `catalog-info.yaml`. See the Reverse Provisioning documentation to learn more about the syntax of this object.
	Array of objects

{"status": "RUNNING",
"updates": {"metadata.fieldA": "Value A",
"spec.mesh.description": "Updated value",
"spec.fieldB": {"subfieldA": "Value A",
"subfieldB": 1
}
},
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"level": "DEBUG",
"message": "string",
"phase": "string"
}
]
}

NotFoundError Model

errors

required

Array of strings

{"errors": ["string"
]
}

ValidationError Model

errors required	Array of strings Deprecated
code	string Internal error code for the thrown error
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"errors": ["string"
],
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

SystemError Model

error required	string Deprecated
code	string Internal error code for the thrown error
userMessage	string User-readable message to be displayed
input	string Optional field to include the file or descriptor that raised the error
inputErrorField	string Optional field to include the field path (in dot format) that raised the error
	object Object that will include the more in-depth, specific information about the error

{"error": "string",
"code": "string",
"userMessage": "string",
"input": "string",
"inputErrorField": "string",
"moreInfo": {"problems": ["string"
],
"solutions": ["string"
]
}
}

ErrorMoreInfo Model

problems required	Array of strings Array of possible multiple problems: i.e. multiple validations failed
solutions required	Array of strings Array of possible solutions that the developer gives to the user to solve the issue

{"problems": ["string"
],
"solutions": ["string"
]
}

CreateMetricRequestModel Model

name required	string Name of the metric. This is also used for display purposes.
description required	string Description of the metric
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this metric
tags required	Array of strings Descriptive tags to add contextual information on the metric
environment required	string Environment where this metric gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string The external URL to be contacted to trigger the execution of the metric
	object
required	object
additionalMetadata required	string

{"name": "string",
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"domain": {"lowerBound": 0,
"upperBound": 0
},
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"additionalMetadata": "string"
}

CreatePolicyRequestModel Model

name required	string Name of the policy. This is also used for display purposes.
description required	string Description of the policy
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this policy
tags required	Array of strings Descriptive tags to add contextual information on the policy
environment required	string Environment where this policy gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string If engine is remote, this field contains the external URL to be contacted to trigger the execution of the policy
cueScript	string If engine is cue, this field contains the CUE script
severity required	string Enum: "info" "warning" "error" Describes the severity of the governance entity in case of a failing condition
additionalMetadata required	string

{"name": "string",
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"cueScript": "string",
"severity": "info",
"additionalMetadata": "string"
}

UpdateMetricRequestModel Model

groupId required	string
name required	string Name of the metric. This is also used for display purposes.
version required	integer
description required	string Description of the metric
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this metric
tags required	Array of strings Descriptive tags to add contextual information on the metric
environment required	string Environment where this metric gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string The external URL to be contacted to trigger the execution of the metric
	object
	object
additionalMetadata required	string

{"groupId": "string",
"name": "string",
"version": 0,
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"domain": {"lowerBound": 0,
"upperBound": 0
},
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"additionalMetadata": "string"
}

UpdatePolicyRequestModel Model

groupId required	string
name required	string Name of the policy. This is also used for display purposes.
version required	integer
description required	string Description of the policy
context required	string Enum: "global" "local"
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
interactionType required	string Enum: "user2user" "user2platform"
required	Array of objects
preprocessing	Array of strings
resourceType required	string Resource type compatible to this policy
tags required	Array of strings Descriptive tags to add contextual information on the policy
environment required	string Environment where this policy gets executed
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
externalUrl	string If engine is remote, this field contains the external URL to be contacted to trigger the execution of the policy
cueScript	string If engine is cue, this field contains the CUE script
severity required	string Enum: "info" "warning" "error" Describes the severity of the governance entity in case of a failing condition
additionalMetadata required	string

{"groupId": "string",
"name": "string",
"version": 0,
"description": "string",
"context": "global",
"strategy": "default",
"engine": "cue",
"trigger": "active",
"timing": "deployment",
"interactionType": "user2user",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"resourceType": "string",
"tags": ["string"
],
"environment": "string",
"cronExpression": "string",
"externalUrl": "string",
"cueScript": "string",
"severity": "info",
"additionalMetadata": "string"
}

GovernanceEntityResponseModel Model

id required	string
groupId required	string
status required	string Enum: "draft" "grace" "disabled_grace" "enabled" "disabled" "deprecated" "deleted" Status of the governance entity
name required	string
description	string
context required	string Enum: "global" "local"
interactionType required	string Enum: "user2user" "user2platform"
trigger required	string Enum: "active" "passive"
timing required	string Enum: "deployment" "runtime"
version required	integer
creationTime required	string <date-time>
updateTime required	string <date-time>
required	Array of objects
preprocessing	Array of strings
tags required	Array of strings
externalUrl	string
strategy required	string Enum: "default" "previous_vs_current" "none" Execution strategy of the governance entity
engine required	string Enum: "cue" "remote" "none"
resourceType required	string
cueScript	string
severity	string Enum: "info" "warning" "error" Describes the severity of the governance entity in case of a failing condition
environment required	string
cronExpression	string Cron expression in Quartz-like syntax with 6 fields that go from seconds to day of week in the following order: Seconds (0-59), Minutes (0-59), Hour of Day (0-23), Day of Month (1-31), Month (1-12), Day Of Week (0-6 where 0 is Monday). The following special characters are not allowed: L, W, LW, #. Time zone: UTC
	object
	object
additionalMetadata required	string

{"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}

ContextEnum Model

string

Enum: "global" "local"

"global"

ResultTypeEnum Model

string

Enum: "metric" "policy"

"metric"

StrategyEnum Model

string

Enum: "default" "previous_vs_current" "none"

Execution strategy of the governance entity

"default"

SeverityEnum Model

string

Enum: "info" "warning" "error"

Describes the severity of the governance entity in case of a failing condition

"info"

TriggerEnum Model

string

Enum: "active" "passive"

"active"

TimingEnum Model

string

Enum: "deployment" "runtime"

"deployment"

EvaluationScopeEnum Model

string

Enum: "evaluation" "test"

"evaluation"

EvaluationReportStatusEnum Model

string

Enum: "completedWithSuccess" "completedWithError" "completedWithWarning" "pending"

"completedWithSuccess"

StatusEnum Model

string

Enum: "draft" "grace" "disabled_grace" "enabled" "disabled" "deprecated" "deleted"

Status of the governance entity

"draft"

EngineEnum Model

string

Enum: "cue" "remote" "none"

"cue"

InteractionTypeEnum Model

string

Enum: "user2user" "user2platform"

"user2user"

SelectorModel Model

description required	string
path required	string
values required	Array of strings

{"description": "string",
"path": "string",
"values": ["string"
]
}

DomainModel Model

lowerBound required	number
upperBound required	number

{"lowerBound": 0,
"upperBound": 0
}

ThresholdModel Model

expression required	string Enum: "below_or_equal" "below" "above_or_equal" "above"
required	Array of objects

{"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
}

ThresholdItem Model

label required	string
labelColor required	string
value required	number

{"label": "string",
"labelColor": "string",
"value": 0
}

RangeModel Model

lowerBound required	number
upperBound required	number

{"lowerBound": 0,
"upperBound": 0
}

ResourceTypeResponseModel Model

resource_types

required

Array of strings

{"resource_types": ["string"
]
}

PushMetricResultRequestModel Model

required	object
required	object

{"resource": {"id": "string",
"displayName": "string",
"descriptor": "string"
},
"result": {"value": 0,
"errors": ["string"
],
"details": { }
}
}

PushPolicyResultRequestModel Model

required	object
required	object

{"resource": {"id": "string",
"displayName": "string",
"descriptor": "string"
},
"result": {"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
}
}

PushResourceRequestModel Model

id required	string The resource name is a unique identifier of the resource within Witboost. e.g. For Data Products, it is the unique URN, like urn:dmb:dp:marketing:a-dp:0
displayName	string The resource display name, if any. This is an optional user-friendly name of the resource that has been evaluated
descriptor required	string A descriptor of the resource, if available. This field can be left empty if it is not available. In case a valid descriptor is provided, this will help the user to understand exactly for which field in the descriptor the policy check failed.

{"id": "string",
"displayName": "string",
"descriptor": "string"
}

EvaluationResultModel Model

governanceEntityId required	string unique id of the policy that generated the evaluation result
governanceEntityStatus required	string Enum: "draft" "grace" "disabled_grace" "enabled" "disabled" "deprecated" "deleted" Status of the governance entity
governanceEntityType required	string Enum: "metric" "policy"
	object
outcome required	string Enum: "ok" "error" "warning" "info" "pending" "not_blocking_error" "not_executed"
	object
creationTime required	string <date-time>

{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}

EvaluationResultOutcomeEnum Model

string

Enum: "ok" "error" "warning" "info" "pending" "not_blocking_error" "not_executed"

"ok"

EvaluationResultResultModel Model

isError	boolean assumes true value if the execution of the policy or metric ended up in an internal error or a condition that prevented the regular evaluation (e.g. metric or policy is in an invalid state to fulfill the request)
value	number in case of a metric, this field represents the value computed by the metric, otherwise it is left empty
	object
satisfiesPolicy	boolean in case of a policy, this field represents if the resource is compliant or not compliant, otherwise it is is left empty
errors	Array of strings a list of errors that can describe why the resource ended up as not compliant, in case of a policy. otherwise errors can contain the user-friendly explanation of an internal error occurred.
details	object a free-form JSON field that can be filled with additional information and context relevant to the evaluation in case of a policy or a metric. otherwise it contains any relevant additional information for an internal error occurred.

{"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
}

ThresholdResult Model

label required	string
labelColor required	string

{"label": "string",
"labelColor": "string"
}

PolicyResultModel Model

satisfiesPolicy required	boolean
errors	Array of strings
details	object

{"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
}

MetricResultModel Model

value required	number
errors	Array of strings
details	object

{"value": 0,
"errors": ["string"
],
"details": { }
}

EvaluationReportResponseModel Model

required

Array of objects

Array

id required	string
environment required	string
evaluationScope required	string Enum: "evaluation" "test"
required	Array of objects
creationTime required	string <date-time>
updateTime required	string <date-time>
status required	string Enum: "completedWithSuccess" "completedWithError" "completedWithWarning" "pending"

{"evaluationReports": [{"id": "string",
"environment": "string",
"evaluationScope": "evaluation",
"evaluationResults": [{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}
],
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"status": "completedWithSuccess"
}
]
}

EvaluationReportModel Model

id required	string
environment required	string
evaluationScope required	string Enum: "evaluation" "test"
required	Array of objects
creationTime required	string <date-time>
updateTime required	string <date-time>
status required	string Enum: "completedWithSuccess" "completedWithError" "completedWithWarning" "pending"

{"id": "string",
"environment": "string",
"evaluationScope": "evaluation",
"evaluationResults": [{"governanceEntityId": "string",
"governanceEntityStatus": "draft",
"governanceEntityType": "metric",
"resource": {"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
},
"outcome": "ok",
"result": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"creationTime": "2019-08-24T14:15:22Z"
}
],
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"status": "completedWithSuccess"
}

EvaluationReportIdResponseModel Model

reportId

required

string

{"reportId": "string"
}

ResourceModel Model

id required	string A unique identifier of the resource.
displayName	string
environment required	string
resourceType required	string
descriptor	string

{"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string"
}

ResourceEvaluationModel Model

id required	string A unique identifier of the resource.
displayName	string
environment required	string
resourceType required	string
descriptor required	string
labels	Array of strings Labels to be attached to the evaluation report.

{"id": "string",
"displayName": "string",
"environment": "string",
"resourceType": "string",
"descriptor": "string",
"labels": ["string"
]
}

UpdateStatusRequestModel Model

status

required

string

Enum: "draft" "grace" "disabled_grace" "enabled" "disabled" "deprecated" "deleted"

Status of the governance entity

{"status": "draft"
}

TopFailedPolicyStatsRequestModel Model

environment required	string
limit required	integer [ 1 .. 50 ] Default: 10 Maximum number of policies to be returned.
startDate required	string <date-time> Lower bound of the date interval (inclusive)
endDate required	string <date-time> Upper bound of the date interval (inclusive)
includePolicyDetails required	boolean Default: false Whether to include full policy details in the results or just policy ids (faster)

{"environment": "string",
"limit": 10,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"includePolicyDetails": false
}

TopFailedPolicyStatsResponseModel Model

policyId required	string
failureRate required	number
	object

{"policyId": "string",
"failureRate": 0.8,
"policy": {"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}
}

PolicyExecutionStatsRequestModel Model

environment required	string
startDate required	string <date-time> Lower bound of the date interval (inclusive)
endDate required	string <date-time> Upper bound of the date interval (inclusive)

{"environment": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}

PolicyExecutionStatsResponseModel Model

resourceType required	string Reference resource type.
failed required	integer How many policies failed at least once in the selected interval and environment. Draft and disabled policies are excluded.
total required	integer How many policies were executed at least once in the selected interval and environment. Draft and disabled policies are excluded.
noResult required	integer How many policies were NOT executed even once in the selected interval and environment. Draft and disabled policies are excluded.

{"resourceType": "string",
"failed": 0,
"total": 0,
"noResult": 0
}

FailedPolicyEvaluationStatsRequestModel Model

environment required	string
startDate required	string <date-time> Lower bound of the date interval (inclusive)
endDate required	string <date-time> Upper bound of the date interval (inclusive)
reportLabels	Array of strings If defined, only failed executions linked to an evaluation report containing all these labels will be included in the computation

{"environment": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"reportLabels": ["deployment"
]
}

FailedPolicyEvaluationStatsResponseModel Model

resourceType required	string Reference resource type.
failedEvaluations required	integer How many policy executions failed by considering the provided filters.

{"resourceType": "string",
"failedEvaluations": 0
}

LatestResourceEvaluationsRequestModel Model

resources required	Array of strings Resource names
environment required	string
governanceEntityType required	string Enum: "metric" "policy"
outcomes	Array of strings Items Enum: "ok" "error" "warning" "info" "pending" "not_blocking_error" "not_executed" Evaluation result outcomes to filter by
startDate	string <date-time> Lower bound of the date interval (inclusive)
endDate	string <date-time> Upper bound of the date interval (inclusive)
includeGovernanceEntityDetails	boolean Default: false Whether to include full governance entity details in the results or not (faster)

{"resources": ["string"
],
"environment": "string",
"governanceEntityType": "metric",
"outcomes": ["ok"
],
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"includeGovernanceEntityDetails": false
}

LatestResourceEvaluationResponseModel Model

resource required	string Resource name
governanceEntityId required	string
outcome required	string Enum: "ok" "error" "warning" "info" "pending" "not_blocking_error" "not_executed"
evaluationResultId required	integer <int64>
required	object
evaluationTime required	string <date-time>
	object

{"resource": "string",
"governanceEntityId": "string",
"outcome": "ok",
"evaluationResultId": 0,
"evaluationResult": {"isError": true,
"value": 0,
"thresholdResult": {"label": "string",
"labelColor": "string"
},
"satisfiesPolicy": true,
"errors": ["string"
],
"details": { }
},
"evaluationTime": "2019-08-24T14:15:22Z",
"governanceEntity": {"id": "string",
"groupId": "string",
"status": "draft",
"name": "string",
"description": "string",
"context": "global",
"interactionType": "user2user",
"trigger": "active",
"timing": "deployment",
"version": 0,
"creationTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"selectors": [{"description": "string",
"path": "string",
"values": ["string"
]
}
],
"preprocessing": ["string"
],
"tags": ["string"
],
"externalUrl": "string",
"strategy": "default",
"engine": "cue",
"resourceType": "string",
"cueScript": "string",
"severity": "info",
"environment": "string",
"cronExpression": "string",
"thresholds": {"expression": "below_or_equal",
"range": [{"label": "string",
"labelColor": "string",
"value": 0
}
]
},
"domain": {"lowerBound": 0,
"upperBound": 0
},
"additionalMetadata": "string"
}
}

FiltersModel Model

Array of objects

Additional selectors to restrict the resources perimeter

Array

description required	string
path required	string
values required	Array of strings

{"filters": [{"description": "string",
"path": "string",
"values": ["string"
]
}
]
}

UpdateAclRequest Model

requestId required	string
outputPortId required	integer
refs required	Array of strings

{"requestId": "string",
"outputPortId": 0,
"refs": ["string"
]
}

ProvisioningResultRequest Model

descriptor

required

string

Data Product descriptor in yaml format

{"descriptor": "string"
}

PublishRequest Model

descriptor

required

string

Data Product descriptor in yaml format

{"descriptor": "string"
}

ValidationError Model

errors

required

Array of strings

{"errors": ["string"
]
}

SystemError Model

error

required

string

{"error": "string"
}