Dataiku Govern API
Call paths
All calls in the Govern public API are relative to the /public/api path on the Govern server.
For example, if your Govern server is available at http://mymachine:10000/, and you want to call the List blueprints API, you must make a GET request on http://mymachine:10000/public/api/blueprints/
curl --user <USER_API_KEY>: -H "Content-Type: application/json" -X GET http://mymachine:port/public/api/blueprints/
Other notes
Many API calls may return additional attributes compared to the documentation. The stability of these additional attributes is not guaranteed. They may be modified or removed in future releases without notice.
All API calls will return the following two HTTP headers
DSS-API-Version: Version of the API server handling the requestDSS-Version: Version of the DSS backend answering the request
Blueprints & Blueprints Versions ¶
Blueprints ¶
List blueprintsGET/blueprints
Lists the blueprints.
Example URI
GET /blueprints
Response
200Headers
Content-Type: application/jsonBody
[
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"assignedRolesAndPermissionsCtx": {}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Blueprint ¶
Get blueprintGET/blueprint/{blueprintId}
Retrieves a specific blueprint
Example URI
GET /blueprint/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"assignedRolesAndPermissionsCtx": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
}
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {}
}
}
}Blueprint Versions ¶
List blueprint versionsGET/blueprint/{blueprintId}/versions
Lists the versions of a blueprint
Example URI
GET /blueprint/bp.control/versions
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Response
200Headers
Content-Type: application/jsonBody
[
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"blueprintVersionTrace": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": "DRAFT",
"originVersionId": null
},
"assignedRolesAndPermissionsCtx": {},
"signoffConfigurations": {
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"signoffConfigurationHolders": [
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Blueprint Version ¶
Get blueprint versionGET/blueprint/{blueprintId}/version/{versionId}
Retrieves a blueprint version
Example URI
GET /blueprint/bp.control/version/bv.v1
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
- versionId
string(required) Example: bv.v1the ID of the version
Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"blueprintVersionTrace": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": "DRAFT",
"originVersionId": null
},
"assignedRolesAndPermissionsCtx": {},
"signoffConfigurations": {
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"signoffConfigurationHolders": [
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "the corresponding blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "Definition of the blueprint version"
},
"blueprintVersionTrace": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"ACTIVE",
"ARCHIVED"
],
"description": "Status of the blueprint version"
},
"originVersionId": {
"type": [
"string",
"null"
],
"description": "Version of the origin blueprint version"
}
},
"description": "Trace related information of the blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"signoffConfigurations": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"signoffConfigurationHolders": {
"type": "array",
"description": "List of the sign-off configurations with their stepId"
}
},
"description": "Optional sign-off configurations"
}
},
"definitions": {
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Artifacts ¶
Artifacts ¶
Create artifactPOST/artifacts
Creates an artifact
Example URI
POST /artifacts
Request
Headers
Content-Type: application/jsonBody
{
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": {
"archived": false,
"stepId": "step1"
},
"name": "",
"fields": {
"field1": {},
"field2": {}
},
"attachments": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the related blueprint version"
},
"status": {
"type": "object",
"properties": {
"archived": {
"type": "boolean"
},
"stepId": {
"type": [
"string",
"null"
],
"description": "Current active workflow step of the artifact"
}
},
"description": "Status of the artifact"
},
"name": {
"type": "string",
"description": "Name of the artifact"
},
"fields": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Map with the values of the fields"
},
"attachments": {
"type": "object",
"properties": {},
"description": "Attachments of the artifact"
}
},
"definitions": {
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"artifact": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": {
"archived": false,
"stepId": "step1"
},
"name": "",
"fields": {
"field1": {},
"field2": {}
},
"attachments": {},
"id": "ar.54"
},
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"assignedRolesAndPermissionsCtx": {},
"artifactSignoffs": {
"artifactId": "ar.57",
"signoffs": [
{
"stepId": "step1",
"cycles": [
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}
]
}
]
},
"uiArtifactDetails": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"artifact": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the related blueprint version"
},
"status": {
"type": "object",
"properties": {
"archived": {
"type": "boolean"
},
"stepId": {
"type": [
"string",
"null"
],
"description": "Current active workflow step of the artifact"
}
},
"description": "Status of the artifact"
},
"name": {
"type": "string",
"description": "Name of the artifact"
},
"fields": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Map with the values of the fields"
},
"attachments": {
"type": "object",
"properties": {},
"description": "Attachments of the artifact"
},
"id": {
"type": "string",
"description": "ID of the artifact"
}
},
"description": "The artifact content"
},
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "The related blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "The related blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"artifactSignoffs": {
"type": [
"object",
"null"
],
"properties": {
"artifactId": {
"type": "string",
"description": "ID of the artifact"
},
"signoffs": {
"type": "array",
"description": "List of the sign-offs"
}
},
"description": "List of the sign-offs"
},
"uiArtifactDetails": {
"type": "object",
"properties": {},
"description": "Various details about this artifact"
}
},
"definitions": {
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Search artifactPOST/artifacts/search
Search for artifacts. Use the parameter artifactFilters to specify a list of filter to apply on the query. Use the parameter artifactSearchSort to apply a sort on the results of the query. For example search artifacts which name contains a specific string. Use the parameter artifactSearchPagination to paginate the results.
Example URI
POST /artifacts/search
Request
Headers
Content-Type: application/jsonBody
{
"artifactSearchSource": {
"type": "all"
},
"artifactFilters": [
{
"type": "blueprints",
"blueprintIds": [
"bp.system.govern_project"
]
},
{
"type": "blueprintVersions",
"blueprintVersionIds": [
{
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
]
},
{
"type": "artifacts",
"artifactIds": [
"ar.54"
]
},
{
"type": "field",
"conditionType": "EQUALS",
"condition": "name1",
"fieldId": "field1",
"negateCondition": false,
"caseSensitive": false
},
{
"type": "archived",
"isArchived": true
}
],
"artifactSearchSort": {
"column": {
"type": "name"
},
"direction": "ASC"
},
"artifactSearchPagination": {
"lastArtifactID": "ar.86",
"pageSize": 20
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"artifactSearchSource": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all"
],
"description": "Type of the search source, for now, only the `all` search source is permitted and targets all artifacts."
}
},
"description": "A base search source for the query"
},
"artifactFilters": {
"type": "array",
"description": "The list of filters to apply on the query"
},
"artifactSearchSort": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
],
"description": "The direction of the sort, default is 'ASC'"
}
},
"oneOf": [
{
"properties": {
"column": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"name"
]
}
},
"required": [
"type"
],
"description": "Use this object to sort artifacts on their names"
}
}
},
{
"properties": {
"column": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow"
]
}
},
"required": [
"type"
],
"description": "Use this object to sort artifact on their workflow"
}
}
},
{
"properties": {
"column": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"field"
]
},
"fields": {
"type": "array",
"description": "An array of field on which the artifacts will be sorted."
}
},
"required": [
"type"
],
"description": "Use this object to sort artifact on a list of fields"
}
}
}
],
"description": "A definition of the sort to apply on the results"
},
"artifactSearchPagination": {
"type": "object",
"properties": {
"lastArtifactID": {
"type": [
"string",
"null"
],
"description": "The last artifact ID of the previous search. It can be used to get the new page of result starting from this artifact. Do not provide any for the first query."
},
"pageSize": {
"type": "number",
"description": "The size of the result page",
"default": 20
}
},
"description": "A definition of a pagination to perform on the results"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"hasNextPage": true,
"uiArtifacts": [
{
"artifact": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": {
"archived": false,
"stepId": "step1"
},
"name": "",
"fields": {
"field1": {},
"field2": {}
},
"attachments": {},
"id": "ar.54"
},
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"assignedRolesAndPermissionsCtx": {},
"artifactSignoffs": {
"artifactId": "ar.57",
"signoffs": [
{
"stepId": "step1",
"cycles": [
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}
]
}
]
},
"uiArtifactDetails": {}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"hasNextPage": {
"type": "boolean",
"description": "A boolean to indicate the presence of a next result page"
},
"uiArtifacts": {
"type": "array",
"description": "The result list"
}
}
}Artifact ¶
Get artifactGET/artifact/{artifactId}
Gets a specific artifact
Example URI
GET /artifact/ar.54
URI Parameters
- artifactId
string(required) Example: ar.54the ID of the artifact
Response
200Headers
Content-Type: application/jsonBody
{
"artifact": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": {
"archived": false,
"stepId": "step1"
},
"name": "",
"fields": {
"field1": {},
"field2": {}
},
"attachments": {},
"id": "ar.54"
},
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"assignedRolesAndPermissionsCtx": {},
"artifactSignoffs": {
"artifactId": "ar.57",
"signoffs": [
{
"stepId": "step1",
"cycles": [
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}
]
}
]
},
"uiArtifactDetails": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"artifact": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the related blueprint version"
},
"status": {
"type": "object",
"properties": {
"archived": {
"type": "boolean"
},
"stepId": {
"type": [
"string",
"null"
],
"description": "Current active workflow step of the artifact"
}
},
"description": "Status of the artifact"
},
"name": {
"type": "string",
"description": "Name of the artifact"
},
"fields": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Map with the values of the fields"
},
"attachments": {
"type": "object",
"properties": {},
"description": "Attachments of the artifact"
},
"id": {
"type": "string",
"description": "ID of the artifact"
}
},
"description": "The artifact content"
},
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "The related blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "The related blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"artifactSignoffs": {
"type": [
"object",
"null"
],
"properties": {
"artifactId": {
"type": "string",
"description": "ID of the artifact"
},
"signoffs": {
"type": "array",
"description": "List of the sign-offs"
}
},
"description": "List of the sign-offs"
},
"uiArtifactDetails": {
"type": "object",
"properties": {},
"description": "Various details about this artifact"
}
},
"definitions": {
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Save artifactPUT/artifact/{artifactId}
Saves an artifact
Example URI
PUT /artifact/ar.56
URI Parameters
- artifactId
string(required) Example: ar.56the ID of the artifact
Request
Headers
Content-Type: application/jsonBody
{
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": {
"archived": false,
"stepId": "step1"
},
"name": "",
"fields": {
"field1": {},
"field2": {}
},
"attachments": {},
"id": "ar.54"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the related blueprint version"
},
"status": {
"type": "object",
"properties": {
"archived": {
"type": "boolean"
},
"stepId": {
"type": [
"string",
"null"
],
"description": "Current active workflow step of the artifact"
}
},
"description": "Status of the artifact"
},
"name": {
"type": "string",
"description": "Name of the artifact"
},
"fields": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Map with the values of the fields"
},
"attachments": {
"type": "object",
"properties": {},
"description": "Attachments of the artifact"
},
"id": {
"type": "string",
"description": "ID of the artifact"
}
},
"definitions": {
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"artifact": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": {
"archived": false,
"stepId": "step1"
},
"name": "",
"fields": {
"field1": {},
"field2": {}
},
"attachments": {},
"id": "ar.54"
},
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"assignedRolesAndPermissionsCtx": {},
"artifactSignoffs": {
"artifactId": "ar.57",
"signoffs": [
{
"stepId": "step1",
"cycles": [
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}
]
}
]
},
"uiArtifactDetails": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"artifact": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the related blueprint version"
},
"status": {
"type": "object",
"properties": {
"archived": {
"type": "boolean"
},
"stepId": {
"type": [
"string",
"null"
],
"description": "Current active workflow step of the artifact"
}
},
"description": "Status of the artifact"
},
"name": {
"type": "string",
"description": "Name of the artifact"
},
"fields": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Map with the values of the fields"
},
"attachments": {
"type": "object",
"properties": {},
"description": "Attachments of the artifact"
},
"id": {
"type": "string",
"description": "ID of the artifact"
}
},
"description": "The artifact content"
},
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "The related blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "The related blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"artifactSignoffs": {
"type": [
"object",
"null"
],
"properties": {
"artifactId": {
"type": "string",
"description": "ID of the artifact"
},
"signoffs": {
"type": "array",
"description": "List of the sign-offs"
}
},
"description": "List of the sign-offs"
},
"uiArtifactDetails": {
"type": "object",
"properties": {},
"description": "Various details about this artifact"
}
},
"definitions": {
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Delete artifactDELETE/artifact/{artifactId}
Deletes an artifact.
Example URI
DELETE /artifact/ar.56
URI Parameters
- artifactId
string(required) Example: ar.56the ID of the artifact
Response
200Sign-offs ¶
List sign-offsGET/artifact/{artifactId}/signoffs
Lists the sign-offs for a given artifact
Example URI
GET /artifact/ar.56/signoffs
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
Response
200Headers
Content-Type: application/jsonBody
[
{
"stepId": "Hello, world!",
"currentCycle": {
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Sign-off ¶
Get sign-offGET/artifact/{artifactId}/workflow/step/{stepId}/signoff
Gets a sign-off for a given artifact and a specific step
Example URI
GET /artifact/ar.56/workflow/step/step1/signoff
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
Response
200Headers
Content-Type: application/jsonBody
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
},
"description": "Configuration of this cycle"
},
"signoffCycleStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"feedbackResponses": {
"type": "array",
"description": "List of the feedbacks"
},
"feedbackResponsesHistory": {
"type": "array",
"description": "History of the feedbacks"
},
"approverResponse": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"type": "string",
"description": "Login of the user who made the approval"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment from the user"
}
},
"description": "Response from the approver"
},
"approverResponsesHistory": {
"type": "array",
"description": "History of the approvals"
}
}
}Get sign-off detailsGET/artifact/{artifactId}/workflow/step/{stepId}/signoff/details
Gets sign-off details for a given artifact and a specific step. The details include information about the feedback groups and approval users
Example URI
GET /artifact/ar.56/workflow/step/step1/signoff/details
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
Response
200Headers
Content-Type: application/jsonBody
{
"feedbackGroups": [
{
"id": "group1",
"users": [
{
"type": "user",
"login": "UserA"
}
]
}
],
"approvalUsers": [
{
"type": "user",
"login": "UserA"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"feedbackGroups": {
"type": "array",
"description": "The details of the users in th feedback groups"
},
"approvalUsers": {
"type": "array",
"description": "The details of the users in charge of the approval"
}
}
}Update statusPOST/artifact/{artifactId}/workflow/step/{stepId}/signoff/update-status
Change the status of the sign-off, takes as input the target status and optionally a list of users to notify.
Only the users included in the groups of feedback and approval are able to give feedback or approval and can be notified, the complete list is available using: Get sign-off details
For the feedback, the users will be notified as part of a chosen group of feedback and the group must be specified.
Example URI
POST /artifact/ar.56/workflow/step/step1/signoff/update-status
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
Request
Headers
Content-Type: application/jsonBody
{
"targetStatus": "NOT_STARTED",
"usersToSendEmailTo": [
{
"userLogin": "UserA",
"groupId": "GroupA"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"targetStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"usersToSendEmailTo": {
"type": "array",
"description": "The users that will be notified of the status change"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
},
"description": "Configuration of this cycle"
},
"signoffCycleStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"feedbackResponses": {
"type": "array",
"description": "List of the feedbacks"
},
"feedbackResponsesHistory": {
"type": "array",
"description": "History of the feedbacks"
},
"approverResponse": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"type": "string",
"description": "Login of the user who made the approval"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment from the user"
}
},
"description": "Response from the approver"
},
"approverResponsesHistory": {
"type": "array",
"description": "History of the approvals"
}
}
}Add feedbackPOST/artifact/{artifactId}/workflow/step/{stepId}/signoff/add-feedback{?groupId}
Add a feedback for a specific feedback group. Takes as input a stepId, a groupId (the feedback group ID), a feedback status and an optional comment.
Example URI
POST /artifact/ar.56/workflow/step/step1/signoff/add-feedback?groupId=group1
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
- groupId
string(required) Example: group1The feedback group ID
Request
Headers
Content-Type: application/jsonBody
{
"status": "APPROVED",
"commment": "Correct"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"APPROVED",
"MINOR_ISSUE",
"MAJOR_ISSUE"
],
"description": "Status of the feedback"
},
"commment": {
"type": [
"string",
"null"
],
"description": "Related comment"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
},
"description": "Configuration of this cycle"
},
"signoffCycleStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"feedbackResponses": {
"type": "array",
"description": "List of the feedbacks"
},
"feedbackResponsesHistory": {
"type": "array",
"description": "History of the feedbacks"
},
"approverResponse": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"type": "string",
"description": "Login of the user who made the approval"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment from the user"
}
},
"description": "Response from the approver"
},
"approverResponsesHistory": {
"type": "array",
"description": "History of the approvals"
}
}
}Delegate feedbackPOST/artifact/{artifactId}/workflow/step/{stepId}/signoff/delegate-feedback{?groupId}
Delegate a feedback to a specific user. Takes as input a groupId (the feedback group to target), and a users container definition to delegate to.
Example URI
POST /artifact/ar.56/workflow/step/step1/signoff/delegate-feedback?groupId=group1
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
- groupId
string(required) Example: group1The feedback group ID to target
Request
Headers
Content-Type: application/jsonBody
{
"type": "user",
"login": "UserA"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user"
],
"description": "The type of the user container"
},
"login": {
"type": "string",
"description": "The login of the user"
}
},
"required": [
"type"
]
}Response
200Headers
Content-Type: application/jsonBody
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
},
"description": "Configuration of this cycle"
},
"signoffCycleStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"feedbackResponses": {
"type": "array",
"description": "List of the feedbacks"
},
"feedbackResponsesHistory": {
"type": "array",
"description": "History of the feedbacks"
},
"approverResponse": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"type": "string",
"description": "Login of the user who made the approval"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment from the user"
}
},
"description": "Response from the approver"
},
"approverResponsesHistory": {
"type": "array",
"description": "History of the approvals"
}
}
}Add approvalPOST/artifact/{artifactId}/workflow/step/{stepId}/signoff/add-approval
Add a final approval. Takes as input a stepId, an approval status and an optional comment.
Example URI
POST /artifact/ar.56/workflow/step/step1/signoff/add-approval
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
Request
Headers
Content-Type: application/jsonBody
{
"status": "APPROVED",
"commment": "Correct"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"commment": {
"type": [
"string",
"null"
],
"description": "Related comment"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
},
"description": "Configuration of this cycle"
},
"signoffCycleStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"feedbackResponses": {
"type": "array",
"description": "List of the feedbacks"
},
"feedbackResponsesHistory": {
"type": "array",
"description": "History of the feedbacks"
},
"approverResponse": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"type": "string",
"description": "Login of the user who made the approval"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment from the user"
}
},
"description": "Response from the approver"
},
"approverResponsesHistory": {
"type": "array",
"description": "History of the approvals"
}
}
}Delegate approvalPOST/artifact/{artifactId}/workflow/step/{stepId}/signoff/delegate-approval
Delegate the approval to a specific user. Takes as input a users container definition to delegate to.
Example URI
POST /artifact/ar.56/workflow/step/step1/signoff/delegate-approval
URI Parameters
- artifactId
string(required) Example: ar.56The artifact ID
- stepId
string(required) Example: step1The step ID
Request
Headers
Content-Type: application/jsonBody
{
"type": "user",
"login": "UserA"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user"
],
"description": "The type of the user container"
},
"login": {
"type": "string",
"description": "The login of the user"
}
},
"required": [
"type"
]
}Response
200Headers
Content-Type: application/jsonBody
{
"configuration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
},
"signoffCycleStatus": "NOT_STARTED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"feedbackResponses": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"feedbackResponsesHistory": [
{
"groupId": "groupA",
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
],
"approverResponse": {
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
},
"approverResponsesHistory": [
{
"user": "userA",
"status": "APPROVED",
"statusDate": "2022-09-02T18:26:03.748+02:00",
"comment": "comment"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
},
"description": "Configuration of this cycle"
},
"signoffCycleStatus": {
"type": "string",
"enum": [
"NOT_STARTED",
"WAITING_FOR_FEEDBACK",
"WAITING_FOR_APPROVAL",
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the cycle"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"feedbackResponses": {
"type": "array",
"description": "List of the feedbacks"
},
"feedbackResponsesHistory": {
"type": "array",
"description": "History of the feedbacks"
},
"approverResponse": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"type": "string",
"description": "Login of the user who made the approval"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"ABANDONED"
],
"description": "Status of the approval"
},
"statusDate": {
"type": "string",
"description": "Last status change date"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment from the user"
}
},
"description": "Response from the approver"
},
"approverResponsesHistory": {
"type": "array",
"description": "History of the approvals"
}
}
}Uploaded Files ¶
Upload a file ¶
Upload a filePOST/uploaded-files
Uploads a new file
Example URI
POST /uploaded-files
Request
Headers
Content-Type: multipartBody
file (Multipart file) - the file to uploadResponse
200Headers
Content-Type: application/jsonBody
{
"id": "uf.1",
"name": "image.png",
"type": "image/png"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the file"
},
"name": {
"type": "string",
"description": "The name of the file"
},
"type": {
"type": "string",
"description": "The type of the file"
}
},
"required": [
"id",
"name",
"type"
]
}Uploaded file ¶
Get uploaded file descriptionGET/uploaded-file/{uploadedFileId}
Gets an uploaded file description
Example URI
GET /uploaded-file/uf.1
URI Parameters
- uploadedFileId
string(required) Example: uf.1the ID of the file
Response
200Headers
Content-Type: application/jsonBody
{
"id": "uf.1",
"name": "image.png",
"type": "image/png"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the file"
},
"name": {
"type": "string",
"description": "The name of the file"
},
"type": {
"type": "string",
"description": "The type of the file"
}
},
"required": [
"id",
"name",
"type"
]
}Download uploaded fileGET/uploaded-file/{uploadedFileId}/download
Downloads an uploaded file.
Example URI
GET /uploaded-file/uf.1/download
URI Parameters
- uploadedFileId
string(required) Example: uf.1the ID of the file, starts with
uf.
Response
200Delete uploaded fileDELETE/uploaded-file/{uploadedFileId}
Deletes an uploaded file
Example URI
DELETE /uploaded-file/uf.1
URI Parameters
- uploadedFileId
string(required) Example: uf.1the ID of the file
Response
200Headers
Content-Type: application/jsonTime Series ¶
Time series ¶
Get time seriesGET/time-series/{timeSeriesId}{?timestampMin,timestampMax}
Gets a specific time series, use the request attributes to retrieve values within a specific time window
Example URI
GET /time-series/ts.1?timestampMin=1663056878000×tampMax=1993799888000
URI Parameters
- timeSeriesId
string(required) Example: ts.1the ID of the time series
- timestampMin
number(optional) Example: 1663056878000The minimum timestamp of the time window as epoch in milliseconds
- timestampMax
number(optional) Example: 1993799888000The maximum timestamp of the time window as epoch in milliseconds
Response
200Headers
Content-Type: application/jsonBody
[
{
"timeSeriesId": "ts.1",
"timestamp": "1983799888000",
"value": {}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Push time seriesPUT/time-series/{timeSeriesId}{?upsert}
Pushes data points to a time series
Example URI
PUT /time-series/ts.1?upsert=true
URI Parameters
- timeSeriesId
string(required) Example: ts.1the ID of the time series
- upsert
boolean(optional) Example: trueIf set to true and that a value exist for this timestamp, it will be overridden.
- Default true
Request
Headers
Content-Type: application/jsonBody
[
{
"timeSeriesId": "ts.1",
"timestamp": "1983799888000",
"value": {}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
200Headers
Content-Type: application/jsonDelete time seriesDELETE/time-series/{timeSeriesId}{?timestampMin,timestampMax}
Deletes values of a time series, use the request attributes to delete values within a specific time window. Deleting all values does not delete the time series object.
Example URI
DELETE /time-series/ts.1?timestampMin=1663056878000×tampMax=1993799888000
URI Parameters
- timeSeriesId
string(required) Example: ts.1the ID of the time series
- timestampMin
number(optional) Example: 1663056878000The minimum timestamp of the time window
- timestampMax
number(optional) Example: 1993799888000The maximum timestamp of the time window
Response
200Headers
Content-Type: application/jsonRoles ¶
List roles ¶
List rolesGET/roles
Lists the roles.
Example URI
GET /roles
Response
200Headers
Content-Type: application/jsonBody
[
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Get role ¶
Get roleGET/role/{roleId}
Gets a specific role
Example URI
GET /role/ro.reader
URI Parameters
- roleId
string(required) Example: ro.readerthe ID of the role
Response
200Headers
Content-Type: application/jsonBody
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the role"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the role"
},
"id": {
"type": "string",
"description": "ID of the role, starts with 'ro.'"
}
}
}Custom Pages ¶
List custom pages ¶
List custom pagesGET/custom-pages
Lists the custom pages
Example URI
GET /custom-pages
Response
200Headers
Content-Type: application/jsonBody
[
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Get custom page ¶
Get custom pageGET/custom-page/{customPageId}
Gets a specific custom page
Example URI
GET /custom-page/cp.cp1
URI Parameters
- customPageId
string(required) Example: cp.cp1the ID of the custom page
Response
200Headers
Content-Type: application/jsonBody
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"index": {
"type": "number",
"description": "Index of the tab on which the custom will be displayed"
},
"name": {
"type": "string",
"description": "Name of the custom page"
},
"icon": {
"type": "string",
"description": "Icon of the custom page"
},
"id": {
"type": "string",
"description": "ID of the custom page, starts with 'cp.'"
}
}
}Security ¶
Govern Users ¶
List usersGET/admin/users
Lists the users
🔒 Required privileges : Admin
Example URI
GET /admin/users
Response
200Headers
Content-Type: application/jsonBody
[
{
"login": "UserA",
"sourceType": "LOCAL",
"displayName": "User A",
"groups": [
"administrators"
],
"email": "Hello, world!",
"userProfile": "DATA_SCIENTIST",
"enabled": true
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create userPOST/admin/users
Creates a user
🔒 Required privileges : admin
Example URI
POST /admin/users
Request
Headers
Content-Type: application/jsonBody
{
"login": "UserA",
"sourceType": "LOCAL",
"displayName": "User A",
"email": "",
"groups": [],
"userProfile": "DATA_ANALYST",
"password": "password"
}Response
200Headers
Content-Type: application/jsonBody
{
"msg": "Created user UserA"
}Govern User ¶
Get userGET/admin/users/{userLogin}
Retrieves a specific user
🔒 Required privileges : Admin
Example URI
GET /admin/users/UserB
URI Parameters
- userLogin
string(required) Example: UserBthe login of the user
Response
200Headers
Content-Type: application/jsonBody
{
"login": "UserA",
"sourceType": "LOCAL",
"displayName": "User A",
"groups": [
"administrators"
],
"email": "Hello, world!",
"userProfile": "DATA_SCIENTIST",
"enabled": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "Login of the user"
},
"sourceType": {
"type": "string",
"enum": [
"LOCAL",
"LOCAL_NO_AUTH",
"LDAP"
],
"description": "Source type of the user"
},
"displayName": {
"type": "string",
"description": "Display name of the user"
},
"groups": {
"type": "array",
"description": "The groups of the user"
},
"email": {
"type": "string",
"description": "Email of the user"
},
"userProfile": {
"type": "string",
"description": "The profile of the user"
},
"enabled": {
"type": "boolean"
}
}
}Save userPUT/admin/users/{userLogin}
Saves a user
🔒 Required privileges : admin
Example URI
PUT /admin/users/UserA
URI Parameters
- userLogin
string(required) Example: UserAthe login of the user
Request
Headers
Content-Type: application/jsonBody
{
"login": "UserA",
"sourceType": "LOCAL",
"displayName": "User A",
"groups": [
"administrators"
],
"email": "Hello, world!",
"userProfile": "DATA_SCIENTIST",
"enabled": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "Login of the user"
},
"sourceType": {
"type": "string",
"enum": [
"LOCAL",
"LOCAL_NO_AUTH",
"LDAP"
],
"description": "Source type of the user"
},
"displayName": {
"type": "string",
"description": "Display name of the user"
},
"groups": {
"type": "array",
"description": "The groups of the user"
},
"email": {
"type": "string",
"description": "Email of the user"
},
"userProfile": {
"type": "string",
"description": "The profile of the user"
},
"enabled": {
"type": "boolean"
}
}
}Response
200Body
{
"msg": "Edited user UserA"
}Delete userDELETE/admin/users/{userLogin}
Deletes a user
🔒 Required privileges : admin
Example URI
DELETE /admin/users/UserA
URI Parameters
- userLogin
string(required) Example: UserAthe login of the user to delete
Response
200Govern Groups ¶
List groupsGET/admin/groups
Lists the groups
🔒 Required privileges : Admin
Example URI
GET /admin/groups
Response
200Headers
Content-Type: application/jsonBody
[
{
"name": "GroupA",
"description": "Group description",
"sourceType": "LOCAL",
"admin": false
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create groupPOST/admin/groups
Creates a group
🔒 Required privileges : admin
Example URI
POST /admin/groups
Request
Headers
Content-Type: application/jsonBody
{
"name": "GroupA",
"description": "Group description",
"sourceType": "LOCAL",
"admin": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the group"
},
"description": {
"type": "string",
"description": "Description of the group"
},
"sourceType": {
"type": "string",
"enum": [
"LOCAL",
"LDAP"
],
"description": "Source type of the group"
},
"admin": {
"type": "boolean",
"description": "Administrator rights on the group"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"msg": "Created group GroupB"
}Govern Group ¶
Get groupGET/admin/groups/{groupName}
Retrieves a specific group
🔒 Required privileges : Admin
Example URI
GET /admin/groups/GroupA
URI Parameters
- groupName
string(required) Example: GroupAthe name of the group
Response
200Headers
Content-Type: application/jsonBody
{
"name": "GroupA",
"description": "Group description",
"sourceType": "LOCAL",
"admin": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the group"
},
"description": {
"type": "string",
"description": "Description of the group"
},
"sourceType": {
"type": "string",
"enum": [
"LOCAL",
"LDAP"
],
"description": "Source type of the group"
},
"admin": {
"type": "boolean",
"description": "Administrator rights on the group"
}
}
}Save groupPUT/admin/groups/{groupName}
Saves a group
🔒 Required privileges : admin
Example URI
PUT /admin/groups/GroupB
URI Parameters
- groupName
string(required) Example: GroupBthe name of the group
Request
Headers
Content-Type: application/jsonBody
{
"name": "GroupA",
"description": "Group description",
"sourceType": "LOCAL",
"admin": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the group"
},
"description": {
"type": "string",
"description": "Description of the group"
},
"sourceType": {
"type": "string",
"enum": [
"LOCAL",
"LDAP"
],
"description": "Source type of the group"
},
"admin": {
"type": "boolean",
"description": "Administrator rights on the group"
}
}
}Response
200Body
{
"msg": "Edited group GroupB"
}Delete groupDELETE/admin/groups/{groupName}
Deletes a group
🔒 Required privileges : admin
Example URI
DELETE /admin/groups/GroupB
URI Parameters
- groupName
string(required) Example: GroupBthe name of the group to delete
Response
200Govern Administration ¶
Global settings ¶
Get general settingsGET/admin/general-settings
This calls retrieves the object representing Govern settings.
🔒 Required privileges : Admin
Example URI
GET /admin/general-settings
Response
200Headers
Content-Type: application/json
DSS-API-Version: Version of the API server handling the request
DSS-Version: Version of the DSS backend answering the requestBody
{
"ldapSettings" : { ... },
...
}Save general settingsPUT/admin/general-settings
This calls saves the DSS settings. You must only PUT an object that you acquired previously via the corresponding GET call
🔒 Required privileges : Admin
Example URI
PUT /admin/general-settings
Request
Headers
Content-Type: application/jsonBody
{
"ldapSettings" : { ... },
...
}Response
204Platform logs ¶
List logsGET/admin/logs
Dataiku Govern uses a number of log files.
🔒 Required privileges : Admin
Example URI
GET /admin/logs
Response
200Headers
Content-Type: application/json
DSS-API-Version: Version of the API server handling the request
DSS-Version: Version of the DSS backend answering the requestBody
{
"logs" : [
{
"name" : "access.log",
"totalSize" : 571166942,
"lastModified" : 1435840900000
},
...
]
}Log ¶
Get log contentGET/admin/logs/{name}
Retrieves the log file with the specified name.
🔒 Required privileges : Admin
Example URI
GET /admin/logs/name
URI Parameters
- name
string(required)the name of a log file
Response
200Headers
Content-Type: text/plain
DSS-API-Version: Version of the API server handling the request
DSS-Version: Version of the DSS backend answering the requestAudit trail ¶
Trigger new audit trail log itemPOST/admin/audit/custom/{customMsgType}
Appends an entry to the audit trail. The JSON object given as the request body
is put as customMsgParams in the created audit trail log entry.
🔒 Required privileges : Admin
Example URI
POST /admin/audit/custom/customMsgType
URI Parameters
- customMsgType
string(required)the
customMsgTypefor the audit trail log entry
Request
Headers
Content-Type: application/jsonBody
{
"arbitraryKey1" : { ... },
...
}Response
200Headers
Content-Type: text/plainLicensing ¶
Get licensing statusGET/admin/licensing/status
Returns the licensing status
🔒 Required privileges : admin
Example URI
GET /admin/licensing/status
Response
200Headers
Content-Type: application/jsonBody
{
"base": {
"licenseContent": {
"licensee": {
"email": "[email protected]",
"company": "ACME Inc.",
"name": "John Doe"
},
"dssMode": "ON_PREMISE_DISCONNECTED",
"instanceId": "ab7cdefg",
"licenseKind": "COMMUNITY",
"licenseId": "iJKLMnoP4qrSTUvw",
"properties": {
"automationFeaturesVersion": "2018-1"
},
"communityEdition": "true"
},
"hasLicense": true,
"valid": true,
"expired": false,
"expiresOn": 0,
"ceEntrepriseTrial": false,
"ceEntrepriseTrialUntil": 0,
"community": true,
"wasCEEntrepriseTrial": false,
"ceInstanceId": "sg7jbvoz",
"ceRegistrationEmail": "[email protected]",
"userProfiles": [
"DESIGNER"
]
},
"limits": {
"licensedProfiles": {
"DESIGNER": {
"profile": "DESIGNER",
"demotesFrom": [],
"licensedLimit": 3,
"mayAdmin": true,
"mayPython": true,
"mayScala": true,
"mayR": true,
"mayVisualML": true,
"mayReadProjectContent": true,
"mayWriteProjectContent": true,
"mayWriteDashboards": true
}
},
"profileLimits": {
"DESIGNER": {
"profile": "DESIGNER",
"licensed": {
"profile": "DESIGNER",
"demotesFrom": [],
"licensedLimit": 3,
"mayAdmin": true,
"mayPython": true,
"mayScala": true,
"mayR": true,
"mayVisualML": true,
"mayReadProjectContent": true,
"mayWriteProjectContent": true,
"mayWriteDashboards": true
},
"directCount": 1,
"demotedToOther": 0,
"countWithDemotedTo": 1,
"demotedTo": [],
"demotedFromOther": 0,
"demotedFrom": [],
"limitWithDemoted": 0,
"overQuota": 0
}
},
"fallbackProfile": "DESIGNER"
},
"features": {
"limitedEditionString": "Free Edition",
"allowedDatasetTypes": [
"S3",
"SCP",
"FTP",
"Greenplum",
"PostgreSQL",
"Cassandra",
"Netezza",
"Twitter",
"ElasticSearch",
"MySQL",
"Snowflake",
"JDBC",
"StatsDB",
"Filesystem",
"Oracle",
"UploadedFiles",
"FilesInFolder",
"Azure",
"BigQuery",
"JobsDB",
"HDFS",
"SFTP",
"HTTP",
"Inline",
"Teradata",
"Redshift",
"hiveserver2",
"GCS",
"SAPHANA",
"Vertica",
"MongoDB",
"SQLServer"
],
"allowedConnectionTypes": [
"FTP",
"Greenplum",
"PostgreSQL",
"Cassandra",
"Netezza",
"Twitter",
"ElasticSearch",
"EC2",
"MySQL",
"Snowflake",
"JDBC",
"StatsDB",
"Filesystem",
"Oracle",
"UploadedFiles",
"FilesInFolder",
"Azure",
"BigQuery",
"JobsDB",
"HDFS",
"SSH",
"HTTP",
"Inline",
"Teradata",
"Redshift",
"hiveserver2",
"GCS",
"SAPHANA",
"Vertica",
"MongoDB",
"SQLServer"
],
"ldapAllowed": false,
"ssoAllowed": false,
"userSecurityAllowed": false,
"multiUserSecurityAllowed": false,
"sparkAllowed": false,
"sparkMLLibAllowed": false,
"apiNodeAllowed": false,
"lockedTracking": false,
"forbiddenTracking": false,
"bundlesAllowed": false,
"advancedScenarioStepsAllowed": true,
"temporalTriggerAllowed": false,
"allScenarioTriggersAllowed": false,
"allScenarioReportersAllowed": false,
"advancedMetricsChecksAllowed": false,
"modelsRawSQLExport": false,
"modelsPMMLExport": false,
"modelsJarExport": false
}
Set current licensePOST/admin/licensing/license
Set DSS license
🔒 Required privileges : Admin
Example URI
POST /admin/licensing/license
Request
Headers
Content-Type: application/jsonBody
...content of the license file provided by Dataiku...Response
200Headers
Content-Type: text/plainAdmin Blueprint Designer ¶
Blueprints ¶
List blueprintsGET/admin/blueprints
Lists all the blueprints
🔒 Required privileges : Admin
Example URI
GET /admin/blueprints
Response
200Headers
Content-Type: application/jsonBody
[
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"assignedRolesAndPermissionsCtx": {}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create blueprintPOST/admin/blueprints{?newIdentifier}
Creates a blueprint
🔒 Required privileges : admin
Example URI
POST /admin/blueprints?newIdentifier=control
URI Parameters
- newIdentifier
string(required) Example: controlThe new identifier of the blueprint to be created. The new identifier has to be made of digits, letters, underscores (_), or hyphens (-)
Request
Headers
Content-Type: application/jsonBody
{
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"assignedRolesAndPermissionsCtx": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
}
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {}
}
}
}Blueprint ¶
Get blueprintGET/admin/blueprint/{blueprintId}
Retrieves a specific blueprint
🔒 Required privileges : Admin
Example URI
GET /admin/blueprint/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"assignedRolesAndPermissionsCtx": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
}
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {}
}
}
}Save blueprintPUT/admin/blueprint/{blueprintId}
Saves a blueprint
🔒 Required privileges : admin
Example URI
PUT /admin/blueprint/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Request
Headers
Content-Type: application/jsonBody
{
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
}
}Response
200Delete blueprintDELETE/admin/blueprint/{blueprintId}
Deletes a blueprint. All related blueprint versions and artifacts must be deleted beforehand.
🔒 Required privileges : admin
Example URI
DELETE /admin/blueprint/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Response
200Blueprint Versions ¶
List blueprint versionsGET/admin/blueprint/{blueprintId}/versions
Lists the versions of a blueprint
🔒 Required privileges : admin
Example URI
GET /admin/blueprint/bp.control/versions
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Response
200Headers
Content-Type: application/jsonBody
[
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"blueprintVersionTrace": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": "DRAFT",
"originVersionId": null
},
"assignedRolesAndPermissionsCtx": {},
"signoffConfigurations": {
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"signoffConfigurationHolders": [
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create blueprint versionPOST/admin/blueprint/{blueprintId}/versions{?newIdentifier,name,originVersionId}
Creates a blueprint
🔒 Required privileges : admin
Example URI
POST /admin/blueprint/bp.control/versions?newIdentifier=v3&name=blueprint control&originVersionId=bv.v1
URI Parameters
- blueprintId
string(required) Example: bp.controlThe blueprint ID
- newIdentifier
string(required) Example: v3The identifier of the version to be created
- name
string(optional) Example: blueprint controlThe name of the version to be created
- originVersionId
string(optional) Example: bv.v1The origin version ID. Needed if this blueprint version is created from another version.
Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"blueprintVersionTrace": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": "DRAFT",
"originVersionId": null
},
"assignedRolesAndPermissionsCtx": {},
"signoffConfigurations": {
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"signoffConfigurationHolders": [
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "the corresponding blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "Definition of the blueprint version"
},
"blueprintVersionTrace": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"ACTIVE",
"ARCHIVED"
],
"description": "Status of the blueprint version"
},
"originVersionId": {
"type": [
"string",
"null"
],
"description": "Version of the origin blueprint version"
}
},
"description": "Trace related information of the blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"signoffConfigurations": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"signoffConfigurationHolders": {
"type": "array",
"description": "List of the sign-off configurations with their stepId"
}
},
"description": "Optional sign-off configurations"
}
},
"definitions": {
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Blueprint Version ¶
Get blueprint versionGET/admin/blueprint/{blueprintId}/version/{versionId}
Retrieves a blueprint version
🔒 Required privileges : admin
Example URI
GET /admin/blueprint/bp.control/version/bv.v1
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
- versionId
string(required) Example: bv.v1the ID of the version
Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"blueprintVersionTrace": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": "DRAFT",
"originVersionId": null
},
"assignedRolesAndPermissionsCtx": {},
"signoffConfigurations": {
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"signoffConfigurationHolders": [
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "the corresponding blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "Definition of the blueprint version"
},
"blueprintVersionTrace": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"ACTIVE",
"ARCHIVED"
],
"description": "Status of the blueprint version"
},
"originVersionId": {
"type": [
"string",
"null"
],
"description": "Version of the origin blueprint version"
}
},
"description": "Trace related information of the blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"signoffConfigurations": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"signoffConfigurationHolders": {
"type": "array",
"description": "List of the sign-off configurations with their stepId"
}
},
"description": "Optional sign-off configurations"
}
},
"definitions": {
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Save blueprint versionPUT/admin/blueprint/{blueprintId}/version/{versionId}{?dangerZoneAccepted}
Saves a blueprint version
🔒 Required privileges : admin
Example URI
PUT /admin/blueprint/bp.control/version/bv.v3?dangerZoneAccepted=true
URI Parameters
- blueprintId
string(required) Example: bp.controlThe blueprint ID
- versionId
string(required) Example: bv.v3The version ID
- dangerZoneAccepted
boolean(optional) Example: trueIf set to false or absent, the blueprint version will be saved only if there are no existing artifacts for this blueprint version. If set to true, editing the blueprint version will update existing artifacts to reflect these changes with best effort which may lead to lost data or broken behaviour.
- Default false
Request
Headers
Content-Type: application/jsonBody
{
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"definitions": {
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"blueprint": {
"name": "blueprintName",
"icon": "fiber_new",
"color": "#494eba",
"backgroundColor": "#000000",
"id": "bp.control"
},
"blueprintVersion": {
"name": "Version1",
"fieldDefinitions": {},
"workflowDefinition": {
"stepDefinitions": [
{
"id": "step1",
"name": "Step1"
}
]
},
"logicalHookList": [],
"hierarchicalParentFieldId": null,
"uiDefinition": {
"views": {
"view1": {},
"view2": {}
},
"uiStepDefinitions": {
"step1": {
"viewId": "view1"
},
"step2": {
"viewId": "view1"
}
}
},
"instructions": "Instructions for this version",
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
}
},
"blueprintVersionTrace": {
"blueprintVersionId": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"status": "DRAFT",
"originVersionId": null
},
"assignedRolesAndPermissionsCtx": {},
"signoffConfigurations": {
"id": {
"blueprintId": "bp.control",
"versionId": "bv.v1"
},
"signoffConfigurationHolders": [
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint"
},
"icon": {
"type": "string",
"description": "Icon of the blueprint"
},
"color": {
"type": "string",
"description": "Color of the blueprint, hexadecimal format"
},
"backgroundColor": {
"type": [
"string",
"null"
],
"description": "Color of the background, hexadecimal format"
},
"id": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.' (or 'bp.system' for non custom blueprints)"
}
},
"description": "the corresponding blueprint"
},
"blueprintVersion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the blueprint version"
},
"fieldDefinitions": {
"type": "object",
"properties": {},
"description": "Field definitions of this blueprint version"
},
"workflowDefinition": {
"type": "object",
"properties": {
"stepDefinitions": {
"type": "array",
"description": "List of the steps"
}
},
"description": "The definition of the workflow"
},
"logicalHookList": {
"type": "array",
"description": "List of the hooks"
},
"hierarchicalParentFieldId": {
"type": [
"string",
"null"
],
"description": "Optional ID of the field in which the hierarchical parent item is referenced."
},
"uiDefinition": {
"type": "object",
"properties": {
"views": {
"allOf": [
{
"$ref": "#/definitions/view1"
},
{
"$ref": "#/definitions/view2"
}
],
"description": "list of the views"
},
"uiStepDefinitions": {
"allOf": [
{
"$ref": "#/definitions/step1"
},
{
"$ref": "#/definitions/step2"
}
],
"description": "list of the User Interface definition for the steps"
}
},
"description": "User interface definition of the blueprint"
},
"instructions": {
"type": "string",
"description": "Instructions for this blueprint version"
},
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
}
},
"description": "Definition of the blueprint version"
},
"blueprintVersionTrace": {
"type": "object",
"properties": {
"blueprintVersionId": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"ACTIVE",
"ARCHIVED"
],
"description": "Status of the blueprint version"
},
"originVersionId": {
"type": [
"string",
"null"
],
"description": "Version of the origin blueprint version"
}
},
"description": "Trace related information of the blueprint version"
},
"assignedRolesAndPermissionsCtx": {
"type": "object",
"properties": {},
"description": "The roles and permissions context"
},
"signoffConfigurations": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint, starts with 'bp.'"
},
"versionId": {
"type": "string",
"description": "ID of the version, starts with 'bv.'"
}
},
"description": "ID of the blueprint version"
},
"signoffConfigurationHolders": {
"type": "array",
"description": "List of the sign-off configurations with their stepId"
}
},
"description": "Optional sign-off configurations"
}
},
"definitions": {
"view1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"view2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {}
}
}
},
"step1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
},
"step2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "ID of the view"
}
}
}
}
}
}
}Delete blueprint versionDELETE/admin/blueprint/{blueprintId}/version/{versionId}
Deletes a blueprint version. All related artifacts must be deleted beforehand.
🔒 Required privileges : admin
Example URI
DELETE /admin/blueprint/bp.control/version/bv.v3
URI Parameters
- blueprintId
string(required) Example: bp.controlThe blueprint ID
- versionId
string(required) Example: bv.v3The version ID
Response
200Sign-off Configurations ¶
List sign-off configurationsGET/admin/blueprint/{blueprintId}/version/{versionId}/signoffs
Lists the sign-off configuration for a specidifc blueprint version
🔒 Required privileges : admin
Example URI
GET /admin/blueprint/bp.blueprint_a/version/bv.v1/signoffs
URI Parameters
- blueprintId
string(required) Example: bp.blueprint_aThe blueprint ID
- versionId
string(required) Example: bv.v1The version ID
Response
200Headers
Content-Type: application/jsonBody
[
{
"stepId": "step1",
"signoffConfiguration": {
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Sign-off Configuration ¶
Get sign-off configurationsGET/admin/blueprint/{blueprintId}/version/{versionId}/workflow/step/{stepId}/signoff
Get the sign-off configuration for a specific step of a blueprint version
🔒 Required privileges : admin
Example URI
GET /admin/blueprint/bp.blueprint_a/version/bv.v1/workflow/step/step1/signoff
URI Parameters
- blueprintId
string(required) Example: bp.blueprint_aThe blueprint ID
- versionId
string(required) Example: bv.v1The version ID
- stepId
string(required) Example: step1The ID of the step
Response
200Headers
Content-Type: application/jsonBody
{
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
}
}Create Sign-off configurationsPOST/admin/blueprint/{blueprintId}/version/{versionId}/workflow/step/{stepId}/signoff
Creates a sign-off configuration for a specific step of a blueprint version
🔒 Required privileges : admin
Example URI
POST /admin/blueprint/bp.blueprint_a/version/bv.v1/workflow/step/step3/signoff
URI Parameters
- blueprintId
string(required) Example: bp.blueprint_aThe blueprint ID
- versionId
string(required) Example: bv.v1The version ID
- stepId
string(required) Example: step3The ID of the step
Request
Headers
Content-Type: application/jsonBody
{
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
}
}Save sign-off configurationsPUT/admin/blueprint/{blueprintId}/version/{versionId}/workflow/step/{stepId}/signoff
Saves the sign-off configuration for a specific step of a blueprint version
🔒 Required privileges : admin
Example URI
PUT /admin/blueprint/bp.blueprint_a/version/bv.v1/workflow/step/step3/signoff
URI Parameters
- blueprintId
string(required) Example: bp.blueprint_aThe blueprint ID
- versionId
string(required) Example: bv.v1The version ID
- stepId
string(required) Example: step3The ID of the step
Request
Headers
Content-Type: application/jsonBody
{
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"title": "title",
"description": "description",
"feedbackUsersGroups": [
{
"id": "group1",
"title": "Group 1",
"users": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}
],
"approvers": [
{
"addedBy": "admin",
"addedOn": "2021-09-02T18:26:03.748+02:00",
"delegated": false,
"userContainer": {
"type": "user",
"login": "UserA"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the configuration"
},
"description": {
"type": "string",
"description": "Description of the configuration"
},
"feedbackUsersGroups": {
"type": "array",
"description": "A list of groups of users able to give feedback on this sign-off"
},
"approvers": {
"type": "array",
"description": "A list of users able to give an approval on this sign-off"
}
}
}Delete sign-off configurationDELETE/admin/blueprint/{blueprintId}/version/{versionId}/workflow/step/{stepId}/signoff
Deletes a sign-off configuration
🔒 Required privileges : admin
Example URI
DELETE /admin/blueprint/bp.blueprint_a/version/bv.v1/workflow/step/step3/signoff
URI Parameters
- blueprintId
string(required) Example: bp.blueprint_aThe blueprint ID
- versionId
string(required) Example: bv.v1The version ID
- stepId
string(required) Example: step3The ID of the step
Response
200Admin Roles & Permissions ¶
Roles ¶
List rolesGET/admin/roles
Lists the roles.
🔒 Required privileges : Admin
Example URI
GET /admin/roles
Response
200Headers
Content-Type: application/jsonBody
[
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create rolePOST/admin/roles{?newIdentifier}
Creates a new role
🔒 Required privileges : admin
Example URI
POST /admin/roles?newIdentifier=risk_compliance_reviewer
URI Parameters
- newIdentifier
string(required) Example: risk_compliance_reviewerThe new identifier of the role to be created. The new identifier has to be made of digits, letters, underscores (_), or hyphens (-)
Request
Headers
Content-Type: application/jsonBody
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the role"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the role"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the role"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the role"
},
"id": {
"type": "string",
"description": "ID of the role, starts with 'ro.'"
}
}
}Role ¶
Get roleGET/admin/role/{roleId}
Gets a specific role
🔒 Required privileges : Admin
Example URI
GET /admin/role/ro.risk_compliance_reviewer
URI Parameters
- roleId
string(required) Example: ro.risk_compliance_reviewerthe ID of the role
Response
200Headers
Content-Type: application/jsonBody
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the role"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the role"
},
"id": {
"type": "string",
"description": "ID of the role, starts with 'ro.'"
}
}
}Save rolePUT/admin/role/{roleId}
Saves a role
🔒 Required privileges : admin
Example URI
PUT /admin/role/ro.risk_compliance_reviewer
URI Parameters
- roleId
string(required) Example: ro.risk_compliance_reviewerThe role ID
Request
Headers
Content-Type: application/jsonBody
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the role"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the role"
},
"id": {
"type": "string",
"description": "ID of the role, starts with 'ro.'"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"label": "Risk & Compliance reviewer",
"description": "Can submit reviews as a Risk & Compliance expert",
"id": "ro.risk_compliance_reviewer"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the role"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the role"
},
"id": {
"type": "string",
"description": "ID of the role, starts with 'ro.'"
}
}
}Delete roleDELETE/admin/role/{roleId}
Deletes a role
🔒 Required privileges : admin
Example URI
DELETE /admin/role/ro.rolea
URI Parameters
- roleId
string(required) Example: ro.roleaThe role ID
Response
200Headers
Content-Type: application/jsonBlueprint Role Assignments items ¶
List blueprint role assignmentsGET/admin/blueprint-role-assignments
Lists the role assignments
🔒 Required privileges : Admin
Example URI
GET /admin/blueprint-role-assignments
Response
200Headers
Content-Type: application/jsonBody
[
{
"blueprintId": "bp.control",
"roleAssignmentsRules": {
"ro.it_operations_reviewer": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
],
"ro.rolea": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
]
},
"inheritBlueprintId": "bp.system.govern_project",
"inheritArtifactFieldId": "govern_project"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create blueprint role assignmentsPOST/admin/blueprint-role-assignments
Creates new role assignments for a specific blueprint.
🔒 Required privileges : admin
Example URI
POST /admin/blueprint-role-assignments
Request
Headers
Content-Type: application/jsonBody
{
"blueprintId": "bp.control",
"roleAssignmentsRules": {
"ro.it_operations_reviewer": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
],
"ro.rolea": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
]
},
"inheritBlueprintId": "bp.system.govern_project",
"inheritArtifactFieldId": "govern_project"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
},
"roleAssignmentsRules": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "A map of role assignment rules for different rules"
},
"inheritBlueprintId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from blueprint"
},
"inheritArtifactFieldId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from an existing artifact"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"blueprintId": "bp.control",
"roleAssignmentsRules": {
"ro.it_operations_reviewer": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
],
"ro.rolea": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
]
},
"inheritBlueprintId": "bp.system.govern_project",
"inheritArtifactFieldId": "govern_project"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
},
"roleAssignmentsRules": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "A map of role assignment rules for different rules"
},
"inheritBlueprintId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from blueprint"
},
"inheritArtifactFieldId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from an existing artifact"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
}
}
}Blueprint Role Assignments item ¶
Get blueprint role assignmentsGET/admin/blueprint-role-assignments/{blueprintId}
Gets role assignments for a specific blueprint
🔒 Required privileges : Admin
Example URI
GET /admin/blueprint-role-assignments/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlthe ID of the blueprint
Response
200Headers
Content-Type: application/jsonBody
{
"blueprintId": "bp.control",
"roleAssignmentsRules": {
"ro.it_operations_reviewer": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
],
"ro.rolea": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
]
},
"inheritBlueprintId": "bp.system.govern_project",
"inheritArtifactFieldId": "govern_project"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
},
"roleAssignmentsRules": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "A map of role assignment rules for different rules"
},
"inheritBlueprintId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from blueprint"
},
"inheritArtifactFieldId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from an existing artifact"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
}
}
}Save blueprint role assignmentsPUT/admin/blueprint-role-assignments/{blueprintId}
Saves the role assignments
🔒 Required privileges : admin
Example URI
PUT /admin/blueprint-role-assignments/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlThe ID of the blueprint
Request
Headers
Content-Type: application/jsonBody
{
"blueprintId": "bp.control",
"roleAssignmentsRules": {
"ro.it_operations_reviewer": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
],
"ro.rolea": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
]
},
"inheritBlueprintId": "bp.system.govern_project",
"inheritArtifactFieldId": "govern_project"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
},
"roleAssignmentsRules": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "A map of role assignment rules for different rules"
},
"inheritBlueprintId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from blueprint"
},
"inheritArtifactFieldId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from an existing artifact"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"blueprintId": "bp.control",
"roleAssignmentsRules": {
"ro.it_operations_reviewer": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
],
"ro.rolea": [
{
"criteria": [],
"userContainers": [],
"fieldIds": [
"field1"
]
}
]
},
"inheritBlueprintId": "bp.system.govern_project",
"inheritArtifactFieldId": "govern_project"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
},
"roleAssignmentsRules": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "A map of role assignment rules for different rules"
},
"inheritBlueprintId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from blueprint"
},
"inheritArtifactFieldId": {
"type": [
"string",
"null"
],
"description": "Role assignments inheritance from an existing artifact"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "array"
}
}
}
}
}Delete blueprint role assignmentsDELETE/admin/blueprint-role-assignments/{blueprintId}
Deletes the role assignments for a specific blueprint
🔒 Required privileges : admin
Example URI
DELETE /admin/blueprint-role-assignments/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlThe blueprint ID
Response
200Headers
Content-Type: application/jsonDefault permissions ¶
Get default permissionsGET/admin/blueprint-permissions/default
Gets the default permissions that apply to blueprints that do not have custom permissions.
🔒 Required privileges : Admin
Example URI
GET /admin/blueprint-permissions/default
Response
200Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Save default permissionsPUT/admin/blueprint-permissions/default
Saves the default permissions
🔒 Required privileges : admin
Example URI
PUT /admin/blueprint-permissions/default
Request
Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Blueprint permissions items ¶
List blueprint permissionsGET/admin/blueprint-permissions
Gets the list of all the blueprint permissions
🔒 Required privileges : Admin
Example URI
GET /admin/blueprint-permissions
Response
200Headers
Content-Type: application/jsonBody
[
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
},
"blueprintId": "bp.control"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create blueprint permissionsPOST/admin/blueprint-permissions
Creates the blueprint permissions for a specific blueprint
🔒 Required privileges : admin
Example URI
POST /admin/blueprint-permissions
Request
Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
},
"blueprintId": "bp.control"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
},
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
},
"blueprintId": "bp.control"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
},
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Blueprint permissions item ¶
Get blueprint permissionsGET/admin/blueprint-permissions/{blueprintId}
Gets the blueprint permissions for a specific blueprint
🔒 Required privileges : Admin
Example URI
GET /admin/blueprint-permissions/bp.system.govern_model_version
URI Parameters
- blueprintId
string(required) Example: bp.system.govern_model_versionthe ID of the blueprint
Response
200Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
},
"blueprintId": "bp.control"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
},
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Save blueprint permissionsPUT/admin/blueprint-permissions/{blueprintId}
Saves the blueprint permissions for a specific blueprint
🔒 Required privileges : admin
Example URI
PUT /admin/blueprint-permissions/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlThe ID of the blueprint
Request
Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
},
"blueprintId": "bp.control"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
},
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"everyonePermissions": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"rolePermissions": {
"ro.it_operations_reviewer": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
},
"ro.rolea": {
"artifactPermissionsItem": {
"read": false,
"write": false,
"delete": false,
"create": false
},
"fieldPermissionsItems": {
"field1": {
"read": false,
"write": false
},
"field2": {
"read": false,
"write": false
}
},
"fieldDefaultRead": false,
"fieldDefaultWrite": false
}
},
"blueprintId": "bp.control"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"everyonePermissions": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
},
"description": "Permissions that apply to everyone"
},
"rolePermissions": {
"allOf": [
{
"$ref": "#/definitions/ro.it_operations_reviewer"
},
{
"$ref": "#/definitions/ro.rolea"
}
],
"description": "Permissions that apply to specific roles"
},
"blueprintId": {
"type": "string",
"description": "ID of the blueprint"
}
},
"definitions": {
"ro.it_operations_reviewer": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
},
"field1": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"field2": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission for field"
},
"write": {
"type": "boolean",
"description": "Write permission for field"
}
}
}
}
},
"ro.rolea": {
"type": "object",
"patternProperties": {
"": {
"type": "object",
"properties": {
"artifactPermissionsItem": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"description": "Read permission"
},
"write": {
"type": "boolean",
"description": "Write permission"
},
"delete": {
"type": "boolean",
"description": "Delete permission"
},
"create": {
"type": "boolean",
"description": "Create permission"
}
},
"description": "Artifact permissions"
},
"fieldPermissionsItems": {
"allOf": [
{
"$ref": "#/definitions/field1"
},
{
"$ref": "#/definitions/field2"
}
],
"description": "Field permissions"
},
"fieldDefaultRead": {
"type": "boolean",
"description": "Default read permission for fields"
},
"fieldDefaultWrite": {
"type": "boolean",
"description": "Default write permission for fields"
}
}
}
}
}
}
}Delete blueprint permissionsDELETE/admin/blueprint-permissions/{blueprintId}
Deletes the permissions for a specific blueprint
🔒 Required privileges : admin
Example URI
DELETE /admin/blueprint-permissions/bp.control
URI Parameters
- blueprintId
string(required) Example: bp.controlThe blueprint ID
Response
200Headers
Content-Type: application/jsonAdmin Custom Pages ¶
Custom Pages ¶
List custom pagesGET/admin/custom-pages
Lists the custom pages
🔒 Required privileges : Admin
Example URI
GET /admin/custom-pages
Response
200Headers
Content-Type: application/jsonBody
[
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Create custom pagePOST/admin/custom-pages{?newIdentifier}
Creates a new custom page
🔒 Required privileges : admin
Example URI
POST /admin/custom-pages?newIdentifier=cp2
URI Parameters
- newIdentifier
string(required) Example: cp2The new identifier of the custom page. The new identifier has to be made of digits, letters or hyphens (-,)
Request
Headers
Content-Type: application/jsonBody
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"index": {
"type": "number",
"description": "Index of the tab on which the custom will be displayed"
},
"name": {
"type": "string",
"description": "Name of the custom page"
},
"icon": {
"type": "string",
"description": "Icon of the custom page"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"index": {
"type": "number",
"description": "Index of the tab on which the custom will be displayed"
},
"name": {
"type": "string",
"description": "Name of the custom page"
},
"icon": {
"type": "string",
"description": "Icon of the custom page"
},
"id": {
"type": "string",
"description": "ID of the custom page, starts with 'cp.'"
}
}
}Custom Page ¶
Get custom pageGET/admin/custom-page/{customPageId}
Gets a specific custom page
🔒 Required privileges : Admin
Example URI
GET /admin/custom-page/cp.cp1
URI Parameters
- customPageId
string(required) Example: cp.cp1the ID of the custom page
Response
200Headers
Content-Type: application/jsonBody
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"index": {
"type": "number",
"description": "Index of the tab on which the custom will be displayed"
},
"name": {
"type": "string",
"description": "Name of the custom page"
},
"icon": {
"type": "string",
"description": "Icon of the custom page"
},
"id": {
"type": "string",
"description": "ID of the custom page, starts with 'cp.'"
}
}
}Save custom pagePUT/admin/custom-page/{customPageId}
Saves a custom page
🔒 Required privileges : admin
Example URI
PUT /admin/custom-page/cp.cp2
URI Parameters
- customPageId
string(required) Example: cp.cp2The custom page ID
Request
Headers
Content-Type: application/jsonBody
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"index": {
"type": "number",
"description": "Index of the tab on which the custom will be displayed"
},
"name": {
"type": "string",
"description": "Name of the custom page"
},
"icon": {
"type": "string",
"description": "Icon of the custom page"
},
"id": {
"type": "string",
"description": "ID of the custom page, starts with 'cp.'"
}
}
}Response
200Headers
Content-Type: application/jsonBody
{
"index": 1,
"name": "Custom Page 1",
"icon": "fiber_new",
"id": "cp.cp1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"index": {
"type": "number",
"description": "Index of the tab on which the custom will be displayed"
},
"name": {
"type": "string",
"description": "Name of the custom page"
},
"icon": {
"type": "string",
"description": "Icon of the custom page"
},
"id": {
"type": "string",
"description": "ID of the custom page, starts with 'cp.'"
}
}
}Delete custom pageDELETE/admin/custom-page/{customPageId}
Deletes a custom page
🔒 Required privileges : admin
Example URI
DELETE /admin/custom-page/cp.cp2
URI Parameters
- customPageId
string(required) Example: cp.cp2The custom page ID
Response
200Headers
Content-Type: application/json