openapi: 3.0.1 info: title: Asset description: Veracity Asset 2.0 API version: '1.0' servers: - url: https://api.veracity.com/veracity/assets paths: '/api/v1/Assets/{id}': get: tags: - Assets summary: Get the asset by ID description: Get the asset by ID operationId: GetAssetById parameters: - name: id in: path description: Format - uuid. The id of the asset required: true schema: type: string responses: '200': description: Returns the asset with the specified ID. content: text/plain: schema: $ref: '#/components/schemas/AssetWorkspaceTemplateDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetWorkspaceTemplateDtoResult' example: data: id: string type: string accessRole: None workspaceId: string templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetWorkspaceTemplateDtoResult' example: data: id: string type: string accessRole: None workspaceId: string templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: An asset with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } delete: tags: - Assets summary: Delete the asset by ID description: Delete the asset by ID operationId: delete-api-v1-assets-id parameters: - name: id in: path description: Format - uuid. required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Deleted the specified asset. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user doesn't have access to delete the specified asset. content: text/plain: { } application/json: { } text/json: { } '404': description: An asset with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } patch: tags: - Assets summary: Update the asset by ID description: Update the asset by ID operationId: patch-api-v1-assets-id parameters: - name: id in: path description: Format - uuid. The ID of the Asset required: true schema: type: string requestBody: description: Asset Dto content: application/json-patch+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string text/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/*+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string responses: '200': description: Returns the updated asset content: text/plain: schema: $ref: '#/components/schemas/AssetWorkspaceTemplateDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetWorkspaceTemplateDtoResult' example: data: id: string type: string accessRole: None workspaceId: string templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetWorkspaceTemplateDtoResult' example: data: id: string type: string accessRole: None workspaceId: string templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user doesn't have the access to update the specified asset. content: text/plain: { } application/json: { } text/json: { } '404': description: An asset with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } '/api/v1/Groups/{id}': get: tags: - Groups summary: Get the group by ID description: Get the group by ID operationId: GetGroupById parameters: - name: id in: path description: Format - uuid. The group ID required: true schema: type: string responses: '200': description: Returns the group with the specified ID. content: text/plain: schema: $ref: '#/components/schemas/GroupDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/GroupDtoResult' example: data: id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/GroupDtoResult' example: data: id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A group with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } delete: tags: - Groups summary: Delete the group by ID description: Delete the group by ID operationId: delete-api-v1-groups-id parameters: - name: id in: path description: Format - uuid. The group ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Deleted the specified group. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user is not allowed to delete the specified group. content: text/plain: { } application/json: { } text/json: { } '404': description: A group with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } put: tags: - Groups summary: Update the group by ID description: Assets not specified in the request will be removed from the group. operationId: put-api-v1-groups-id parameters: - name: id in: path description: Format - uuid. The group ID required: true schema: type: string requestBody: description: The group details content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string application/json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string text/json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string application/*+json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string responses: '200': description: Ok content: text/plain: schema: $ref: '#/components/schemas/GroupDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/GroupDtoResult' example: data: id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/GroupDtoResult' example: data: id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string '207': description: Partial success content: text/plain: { } application/json: { } text/json: { } '400': description: Bad Request content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Not Found content: text/plain: { } application/json: { } text/json: { } '/api/v1/Plugins/{Id}': get: tags: - Plugins summary: Get the plugin by Id. Service principal authorized. description: Get the plugin by Id. Service principal authorized. operationId: GetPluginById parameters: - name: Id in: path description: Format - uuid. Plugin Id required: true schema: type: string responses: '200': description: 'Ok, plugin returned.' content: text/plain: schema: $ref: '#/components/schemas/PluginDto' examples: default: value: application/json: schema: $ref: '#/components/schemas/PluginDto' example: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string text/json: schema: $ref: '#/components/schemas/PluginDto' example: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Plugin with given id not found. content: text/plain: { } application/json: { } text/json: { } delete: tags: - Plugins summary: Delete the plugin. Service principal authorized. description: Delete the plugin. Service principal authorized. operationId: delete-api-v1-plugins-id parameters: - name: Id in: path description: Format - uuid. Plugin Id required: true schema: type: string responses: '200': description: Success '204': description: Deleted '401': description: Unauthorized '403': description: Forbidden '404': description: Not found. '/api/v1/Plugins/{pluginId}/subscriptions/{subscriptionId}': get: tags: - Plugins summary: Returns the given subscription for the given plugin. Service principal authorized. description: Returns the given subscription for the given plugin. Service principal authorized. operationId: GetSubscriptionById parameters: - name: pluginId in: path description: Format - uuid. Plugin Id required: true schema: type: string - name: subscriptionId in: path description: Format - uuid. Subscription Id required: true schema: type: string responses: '200': description: 'Ok, subscription returned.' content: text/plain: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionResult' example: data: id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionResult' example: data: id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: 'Not found, subscription not found.' content: text/plain: { } application/json: { } text/json: { } delete: tags: - Plugins summary: Revokes the given subscription. The workspace will no longer have access to the plugin. Service principal authorized. description: Revokes the given subscription. The workspace will no longer have access to the plugin. Service principal authorized. operationId: delete-api-v1-plugins-pluginid-subscriptions-subscriptionid parameters: - name: pluginId in: path description: Format - uuid. Plugin Id required: true schema: type: string - name: subscriptionId in: path description: Format - uuid. Subscription Id required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Success content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Subscription not found. content: text/plain: { } application/json: { } text/json: { } '/api/v1/Shares/{id}': get: tags: - Shares summary: Retrieve a share by id. description: Retrieve a share by id. operationId: GetShareById parameters: - name: id in: path description: Format - uuid. Share id required: true schema: type: string responses: '200': description: Returns the share with the specified ID. content: text/plain: schema: $ref: '#/components/schemas/ShareDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ShareDtoResult' example: data: id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ShareDtoResult' example: data: id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A share with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } delete: tags: - Shares summary: Revoke a share. The user that this asset was shared with will no longer be able to access it through this share. description: Revoke a share. The user that this asset was shared with will no longer be able to access it through this share. operationId: delete-api-v1-shares-id parameters: - name: id in: path description: Format - uuid. Share id required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Revoked the share content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check body for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user is not allowed to revoke the share. content: text/plain: { } application/json: { } text/json: { } '404': description: A share with the specified ID is not found or you don't have access to it. content: text/plain: { } application/json: { } text/json: { } patch: tags: - Shares summary: Patch share description: Patch share operationId: patch-api-v1-shares-id parameters: - name: id in: path description: Format - uuid. Share id required: true schema: type: string requestBody: description: The JSON patch document for share content: application/json-patch+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string text/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/*+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ShareDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ShareDtoResult' example: data: id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ShareDtoResult' example: data: id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string '/api/v1/Templates/{id}': get: tags: - Templates summary: Get the template by ID description: Get the template by ID operationId: GetTemplateById parameters: - name: id in: path description: Format - uuid. The template ID required: true schema: type: string responses: '200': description: Returns the template for the specified ID content: text/plain: schema: $ref: '#/components/schemas/TemplateDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A template with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } delete: tags: - Templates summary: Delete the template by ID description: Delete the template by ID operationId: delete-api-v1-templates-id parameters: - name: id in: path description: Format - uuid. The template ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Deleted the specified template content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user doesn't have access to delete the specified template. content: text/plain: { } application/json: { } text/json: { } '404': description: A template with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } patch: tags: - Templates summary: Update the template by ID description: 'By default the updateAssets parameter = true. This will update the assets based on the template changes. To manually update the assets, set this to false.' operationId: patch-api-v1-templates-id parameters: - name: id in: path description: Format - uuid. The template Id required: true schema: type: string - name: updateAssets in: query description: 'Update assets, default = true' schema: type: boolean default: true requestBody: description: Template Dto content: application/json-patch+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string text/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/*+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TemplateDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '501': description: Not implemented content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}': get: tags: - Workspaces summary: Get workspace by ID description: Get workspace by ID operationId: GetWorkspaceById parameters: - name: id in: path description: Format - uuid. The ID of the workspace required: true schema: type: string responses: '200': description: Returns the workspace with the specified ID. content: text/plain: schema: $ref: '#/components/schemas/WorkspaceDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspaceDtoResult' example: data: id: string name: string accessRole: None error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspaceDtoResult' example: data: id: string name: string accessRole: None error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } delete: tags: - Workspaces summary: Delete the workspace by ID description: Delete the workspace by ID operationId: delete-api-v1-workspaces-id parameters: - name: id in: path description: Format - uuid. The id of the workspace required: true schema: type: string responses: '200': description: Success '204': description: Deleted the workspace with the specified ID. '400': description: 'Invalid input, check the message for details.' '401': description: Unauthorized '403': description: The user is not allowed to delete the specified workspace. '404': description: A workspace with the specified ID is not found or you do not have access to it. put: tags: - Workspaces summary: Update the workspace by ID description: Update the workspace by ID operationId: put-api-v1-workspaces-id parameters: - name: id in: path description: Format - uuid. The ID of the workspace required: true schema: type: string requestBody: description: The update workspace input content: application/json-patch+json: schema: $ref: '#/components/schemas/UpdateWorkspaceInput' example: name: string application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceInput' example: name: string text/json: schema: $ref: '#/components/schemas/UpdateWorkspaceInput' example: name: string application/*+json: schema: $ref: '#/components/schemas/UpdateWorkspaceInput' example: name: string responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/WorkspaceDto' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspaceDto' example: id: string name: string accessRole: None text/json: schema: $ref: '#/components/schemas/WorkspaceDto' example: id: string name: string accessRole: None '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Not Found content: text/plain: { } application/json: { } text/json: { } /api/v1/me/Assets: get: tags: - Me summary: Get all the assets you have access to description: Get all the assets you have access to operationId: get-api-v1-me-assets parameters: - name: properties in: query description: 'Optional - Properties filter, return only specified asset properties.' schema: type: array responses: '200': description: Returns a list of assets the user has access to. content: text/plain: schema: $ref: '#/components/schemas/AssetDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetDtoIEnumerableResult' example: data: - id: string type: string accessRole: None properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetDtoIEnumerableResult' example: data: - id: string type: string accessRole: None properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '/api/v1/Groups/{id}/assets': get: tags: - Groups summary: Get the assets in the group description: Get the assets in the group operationId: get-api-v1-groups-id-assets parameters: - name: id in: path description: Format - uuid. The group ID required: true schema: type: string responses: '200': description: Returns a list of assets within the specified group. content: text/plain: schema: $ref: '#/components/schemas/AssetDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetDtoIEnumerableResult' example: data: - id: string type: string accessRole: None properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetDtoIEnumerableResult' example: data: - id: string type: string accessRole: None properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A group with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } post: tags: - Groups summary: Add assets to the group description: Add assets to the group operationId: post-api-v1-groups-id-assets parameters: - name: id in: path description: Format - uuid. The group ID required: true schema: type: string requestBody: description: The assets content: application/json-patch+json: schema: $ref: '#/components/schemas/AddAssetToGroupInput' example: assetIds: - string application/json: schema: $ref: '#/components/schemas/AddAssetToGroupInput' example: assetIds: - string text/json: schema: $ref: '#/components/schemas/AddAssetToGroupInput' example: assetIds: - string application/*+json: schema: $ref: '#/components/schemas/AddAssetToGroupInput' example: assetIds: - string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Added the specified added to the specified group. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Operation not allowed. content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, check message for details.' content: text/plain: { } application/json: { } text/json: { } '/api/v1/Groups/{groupId}/assets/{assetId}': delete: tags: - Groups summary: Remove the asset from the group description: Remove the asset from the group operationId: delete-api-v1-groups-groupid-assets-assetid parameters: - name: groupId in: path description: Format - uuid. The group ID required: true schema: type: string - name: assetId in: path description: Format - uuid. The asset ID required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Removed the specified asset from the group. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, see message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user is not allowed to remove the asset from the group. content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, see message for details.' content: text/plain: { } application/json: { } text/json: { } /api/v1/Plugins: post: tags: - Plugins summary: Registers a plugin. Service principal authorized. description: Registers a plugin. Service principal authorized. operationId: post-api-v1-plugins requestBody: description: The plugin details content: application/json-patch+json: schema: $ref: '#/components/schemas/PluginInputDto' example: name: string url: string serviceOwner: string serviceId: string isShareable: true pluginProperties: - key: string value: string application/json: schema: $ref: '#/components/schemas/PluginInputDto' example: name: string url: string serviceOwner: string serviceId: string isShareable: true pluginProperties: - key: string value: string text/json: schema: $ref: '#/components/schemas/PluginInputDto' example: name: string url: string serviceOwner: string serviceId: string isShareable: true pluginProperties: - key: string value: string application/*+json: schema: $ref: '#/components/schemas/PluginInputDto' example: name: string url: string serviceOwner: string serviceId: string isShareable: true pluginProperties: - key: string value: string responses: '200': description: 'Ok, The plugin details.' content: text/plain: schema: $ref: '#/components/schemas/PluginDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/PluginDtoResult' example: data: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/PluginDtoResult' example: data: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } get: tags: - Plugins summary: Get a list of all available plugins. Service principal authorized. description: Get a list of all available plugins. Service principal authorized. operationId: get-api-v1-plugins responses: '200': description: 'Ok, returns all the plugins.' content: text/plain: schema: $ref: '#/components/schemas/PluginDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/PluginDtoIEnumerableResult' example: data: - id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/PluginDtoIEnumerableResult' example: data: - id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '/api/v1/Plugins/{id}': patch: tags: - Plugins summary: Update a plugin. Service principal authorized. description: Update a plugin. Service principal authorized. operationId: patch-api-v1-plugins-id parameters: - name: id in: path description: Format - uuid. The plugin Id required: true schema: type: string requestBody: description: The plugin details content: application/json-patch+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string text/json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string application/*+json: schema: $ref: '#/components/schemas/OperationArray' example: - value: { } path: string op: string from: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PluginDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/PluginDtoResult' example: data: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/PluginDtoResult' example: data: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '201': description: 'Ok, The plugin details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '/api/v1/Plugins/{Id}/subscriptions': post: tags: - Plugins summary: Subscribes the workspace specified in the body to this plugin. Service principal authorized. description: Subscribes the workspace specified in the body to this plugin. Service principal authorized. operationId: post-api-v1-plugins-id-subscriptions parameters: - name: Id in: path description: Format - uuid. Plugin Id required: true schema: type: string requestBody: description: Detail of subscribe include workspaceId content: application/json-patch+json: schema: $ref: '#/components/schemas/PluginSubscribeCommand' example: workspaceId: string subscriptionProperties: - key: string value: string application/json: schema: $ref: '#/components/schemas/PluginSubscribeCommand' example: workspaceId: string subscriptionProperties: - key: string value: string text/json: schema: $ref: '#/components/schemas/PluginSubscribeCommand' example: workspaceId: string subscriptionProperties: - key: string value: string application/*+json: schema: $ref: '#/components/schemas/PluginSubscribeCommand' example: workspaceId: string subscriptionProperties: - key: string value: string responses: '200': description: 'Ok, subscription created.' content: text/plain: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionResult' example: data: id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionResult' example: data: id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Plugin not found. content: text/plain: { } application/json: { } text/json: { } '409': description: 'Conflict, check body for detailed error.' content: text/plain: { } application/json: { } text/json: { } '/api/v1/Plugins/{pluginId}/subscriptions': get: tags: - Plugins summary: Returns a list of workspace subscriptions for the given plugin. Service principal authorized. description: Returns a list of workspace subscriptions for the given plugin. Service principal authorized. operationId: get-api-v1-plugins-pluginid-subscriptions parameters: - name: pluginId in: path description: Format - uuid. Plugin Id required: true schema: type: string responses: '200': description: Ok content: text/plain: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionArrayResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionArrayResult' example: data: - id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionArrayResult' example: data: - id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Plugin not found. content: text/plain: { } application/json: { } text/json: { } /api/v1/Shares/asset: post: tags: - Shares summary: Share a single asset to a user description: Share a single asset to a user operationId: post-api-v1-shares-asset requestBody: description: Share details content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateSingleShareInput' example: assetId: string toUserId: string role: None sendNotification: true plugins: - subscriptionId: string application/json: schema: $ref: '#/components/schemas/CreateSingleShareInput' example: assetId: string toUserId: string role: None sendNotification: true plugins: - subscriptionId: string text/json: schema: $ref: '#/components/schemas/CreateSingleShareInput' example: assetId: string toUserId: string role: None sendNotification: true plugins: - subscriptionId: string application/*+json: schema: $ref: '#/components/schemas/CreateSingleShareInput' example: assetId: string toUserId: string role: None sendNotification: true plugins: - subscriptionId: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ShareDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ShareDtoResult' example: data: id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ShareDtoResult' example: data: id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string '201': description: Created content: text/plain: { } application/json: { } text/json: { } '400': description: Bad Request content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Not found content: text/plain: { } application/json: { } text/json: { } /api/v1/Shares/assets: post: tags: - Shares summary: Share an asset with a user. description: Share an asset with a user. operationId: post-api-v1-shares-assets requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateShareInput' example: assetIds: - string toUserIds: - string role: None sendNotification: true plugins: - subscriptionId: string application/json: schema: $ref: '#/components/schemas/CreateShareInput' example: assetIds: - string toUserIds: - string role: None sendNotification: true plugins: - subscriptionId: string text/json: schema: $ref: '#/components/schemas/CreateShareInput' example: assetIds: - string toUserIds: - string role: None sendNotification: true plugins: - subscriptionId: string application/*+json: schema: $ref: '#/components/schemas/CreateShareInput' example: assetIds: - string toUserIds: - string role: None sendNotification: true plugins: - subscriptionId: string responses: '200': description: Success '202': description: Accepted '400': description: 'Invalid input, check body for details.' '401': description: Unauthorized '403': description: The user is not allowed to share the specified asset. '404': description: 'Resource not found, see message for details.' /api/v1/me/Shares/byme: get: tags: - Me summary: Returns all the active access shares the user has granted. description: Returns all the active access shares the user has granted. operationId: get-api-v1-me-shares-byme responses: '200': description: Returns a list of shares by the user. content: text/plain: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' example: data: - id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' example: data: - id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } /api/v1/me/Shares/tome: get: tags: - Me summary: Returns all the active asset shares granted to the user. description: Returns all the active asset shares granted to the user. operationId: get-api-v1-me-shares-tome responses: '200': description: Returns a list of shares to the user. content: text/plain: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' example: data: - id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' example: data: - id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } /api/v1/Templates: get: tags: - Templates summary: Get all global the templates description: Get all global the templates operationId: get-api-v1-templates responses: '200': description: Returns a list with the global templates content: text/plain: schema: $ref: '#/components/schemas/TemplateDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/TemplateDtoIEnumerableResult' example: data: - id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/TemplateDtoIEnumerableResult' example: data: - id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } post: tags: - Templates summary: Create a global template description: A global template can only be created by the system. operationId: post-api-v1-templates requestBody: description: The template details content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string application/json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string text/json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string application/*+json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TemplateDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string '201': description: Created the specified template. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the body for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user is not allowed to create a global template content: text/plain: { } application/json: { } text/json: { } /api/v1/me/Templates: get: tags: - Me summary: Get all your templates and the global templates description: Get all your templates and the global templates operationId: get-api-v1-me-templates responses: '200': description: 'Returns a list with all the templates the user has access to, grouped in WorkspaceTemplates and GlobalTemplates.' content: text/plain: schema: $ref: '#/components/schemas/MyTemplatesResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/MyTemplatesResult' example: data: workspaceTemplates: - id: string name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string accessRole: None workspaceId: string globalTemplates: - id: string name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string accessRole: None workspaceId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/MyTemplatesResult' example: data: workspaceTemplates: - id: string name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string accessRole: None workspaceId: string globalTemplates: - id: string name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string accessRole: None workspaceId: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } /api/v1/Users/invite: post: tags: - Users summary: Invite user to Asset Connect description: Invite user to Asset Connect operationId: post-api-v1-users-invite requestBody: description: The user details content: application/json-patch+json: schema: $ref: '#/components/schemas/InviteUserInput' example: firstName: string lastName: string emailAddress: string application/json: schema: $ref: '#/components/schemas/InviteUserInput' example: firstName: string lastName: string emailAddress: string text/json: schema: $ref: '#/components/schemas/InviteUserInput' example: firstName: string lastName: string emailAddress: string application/*+json: schema: $ref: '#/components/schemas/InviteUserInput' example: firstName: string lastName: string emailAddress: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserCreationReferenceResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/UserCreationReferenceResult' example: data: confirmationUrl: string identity: string email: string name: string id: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/UserCreationReferenceResult' example: data: confirmationUrl: string identity: string email: string name: string id: string error: errors: { } title: string status: 0 traceId: string /api/v1/Users/details: post: tags: - Users summary: Get the details for a list of users description: Get the details for a list of users operationId: post-api-v1-users-details requestBody: description: The user ids content: application/json-patch+json: schema: $ref: '#/components/schemas/Body' example: - string application/json: schema: $ref: '#/components/schemas/Body' example: - string text/json: schema: $ref: '#/components/schemas/Body' example: - string application/*+json: schema: $ref: '#/components/schemas/Body' example: - string responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/UserDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/UserDtoIEnumerableResult' example: data: - id: string name: string email: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/UserDtoIEnumerableResult' example: data: - id: string name: string email: string error: errors: { } title: string status: 0 traceId: string '400': description: Bad Request content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{Id}/plugins': get: tags: - Workspaces summary: Returns the list of plugin subscriptions for this workspace. description: Returns the list of plugin subscriptions for this workspace. operationId: get-api-v1-workspaces-id-plugins parameters: - name: Id in: path description: Format - uuid. required: true schema: type: string responses: '200': description: 'Ok, list of subscriptions' content: text/plain: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionArrayResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionArrayResult' example: data: - id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspacePluginSubscriptionArrayResult' example: data: - id: string workspaceId: string plugin: id: string serviceId: string name: string url: string serviceOwner: string createdBy: string isShareable: true pluginProperties: - key: string value: string role: None subscriptionProperties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '404': description: Workspace not found. content: text/plain: { } application/json: { } text/json: { } '409': description: 'Conflict, check body for details.' content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/templates': get: tags: - Workspaces summary: Get the templates in the workspace description: Get the templates in the workspace operationId: get-api-v1-workspaces-id-templates parameters: - name: id in: path description: Format - uuid. The workspace Id required: true schema: type: string responses: '200': description: Returns a list with templates in the workspace the user has access to. content: text/plain: schema: $ref: '#/components/schemas/TemplateDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/TemplateDtoIEnumerableResult' example: data: - id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/TemplateDtoIEnumerableResult' example: data: - id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } post: tags: - Workspaces summary: Create a template for this workspace. description: The value of the name property on the template field will be converted to start with lower case. operationId: post-api-v1-workspaces-id-templates parameters: - name: id in: path description: Format - uuid. The ID of workspace required: true schema: type: string requestBody: description: The template content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string application/json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string text/json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string application/*+json: schema: $ref: '#/components/schemas/CreateTemplateCommandInput' example: name: string type: string templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/TemplateDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/TemplateDtoResult' example: data: id: string name: string type: string accessRole: None templateFields: - name: string label: string type: Unknown description: string required: true editable: true possibleValues: - string isHidden: false defaultValue: string error: errors: { } title: string status: 0 traceId: string '201': description: Returns the created template. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: 'Operation not allowed, see message for details.' content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/assets': get: tags: - Workspaces summary: Get the assets in the workspace description: Get the assets in the workspace operationId: get-api-v1-workspaces-id-assets parameters: - name: id in: path description: Format - uuid. The workspace id required: true schema: type: string - name: properties in: query description: 'Optional - Properties filter, return only specified asset properties.' schema: type: array responses: '200': description: Returns a list of the assets in the workspace the user has access to. content: text/plain: schema: $ref: '#/components/schemas/AssetExtDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetExtDtoIEnumerableResult' example: data: - id: string type: string accessRole: None templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetExtDtoIEnumerableResult' example: data: - id: string type: string accessRole: None templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } post: tags: - Workspaces summary: Create an asset within the workspace description: Create an asset within the workspace operationId: post-api-v1-workspaces-id-assets parameters: - name: id in: path description: Format - uuid. The ID of the workspace required: true schema: type: string requestBody: description: The details of the asset content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateAssetInput' example: templateId: string properties: - key: string value: string application/json: schema: $ref: '#/components/schemas/CreateAssetInput' example: templateId: string properties: - key: string value: string text/json: schema: $ref: '#/components/schemas/CreateAssetInput' example: templateId: string properties: - key: string value: string application/*+json: schema: $ref: '#/components/schemas/CreateAssetInput' example: templateId: string properties: - key: string value: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AssetExtDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetExtDtoResult' example: data: id: string type: string accessRole: None templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetExtDtoResult' example: data: id: string type: string accessRole: None templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '201': description: Returns the created asset. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: 'Operation not allowed, see message for details.' content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, see body for details.' content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/users': get: tags: - Workspaces summary: Get the users in a workspace description: Get the users in a workspace operationId: get-api-v1-workspaces-id-users parameters: - name: id in: path description: Format - uuid. The workspace id required: true schema: type: string responses: '200': description: Returns a list of users in the workspace. content: text/plain: schema: $ref: '#/components/schemas/UserRoleViewIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/UserRoleViewIEnumerableResult' example: data: - id: string accessRole: None error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/UserRoleViewIEnumerableResult' example: data: - id: string accessRole: None error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/groups': get: tags: - Workspaces summary: Get the groups in the workspace description: Get the groups in the workspace operationId: get-api-v1-workspaces-id-groups parameters: - name: id in: path description: Format - uuid. The workspace ID required: true schema: type: string responses: '200': description: Returns a list of groups in the workspace the user has access to. content: text/plain: schema: $ref: '#/components/schemas/GroupDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/GroupDtoIEnumerableResult' example: data: - id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/GroupDtoIEnumerableResult' example: data: - id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } post: tags: - Workspaces summary: Create a group within the workspace description: Create a group within the workspace operationId: post-api-v1-workspaces-id-groups parameters: - name: id in: path description: Format - uuid. The workspace id required: true schema: type: string requestBody: description: The group details content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string application/json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string text/json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string application/*+json: schema: $ref: '#/components/schemas/CreateGroupInput' example: name: string assetIds: - string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/GroupDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/GroupDtoResult' example: data: id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/GroupDtoResult' example: data: id: string name: string assetIds: - string error: errors: { } title: string status: 0 traceId: string '201': description: Returns the created group. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: 'Operation not allowed, see message for details.' content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, see message for details.' content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/user': post: tags: - Workspaces summary: Add user to existing workspace description: Add user to existing workspace operationId: post-api-v1-workspaces-id-user parameters: - name: id in: path description: Format - uuid. The ID of the workspace required: true schema: type: string requestBody: description: Add User To Workspace Input content: application/json-patch+json: schema: $ref: '#/components/schemas/AddUserToWorkspaceInput' example: userId: string role: None application/json: schema: $ref: '#/components/schemas/AddUserToWorkspaceInput' example: userId: string role: None text/json: schema: $ref: '#/components/schemas/AddUserToWorkspaceInput' example: userId: string role: None application/*+json: schema: $ref: '#/components/schemas/AddUserToWorkspaceInput' example: userId: string role: None responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Added user to workspace. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: 'Operation not allowed, see message for details.' content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, see message for details.' content: text/plain: { } application/json: { } text/json: { } put: tags: - Workspaces summary: Update the user role in the workspace description: Update the user role in the workspace operationId: put-api-v1-workspaces-id-user parameters: - name: id in: path description: Format - uuid. The workspace Id required: true schema: type: string requestBody: description: The user id and the new role content: application/json-patch+json: schema: $ref: '#/components/schemas/UpdateUserRoleInput' example: userId: string accessRole: None application/json: schema: $ref: '#/components/schemas/UpdateUserRoleInput' example: userId: string accessRole: None text/json: schema: $ref: '#/components/schemas/UpdateUserRoleInput' example: userId: string accessRole: None application/*+json: schema: $ref: '#/components/schemas/UpdateUserRoleInput' example: userId: string accessRole: None responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Updated the role of the specified user. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: 'Operation not allowed, see message for details.' content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, see message for details.' content: text/plain: { } application/json: { } text/json: { } /api/v1/Workspaces: post: tags: - Workspaces summary: Create a personal workspace description: Create a personal workspace operationId: post-api-v1-workspaces requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateWorkspaceInput' example: name: string application/json: schema: $ref: '#/components/schemas/CreateWorkspaceInput' example: name: string text/json: schema: $ref: '#/components/schemas/CreateWorkspaceInput' example: name: string application/*+json: schema: $ref: '#/components/schemas/CreateWorkspaceInput' example: name: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/WorkspaceDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspaceDtoResult' example: data: id: string name: string accessRole: None error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspaceDtoResult' example: data: id: string name: string accessRole: None error: errors: { } title: string status: 0 traceId: string '201': description: Returns the created workspace. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/assets/bulk': post: tags: - Workspaces summary: Create multiple assets in the workspace description: Create multiple assets in the workspace operationId: post-api-v1-workspaces-id-assets-bulk parameters: - name: id in: path description: Format - uuid. The workspace id. required: true schema: type: string requestBody: description: The create asset details. content: application/json-patch+json: schema: $ref: '#/components/schemas/CreateAssetsInput' example: templateId: string assets: - id: string properties: - key: string value: string application/json: schema: $ref: '#/components/schemas/CreateAssetsInput' example: templateId: string assets: - id: string properties: - key: string value: string text/json: schema: $ref: '#/components/schemas/CreateAssetsInput' example: templateId: string assets: - id: string properties: - key: string value: string application/*+json: schema: $ref: '#/components/schemas/CreateAssetsInput' example: templateId: string assets: - id: string properties: - key: string value: string responses: '200': description: Success '202': description: Accepted '400': description: Bad request '401': description: Unauthorized '403': description: Forbidden '404': description: Not found. '/api/v1/Workspaces/{id}/assets/validate': post: tags: - Workspaces summary: Validate assets for template in workspace description: Validate assets for template in workspace operationId: post-api-v1-workspaces-id-assets-validate parameters: - name: id in: path description: Format - uuid. The workspace id required: true schema: type: string requestBody: description: The assets to validate content: application/json-patch+json: schema: $ref: '#/components/schemas/ValidateCreateAssetInput' example: templateId: string assets: - id: string properties: - key: string value: string application/json: schema: $ref: '#/components/schemas/ValidateCreateAssetInput' example: templateId: string assets: - id: string properties: - key: string value: string text/json: schema: $ref: '#/components/schemas/ValidateCreateAssetInput' example: templateId: string assets: - id: string properties: - key: string value: string application/*+json: schema: $ref: '#/components/schemas/ValidateCreateAssetInput' example: templateId: string assets: - id: string properties: - key: string value: string responses: '200': description: OK - Assets valid content: text/plain: schema: $ref: '#/components/schemas/ValidationFailuresDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ValidationFailuresDtoIEnumerableResult' example: data: - id: string errors: - templateField: string messages: - string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ValidationFailuresDtoIEnumerableResult' example: data: - id: string errors: - templateField: string messages: - string error: errors: { } title: string status: 0 traceId: string '207': description: Validation errors content: text/plain: { } application/json: { } text/json: { } '400': description: Bad Request content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Not Found content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{workspaceId}/user/{userId}': delete: tags: - Workspaces summary: Delete user from the workspace description: Delete user from the workspace operationId: delete-api-v1-workspaces-workspaceid-user-userid parameters: - name: workspaceId in: path description: Format - uuid. The ID of the workspace required: true schema: type: string - name: userId in: path description: Format - uuid. The ID of the user required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ObjectResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ObjectResult' example: data: { } error: errors: { } title: string status: 0 traceId: string '204': description: Deleted the user with the specified ID from the specified workspace. content: text/plain: { } application/json: { } text/json: { } '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: The user is not allowed to delete the specified user from the workspace. content: text/plain: { } application/json: { } text/json: { } '404': description: 'Resource not found, see message for details.' content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{id}/shares': get: tags: - Workspaces summary: Get the shares in the workspace description: Get the shares in the workspace operationId: get-api-v1-workspaces-id-shares parameters: - name: id in: path description: Format - uuid. The workspace id required: true schema: type: string responses: '200': description: Success returns a list of shares within the workspace content: text/plain: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' example: data: - id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ShareDtoIEnumerableResult' example: data: - id: string access: None assetId: string toUserId: string createdAt: string createdBy: string plugins: - subscriptionId: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: 'Operation not allowed, see message for details.' content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{workspaceId}/assets/{assetId}/users': get: tags: - Workspaces summary: Get the users that have access to the asset description: Get the users that have access to the asset operationId: get-api-v1-workspaces-workspaceid-assets-assetid-users parameters: - name: workspaceId in: path description: Format - uuid. The workspace id required: true schema: type: string - name: assetId in: path description: Format - uuid. The asset id required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/UserRolePluginsDtoArray' examples: default: value: application/json: schema: $ref: '#/components/schemas/UserRolePluginsDtoArray' example: - userId: string accessRole: None accessType: None shareId: string plugins: - subscriptionId: string text/json: schema: $ref: '#/components/schemas/UserRolePluginsDtoArray' example: - userId: string accessRole: None accessType: None shareId: string plugins: - subscriptionId: string '400': description: Bad Request content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } '404': description: Not Found content: text/plain: { } application/json: { } text/json: { } /api/v1/me/Workspaces: get: tags: - Me summary: Get all the workspaces you have access to description: Get all the workspaces you have access to operationId: get-api-v1-me-workspaces responses: '200': description: Returns a list of workspaces the user has access to. content: text/plain: schema: $ref: '#/components/schemas/WorkspaceDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/WorkspaceDtoIEnumerableResult' example: data: - id: string name: string accessRole: None error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/WorkspaceDtoIEnumerableResult' example: data: - id: string name: string accessRole: None error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '/api/v1/Workspaces/{workspaceId}/templates/{templateId}/assets': get: tags: - Workspaces summary: Get the assets for a template in the workspace description: Get the assets for a template in the workspace operationId: get-api-v1-workspaces-workspaceid-templates-templateid-assets parameters: - name: workspaceId in: path description: Format - uuid. The workspace id required: true schema: type: string - name: templateId in: path description: Format - uuid. The template id required: true schema: type: string - name: properties in: query description: 'Optional - Properties filter, return only specified asset properties.' schema: type: array responses: '200': description: Returns a list of the assets in the workspace the user has access to. content: text/plain: schema: $ref: '#/components/schemas/AssetExtDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/AssetExtDtoIEnumerableResult' example: data: - id: string type: string accessRole: None templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/AssetExtDtoIEnumerableResult' example: data: - id: string type: string accessRole: None templateId: string properties: - key: string value: string error: errors: { } title: string status: 0 traceId: string '400': description: 'Invalid input, check the message for details.' content: text/plain: { } application/json: { } text/json: { } '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: A workspace with the specified ID is not found or you do not have access to it. content: text/plain: { } application/json: { } text/json: { } /api/v1/me/Users: get: tags: - Me summary: Returns the details of the executing user. description: Returns the details of the executing user. operationId: get-api-v1-me-users responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/UserDtoResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/UserDtoResult' example: data: id: string name: string email: string error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/UserDtoResult' example: data: id: string name: string email: string error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '404': description: Not Found content: text/plain: { } application/json: { } text/json: { } /api/v1/Management/statistics: get: tags: - Management summary: Get a management statistics for application description: Sys admin access only. operationId: get-api-v1-management-statistics responses: '200': description: 'Ok, returns list of all stats per workspace.' content: text/plain: schema: $ref: '#/components/schemas/ManagementStatisticsDtoIEnumerableResult' examples: default: value: application/json: schema: $ref: '#/components/schemas/ManagementStatisticsDtoIEnumerableResult' example: data: - workspaces: 0 assets: 0 users: 0 guests: 0 shares: 0 groups: 0 plugins: 0 templates: 0 workspaceDetails: - workspaceId: string workspaceName: string assets: 0 users: 0 guests: 0 shares: 0 groups: 0 plugins: 0 templates: 0 error: errors: { } title: string status: 0 traceId: string text/json: schema: $ref: '#/components/schemas/ManagementStatisticsDtoIEnumerableResult' example: data: - workspaces: 0 assets: 0 users: 0 guests: 0 shares: 0 groups: 0 plugins: 0 templates: 0 workspaceDetails: - workspaceId: string workspaceName: string assets: 0 users: 0 guests: 0 shares: 0 groups: 0 plugins: 0 templates: 0 error: errors: { } title: string status: 0 traceId: string '401': description: Unauthorized content: text/plain: { } application/json: { } text/json: { } '403': description: Forbidden content: text/plain: { } application/json: { } text/json: { } /health: get: tags: - Health summary: Health check description: Health check operationId: get-health responses: '200': description: Healthy content: text/plain: schema: $ref: '#/components/schemas/HealthGet200TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/HealthGet200ApplicationJsonResponse' example: status: string results: - key: string status: string text/json: schema: $ref: '#/components/schemas/HealthGet200TextJsonResponse' example: status: string results: - key: string status: string '424': description: Degraded content: text/plain: schema: $ref: '#/components/schemas/HealthGet424TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/HealthGet424ApplicationJsonResponse' example: status: string results: - key: string status: string text/json: schema: $ref: '#/components/schemas/HealthGet424TextJsonResponse' example: status: string results: - key: string status: string '503': description: Unhealthy content: text/plain: schema: $ref: '#/components/schemas/HealthGet503TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/HealthGet503ApplicationJsonResponse' example: status: string results: - key: string status: string text/json: schema: $ref: '#/components/schemas/HealthGet503TextJsonResponse' example: status: string results: - key: string status: string components: schemas: AccessRole: enum: - None - Reader - Contributor - Admin - Guest type: string AccessType: enum: - None - Workspace - Asset type: string AddAssetToGroupInput: type: object properties: assetIds: type: array items: type: string format: uuid AddUserToWorkspaceInput: required: - role - userId type: object properties: userId: type: string format: uuid role: $ref: '#/components/schemas/AccessRole' AssetDto: type: object properties: id: type: string format: uuid type: type: string accessRole: $ref: '#/components/schemas/AccessRole' properties: type: array items: $ref: '#/components/schemas/AssetPropertyDto' AssetDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/AssetDto' error: $ref: '#/components/schemas/RequestError' AssetExtDto: type: object properties: id: type: string format: uuid type: type: string accessRole: $ref: '#/components/schemas/AccessRole' templateId: type: string format: uuid properties: type: array items: $ref: '#/components/schemas/AssetPropertyDto' AssetExtDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/AssetExtDto' error: $ref: '#/components/schemas/RequestError' AssetExtDtoResult: type: object properties: data: $ref: '#/components/schemas/AssetExtDto' error: $ref: '#/components/schemas/RequestError' AssetInput: required: - properties type: object properties: id: type: string format: uuid properties: type: array items: $ref: '#/components/schemas/AssetPropertyDto' AssetPropertyDto: required: - key - value type: object properties: key: minLength: 1 type: string value: type: string AssetWorkspaceTemplateDto: type: object properties: id: type: string format: uuid type: type: string accessRole: $ref: '#/components/schemas/AccessRole' workspaceId: type: string format: uuid templateId: type: string format: uuid properties: type: array items: $ref: '#/components/schemas/AssetPropertyDto' AssetWorkspaceTemplateDtoResult: type: object properties: data: $ref: '#/components/schemas/AssetWorkspaceTemplateDto' error: $ref: '#/components/schemas/RequestError' CreateAssetInput: required: - properties - templateId type: object properties: templateId: type: string format: uuid properties: type: array items: $ref: '#/components/schemas/AssetPropertyDto' CreateAssetsInput: required: - assets - templateId type: object properties: templateId: type: string format: uuid assets: type: array items: $ref: '#/components/schemas/AssetInput' CreateGroupInput: required: - name type: object properties: name: minLength: 1 type: string assetIds: type: array items: type: string format: uuid CreateShareInput: required: - assetIds - role - toUserIds type: object properties: assetIds: type: array items: type: string format: uuid toUserIds: type: array items: type: string format: uuid role: $ref: '#/components/schemas/AccessRole' sendNotification: type: boolean plugins: type: array items: $ref: '#/components/schemas/PluginShareDto' CreateSingleShareInput: required: - assetId - role - toUserId type: object properties: assetId: type: string format: uuid toUserId: type: string format: uuid role: $ref: '#/components/schemas/AccessRole' sendNotification: type: boolean plugins: type: array items: $ref: '#/components/schemas/PluginShareDto' CreateTemplateCommandInput: required: - name - templateFields - type type: object properties: name: minLength: 1 type: string type: minLength: 1 type: string templateFields: type: array items: $ref: '#/components/schemas/TemplateFieldInput' CreateWorkspaceInput: required: - name type: object properties: name: minLength: 1 type: string GroupDto: type: object properties: id: type: string format: uuid name: type: string assetIds: type: array items: type: string format: uuid GroupDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/GroupDto' error: $ref: '#/components/schemas/RequestError' GroupDtoResult: type: object properties: data: $ref: '#/components/schemas/GroupDto' error: $ref: '#/components/schemas/RequestError' InviteUserInput: required: - emailAddress type: object properties: firstName: type: string lastName: type: string emailAddress: minLength: 1 type: string format: email ManagementStatisticsDto: type: object properties: workspaces: type: integer format: int32 assets: type: integer format: int32 users: type: integer format: int32 guests: type: integer format: int32 shares: type: integer format: int32 groups: type: integer format: int32 plugins: type: integer format: int32 templates: type: integer format: int32 workspaceDetails: type: array items: $ref: '#/components/schemas/WorkspaceStatisticsDto' ManagementStatisticsDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/ManagementStatisticsDto' error: $ref: '#/components/schemas/RequestError' MyTemplates: type: object properties: workspaceTemplates: type: array items: $ref: '#/components/schemas/TemplateWorkspaceDto' globalTemplates: type: array items: $ref: '#/components/schemas/TemplateWorkspaceDto' MyTemplatesResult: type: object properties: data: $ref: '#/components/schemas/MyTemplates' error: $ref: '#/components/schemas/RequestError' ObjectResult: type: object properties: data: { } error: $ref: '#/components/schemas/RequestError' Operation: type: object properties: value: { } path: type: string op: type: string from: type: string PluginDto: type: object properties: id: type: string format: uuid serviceId: type: string name: type: string url: type: string serviceOwner: type: string createdBy: type: string format: uuid isShareable: type: boolean default: true pluginProperties: type: array items: $ref: '#/components/schemas/PluginPropertyDto' PluginDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/PluginDto' error: $ref: '#/components/schemas/RequestError' PluginDtoResult: type: object properties: data: $ref: '#/components/schemas/PluginDto' error: $ref: '#/components/schemas/RequestError' PluginInputDto: type: object properties: name: type: string url: type: string serviceOwner: type: string serviceId: type: string isShareable: type: boolean default: true pluginProperties: type: array items: $ref: '#/components/schemas/PluginPropertyDto' PluginPropertyDto: type: object properties: key: type: string value: type: string PluginShareDto: type: object properties: subscriptionId: type: string format: uuid PluginSubscribeCommand: required: - workspaceId type: object properties: workspaceId: type: string format: uuid subscriptionProperties: type: array items: $ref: '#/components/schemas/SubscriptionPropertyDto' PropertyDataTypeDto: enum: - Unknown - String - Boolean - Integer - Double - Enum - Link type: string RequestError: type: object properties: errors: { } title: type: string status: type: integer format: int32 traceId: type: string ShareDto: type: object properties: id: type: string format: uuid access: $ref: '#/components/schemas/AccessRole' assetId: type: string format: uuid toUserId: type: string format: uuid createdAt: type: string format: date-time createdBy: type: string format: uuid plugins: type: array items: $ref: '#/components/schemas/PluginShareDto' ShareDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/ShareDto' error: $ref: '#/components/schemas/RequestError' ShareDtoResult: type: object properties: data: $ref: '#/components/schemas/ShareDto' error: $ref: '#/components/schemas/RequestError' SubscriptionPropertyDto: required: - key - value type: object properties: key: minLength: 1 type: string value: minLength: 1 type: string TemplateDto: type: object properties: id: type: string format: uuid name: type: string type: type: string accessRole: $ref: '#/components/schemas/AccessRole' templateFields: type: array items: $ref: '#/components/schemas/TemplateFieldInput' TemplateDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/TemplateDto' error: $ref: '#/components/schemas/RequestError' TemplateDtoResult: type: object properties: data: $ref: '#/components/schemas/TemplateDto' error: $ref: '#/components/schemas/RequestError' TemplateFieldInput: required: - description - editable - label - name - required - type type: object properties: name: minLength: 1 type: string label: minLength: 1 type: string type: $ref: '#/components/schemas/PropertyDataTypeDto' description: type: string required: type: boolean editable: type: boolean possibleValues: type: array items: type: string isHidden: type: boolean default: false defaultValue: type: string TemplateWorkspaceDto: type: object properties: id: type: string format: uuid name: type: string type: type: string templateFields: type: array items: $ref: '#/components/schemas/TemplateFieldInput' accessRole: $ref: '#/components/schemas/AccessRole' workspaceId: type: string format: uuid UpdateUserRoleInput: required: - accessRole - userId type: object properties: userId: type: string format: uuid accessRole: $ref: '#/components/schemas/AccessRole' UpdateWorkspaceInput: required: - name type: object properties: name: minLength: 2 type: string UserCreationReference: type: object properties: confirmationUrl: type: string identity: type: string email: type: string name: type: string id: type: string UserCreationReferenceResult: type: object properties: data: $ref: '#/components/schemas/UserCreationReference' error: $ref: '#/components/schemas/RequestError' UserDto: type: object properties: id: type: string format: uuid name: type: string email: type: string UserDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/UserDto' error: $ref: '#/components/schemas/RequestError' UserDtoResult: type: object properties: data: $ref: '#/components/schemas/UserDto' error: $ref: '#/components/schemas/RequestError' UserRolePluginsDto: type: object properties: userId: type: string format: uuid accessRole: $ref: '#/components/schemas/AccessRole' accessType: $ref: '#/components/schemas/AccessType' shareId: type: string format: uuid plugins: type: array items: $ref: '#/components/schemas/PluginShareDto' UserRoleView: type: object properties: id: type: string format: uuid accessRole: $ref: '#/components/schemas/AccessRole' UserRoleViewIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/UserRoleView' error: $ref: '#/components/schemas/RequestError' ValidateCreateAssetInput: required: - assets - templateId type: object properties: templateId: type: string format: uuid assets: type: array items: $ref: '#/components/schemas/AssetInput' ValidationErrorDto: type: object properties: templateField: type: string messages: type: array items: type: string ValidationFailuresDto: type: object properties: id: type: string format: uuid errors: type: array items: $ref: '#/components/schemas/ValidationErrorDto' ValidationFailuresDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/ValidationFailuresDto' error: $ref: '#/components/schemas/RequestError' WorkspaceDto: type: object properties: id: type: string format: uuid name: type: string accessRole: $ref: '#/components/schemas/AccessRole' WorkspaceDtoIEnumerableResult: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkspaceDto' error: $ref: '#/components/schemas/RequestError' WorkspaceDtoResult: type: object properties: data: $ref: '#/components/schemas/WorkspaceDto' error: $ref: '#/components/schemas/RequestError' WorkspacePluginSubscription: type: object properties: id: type: string format: uuid workspaceId: type: string format: uuid plugin: $ref: '#/components/schemas/PluginDto' role: $ref: '#/components/schemas/AccessRole' subscriptionProperties: type: array items: $ref: '#/components/schemas/SubscriptionPropertyDto' WorkspacePluginSubscriptionArrayResult: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkspacePluginSubscription' error: $ref: '#/components/schemas/RequestError' WorkspacePluginSubscriptionResult: type: object properties: data: $ref: '#/components/schemas/WorkspacePluginSubscription' error: $ref: '#/components/schemas/RequestError' WorkspaceStatisticsDto: type: object properties: workspaceId: type: string format: uuid workspaceName: type: string assets: type: integer format: int32 users: type: integer format: int32 guests: type: integer format: int32 shares: type: integer format: int32 groups: type: integer format: int32 plugins: type: integer format: int32 templates: type: integer format: int32 OperationArray: type: array items: $ref: '#/components/schemas/Operation' Body: type: array items: type: string format: uuid UserRolePluginsDtoArray: type: array items: $ref: '#/components/schemas/UserRolePluginsDto' HealthGet200TextPlainResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet200ApplicationJsonResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet200TextJsonResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet424TextPlainResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet424ApplicationJsonResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet424TextJsonResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet503TextPlainResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet503ApplicationJsonResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string HealthGet503TextJsonResponse: type: object properties: status: type: string results: type: array items: properties: key: type: string status: type: string securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query oauth2b2c-prod-oauth---v2-endpoint: type: oauth2 flows: authorizationCode: authorizationUrl: https://login.veracity.com/dnvglb2cprod.onmicrosoft.com/oauth2/v2.0/authorize?p=B2C_1A_SignInWithADFSIdp tokenUrl: https://login.veracity.com/dnvglb2cprod.onmicrosoft.com/oauth2/v2.0/token?p=B2C_1A_SignInWithADFSIdp scopes: https://dnvglb2cprod.onmicrosoft.com/83054ebf-1d7b-43f5-82ad-b2bde84d7b75/user_impersonation: https://dnvglb2cprod.onmicrosoft.com/83054ebf-1d7b-43f5-82ad-b2bde84d7b75/user_impersonation security: - apiKeyHeader: [ ] oauth2b2c-prod-oauth---v2-endpoint: - https://dnvglb2cprod.onmicrosoft.com/83054ebf-1d7b-43f5-82ad-b2bde84d7b75/user_impersonation - apiKeyQuery: [ ] oauth2b2c-prod-oauth---v2-endpoint: - https://dnvglb2cprod.onmicrosoft.com/83054ebf-1d7b-43f5-82ad-b2bde84d7b75/user_impersonation