Skip to content

Instantly share code, notes, and snippets.

@sisimomo
Created August 11, 2025 21:41
Show Gist options
  • Select an option

  • Save sisimomo/22dbf889bbf0543b264e42b3c9b27fba to your computer and use it in GitHub Desktop.

Select an option

Save sisimomo/22dbf889bbf0543b264e42b3c9b27fba to your computer and use it in GitHub Desktop.
API Documentation
{
"components": {
"schemas": {
"AndFilterRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/FilterRequestDto"
}
],
"description": "Combine multiple filters using `and` boolean logic",
"properties": {
"filters": {
"items": {
"$ref": "#/components/schemas/FilterRequestDto"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"filters"
],
"type": "object"
},
"BetweenOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field value by specifying a range",
"properties": {
"filter": {
"$ref": "#/components/schemas/IntervalRequestDtoObject"
}
},
"required": [
"filter"
],
"type": "object"
},
"BooleanList": {
"items": {
"type": "boolean"
},
"type": "array"
},
"CaseFolderResponseDto": {
"properties": {
"caseId": {
"$ref": "#/components/schemas/UUID"
},
"folderId": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"caseId",
"folderId"
],
"type": "object"
},
"CasePageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/CaseResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"CaseResponseDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"contacts": {
"items": {
"$ref": "#/components/schemas/ContactCaseDto"
},
"type": "array",
"uniqueItems": true
},
"createdAt": {
"$ref": "#/components/schemas/Instant"
},
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"linkedCaseId": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"responsibles": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"status": {
"$ref": "#/components/schemas/UUID"
},
"updatedAt": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"id",
"entitySubtypeId",
"code",
"name",
"status",
"createdAt",
"updatedAt",
"contacts",
"responsibles"
],
"type": "object"
},
"CaseVaultConfigResponseDto": {
"properties": {
"administrativeUnitId": {
"pattern": "\\S",
"type": "string"
},
"caseSchemaCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"administrativeUnitId",
"caseSchemaCode"
],
"type": "object"
},
"ContactCaseDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"oneOf": [
{
"$ref": "#/components/schemas/LegalPersonContactCaseDto"
},
{
"$ref": "#/components/schemas/PhysicalPersonContactCaseDto"
}
],
"properties": {},
"type": "object"
},
"ContainsAllOfOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field value to contain all of the provided values",
"properties": {
"filter": {
"$ref": "#/components/schemas/ListOperatorFilterValueRequestDto"
}
},
"type": "object"
},
"ContainsAnyOfOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field value to contain any of the provided values",
"properties": {
"filter": {
"$ref": "#/components/schemas/ListOperatorFilterValueRequestDto"
}
},
"type": "object"
},
"ContainsTextOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field value to contain the provided string",
"properties": {
"filter": {
"minLength": 1,
"type": "string"
}
},
"required": [
"filter"
],
"type": "object"
},
"CreateCaseRequestDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"contacts": {
"items": {
"$ref": "#/components/schemas/ContactCaseDto"
},
"type": "array",
"uniqueItems": true
},
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"linkedCaseId": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"responsibles": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"status": {
"$ref": "#/components/schemas/UUID"
}
},
"required": [
"entitySubtypeId",
"name",
"status",
"contacts",
"responsibles"
],
"type": "object"
},
"CreateCaseVaultConfigRequestDto": {
"properties": {
"administrativeUnitId": {
"pattern": "\\S",
"type": "string"
},
"caseSchemaCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"administrativeUnitId",
"caseSchemaCode"
],
"type": "object"
},
"CreateDomainRequestDto": {
"properties": {
"description": {
"type": "string"
},
"name": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"CreateDomainValueRequestDto": {
"discriminator": {
"propertyName": "code"
},
"oneOf": [
{
"$ref": "#/components/schemas/CreateUserDomainValueRequestDto"
},
{
"$ref": "#/components/schemas/CreateSystemDomainValueRequestDto"
}
],
"properties": {
"translations": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"translations"
],
"type": "object"
},
"CreateEntitySubtypeRequestDto": {
"properties": {
"description": {
"type": "string"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EntityTypeDto"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"CreateFolderRequestDto": {
"properties": {
"name": {
"pattern": "\\S",
"type": "string"
},
"parentId": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"parentId",
"name"
],
"type": "object"
},
"CreateLegalPersonRequestDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"legalName": {
"type": "string"
},
"linkedContactIds": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"entitySubtypeId",
"legalName"
],
"type": "object"
},
"CreatePhysicalPersonRequestDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"firstname": {
"pattern": "\\S",
"type": "string"
},
"lastname": {
"pattern": "\\S",
"type": "string"
},
"linkedContactIds": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"entitySubtypeId",
"firstname",
"lastname"
],
"type": "object"
},
"CreatePhysicalPersonVaultConfigRequestDto": {
"properties": {
"administrativeUnitId": {
"pattern": "\\S",
"type": "string"
},
"physicalPersonSchemaCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"administrativeUnitId",
"physicalPersonSchemaCode"
],
"type": "object"
},
"CreateProjectRequestDto": {
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"CreateProjectVaultConfigRequestDto": {
"properties": {
"collectionCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"collectionCode"
],
"type": "object"
},
"CreateSystemDomainValueRequestDto": {
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"translations": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"translations",
"code"
],
"type": "object"
},
"CreateTaskRequestDto": {
"properties": {
"assignee": {
"type": "string"
},
"caseId": {
"$ref": "#/components/schemas/UUID"
},
"description": {
"type": "string"
},
"dueDate": {
"$ref": "#/components/schemas/Instant"
},
"fileIds": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"folderIds": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"formKey": {
"type": "string"
},
"groupCandidates": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"name": {
"pattern": "\\S",
"type": "string"
},
"parentTaskId": {
"type": "string"
},
"startDate": {
"$ref": "#/components/schemas/Instant"
},
"userCandidates": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"name"
],
"type": "object"
},
"CreateTenantVaultConfigRequestDto": {
"properties": {
"accessToken": {
"pattern": "\\S",
"type": "string"
},
"url": {
"pattern": "^(https?://.+)/$",
"type": "string"
}
},
"required": [
"url",
"accessToken"
],
"type": "object"
},
"CreateUserDomainValueRequestDto": {
"properties": {
"translations": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"translations"
],
"type": "object"
},
"CreateWebhookRequestDto": {
"properties": {
"description": {
"type": "string"
},
"eventTypes": {
"items": {
"$ref": "#/components/schemas/WebhookEventTypeDto"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"name": {
"pattern": "\\S",
"type": "string"
},
"url": {
"pattern": "",
"type": "string"
}
},
"required": [
"name",
"url",
"eventTypes"
],
"type": "object"
},
"DateList": {
"items": {
"$ref": "#/components/schemas/LocalDate"
},
"type": "array"
},
"DateTimeList": {
"items": {
"$ref": "#/components/schemas/Instant"
},
"type": "array"
},
"DecimalList": {
"items": {
"type": "number"
},
"type": "array"
},
"DomainPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/DomainResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"DomainResponseDto": {
"oneOf": [
{
"$ref": "#/components/schemas/UserDomainResponseDto"
},
{
"$ref": "#/components/schemas/SystemDomainResponseDto"
}
],
"properties": {
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"DomainValuePageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/DomainValueResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"DomainValueResponseDto": {
"properties": {
"active": {
"type": "boolean"
},
"code": {
"type": "string"
},
"domain": {
"$ref": "#/components/schemas/SummaryResponseDto"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"orderIndex": {
"format": "int32",
"type": "integer"
},
"translations": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"id",
"active",
"translations",
"domain",
"orderIndex"
],
"type": "object"
},
"EndsWithOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field value to end with the provided string",
"properties": {
"filter": {
"minLength": 1,
"type": "string"
}
},
"required": [
"filter"
],
"type": "object"
},
"EntitySchemaDraftResponseDto": {
"properties": {
"createdAt": {
"$ref": "#/components/schemas/Instant"
},
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"schema": {
"$ref": "#/components/schemas/JsonNode"
},
"schemaType": {
"$ref": "#/components/schemas/SchemaTypeDto"
},
"updatedAt": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"entitySubtypeId",
"schemaType",
"createdAt",
"updatedAt",
"schema"
],
"type": "object"
},
"EntitySchemaResponseDto": {
"properties": {
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"schema": {
"$ref": "#/components/schemas/JsonNode"
},
"schemaType": {
"$ref": "#/components/schemas/SchemaTypeDto"
},
"versionFrom": {
"$ref": "#/components/schemas/Instant"
},
"versionTo": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"entitySubtypeId",
"schemaType",
"versionFrom",
"schema"
],
"type": "object"
},
"EntitySubtypePageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/EntitySubtypeResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"EntitySubtypeResponseDto": {
"properties": {
"createdAt": {
"$ref": "#/components/schemas/Instant"
},
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"isPublished": {
"type": "boolean"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EntityTypeDto"
},
"updatedAt": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"id",
"type",
"name",
"createdAt",
"updatedAt",
"isPublished"
],
"type": "object"
},
"EntityTypeDto": {
"enum": [
"LegalPerson",
"PhysicalPerson",
"Case"
],
"type": "string"
},
"EqualityOperatorFilterValueRequestDto": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/BooleanList"
},
{
"$ref": "#/components/schemas/LocalDate"
},
{
"$ref": "#/components/schemas/DateList"
},
{
"$ref": "#/components/schemas/Instant"
},
{
"$ref": "#/components/schemas/DateTimeList"
},
{
"type": "number"
},
{
"$ref": "#/components/schemas/DecimalList"
},
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/IntegerList"
},
{
"type": "string"
},
{
"$ref": "#/components/schemas/StringList"
},
{
"$ref": "#/components/schemas/UUID"
},
{
"$ref": "#/components/schemas/UuidList"
}
],
"type": "object"
},
"EqualityOperatorFilterValueRequestDto1": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/BooleanList"
},
{
"$ref": "#/components/schemas/LocalDate"
},
{
"$ref": "#/components/schemas/DateList"
},
{
"$ref": "#/components/schemas/Instant"
},
{
"$ref": "#/components/schemas/DateTimeList"
},
{
"type": "number"
},
{
"$ref": "#/components/schemas/DecimalList"
},
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/IntegerList"
},
{
"type": "string"
},
{
"$ref": "#/components/schemas/StringList"
},
{
"$ref": "#/components/schemas/UUID"
},
{
"$ref": "#/components/schemas/UuidList"
}
],
"type": "object"
},
"EqualsOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field by its value",
"properties": {
"filter": {
"$ref": "#/components/schemas/EqualityOperatorFilterValueRequestDto"
}
},
"required": [
"filter"
],
"type": "object"
},
"FileContentInfoResponseDto": {
"properties": {
"mimeType": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
}
},
"required": [
"mimeType",
"size"
],
"type": "object"
},
"FileResponseDto": {
"allOf": [
{
"$ref": "#/components/schemas/VaultItemResponseDto"
}
],
"properties": {
"contentInfo": {
"$ref": "#/components/schemas/FileContentInfoResponseDto"
}
},
"type": "object"
},
"FilterRequestDto": {
"oneOf": [
{
"$ref": "#/components/schemas/AndFilterRequestDto"
},
{
"$ref": "#/components/schemas/NotFilterRequestDto"
},
{
"$ref": "#/components/schemas/OrFilterRequestDto"
},
{
"$ref": "#/components/schemas/BetweenOperatorRequestDto"
},
{
"$ref": "#/components/schemas/ContainsAllOfOperatorRequestDto"
},
{
"$ref": "#/components/schemas/ContainsAnyOfOperatorRequestDto"
},
{
"$ref": "#/components/schemas/ContainsTextOperatorRequestDto"
},
{
"$ref": "#/components/schemas/EndsWithOperatorRequestDto"
},
{
"$ref": "#/components/schemas/EqualsOperatorRequestDto"
},
{
"$ref": "#/components/schemas/GreaterThanOperatorRequestDto"
},
{
"$ref": "#/components/schemas/IsEmptyOperatorRequestDto"
},
{
"$ref": "#/components/schemas/IsNullOperatorRequestDto"
},
{
"$ref": "#/components/schemas/LessThanOperatorRequestDto"
},
{
"$ref": "#/components/schemas/StartsWithOperatorRequestDto"
}
],
"properties": {
"type": {
"$ref": "#/components/schemas/FilterTypeRequestDto"
}
},
"required": [
"type",
"type"
],
"type": "object"
},
"FilterTypeRequestDto": {
"enum": [
"and",
"not",
"or",
"between",
"containsAnyOf",
"containsAllOf",
"containsText",
"endsWith",
"equals",
"greaterThan",
"isEmpty",
"isNull",
"lessThan",
"startsWith"
],
"type": "string"
},
"FolderResponseDto": {
"allOf": [
{
"$ref": "#/components/schemas/VaultItemResponseDto"
}
],
"type": "object"
},
"GetFolderChildrenRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"searchTerm": {
"type": "string"
}
},
"type": "object"
},
"GreaterThanOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field for values greater than a specified threshold",
"properties": {
"filter": {
"$ref": "#/components/schemas/RangeOperatorFilterValueRequestDto"
}
},
"required": [
"filter"
],
"type": "object"
},
"GroupPageResponseDto": {
"description": "Paginated list of groups",
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/GroupResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"GroupResponseDto": {
"description": "Group information",
"properties": {
"id": {
"$ref": "#/components/schemas/UUID",
"description": "Unique identifier of the group",
"type": "string"
},
"name": {
"description": "Name of the group",
"pattern": "\\S",
"type": "string"
},
"path": {
"description": "Path of the group",
"pattern": "\\S",
"type": "string"
}
},
"required": [
"id",
"name",
"path"
],
"type": "object"
},
"HttpProblem": {
"additionalProperties": true,
"description": "HTTP Problem Response according to RFC9457 and RFC7807",
"properties": {
"detail": {
"description": "A optional human-readable explanation specific to this occurrence of the problem",
"examples": [
"Record not found"
],
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"examples": [
"https://api.example.com/errors/123"
],
"format": "uri",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"examples": [
404
],
"format": "int32",
"type": "integer"
},
"title": {
"description": "A optional, short, human-readable summary of the problem type",
"examples": [
"Not Found"
],
"type": "string"
},
"type": {
"description": "A optional URI reference that identifies the problem type",
"examples": [
"https://example.com/errors/not-found"
],
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"HttpValidationProblem": {
"additionalProperties": true,
"description": "HTTP Validation Problem Response according to RFC9457 and RFC7807",
"properties": {
"detail": {
"description": "A optional human-readable explanation specific to this occurrence of the problem",
"examples": [
"Record not found"
],
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"examples": [
"https://api.example.com/errors/123"
],
"format": "uri",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"examples": [
404
],
"format": "int32",
"type": "integer"
},
"title": {
"description": "A optional, short, human-readable summary of the problem type",
"examples": [
"Not Found"
],
"type": "string"
},
"type": {
"description": "A optional URI reference that identifies the problem type",
"examples": [
"https://example.com/errors/not-found"
],
"format": "uri",
"type": "string"
},
"violations": {
"description": "List of validation constraint violations that occurred",
"items": {
"$ref": "#/components/schemas/Violation"
},
"type": "array"
}
},
"type": "object"
},
"Instant": {
"examples": [
"2022-03-10T16:15:50.000Z"
],
"format": "date-time",
"type": "string"
},
"IntegerList": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"IntervalRequestDto": {
"description": "Filter a specific field by specifying a minimum and/or maximum value",
"properties": {
"max": {
"$ref": "#/components/schemas/RangeOperatorFilterValueRequestDto"
},
"message": {
"type": "string"
},
"min": {
"$ref": "#/components/schemas/RangeOperatorFilterValueRequestDto"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"IntervalRequestDtoObject": {
"description": "Filter a specific field by specifying a minimum and/or maximum value",
"properties": {
"max": {
"$ref": "#/components/schemas/RangeOperatorFilterValueRequestDto"
},
"message": {
"type": "string"
},
"min": {
"$ref": "#/components/schemas/RangeOperatorFilterValueRequestDto"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"IsEmptyOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field if its value is empty",
"properties": {
"filter": {
"type": "object"
}
},
"type": "object"
},
"IsNullOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field if its value is null",
"properties": {
"filter": {
"type": "object"
}
},
"type": "object"
},
"JsonNode": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"items": {},
"type": "array"
},
{
"type": "object"
}
]
},
"LegalPersonContactCaseDto": {
"allOf": [
{
"$ref": "#/components/schemas/ContactCaseDto"
}
],
"properties": {
"legalPersonId": {
"$ref": "#/components/schemas/UUID"
}
},
"required": [
"legalPersonId"
],
"type": "object"
},
"LegalPersonPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/LegalPersonResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"LegalPersonResponseDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"createdAt": {
"$ref": "#/components/schemas/Instant"
},
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"legalName": {
"pattern": "\\S",
"type": "string"
},
"linkedContactIds": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"versionFrom": {
"$ref": "#/components/schemas/Instant"
},
"versionTo": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"id",
"entitySubtypeId",
"versionFrom",
"legalName",
"linkedContactIds"
],
"type": "object"
},
"LessThanOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field for values less than a specified threshold",
"properties": {
"filter": {
"$ref": "#/components/schemas/RangeOperatorFilterValueRequestDto"
}
},
"required": [
"filter"
],
"type": "object"
},
"ListOperatorFilterValueRequestDto": {
"oneOf": [
{
"$ref": "#/components/schemas/BooleanList"
},
{
"$ref": "#/components/schemas/DateList"
},
{
"$ref": "#/components/schemas/DateTimeList"
},
{
"$ref": "#/components/schemas/DecimalList"
},
{
"$ref": "#/components/schemas/IntegerList"
},
{
"$ref": "#/components/schemas/StringList"
},
{
"$ref": "#/components/schemas/UuidList"
}
],
"type": "object"
},
"ListOperatorFilterValueRequestDto1": {
"oneOf": [
{
"$ref": "#/components/schemas/BooleanList"
},
{
"$ref": "#/components/schemas/DateList"
},
{
"$ref": "#/components/schemas/DateTimeList"
},
{
"$ref": "#/components/schemas/DecimalList"
},
{
"$ref": "#/components/schemas/IntegerList"
},
{
"$ref": "#/components/schemas/StringList"
},
{
"$ref": "#/components/schemas/UuidList"
}
],
"type": "object"
},
"LocalDate": {
"examples": [
"2022-03-10T00:00:00.000Z"
],
"format": "date",
"type": "string"
},
"NotFilterRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/FilterRequestDto"
}
],
"description": "Invert the provided filter",
"properties": {
"filter": {
"$ref": "#/components/schemas/FilterRequestDto"
}
},
"required": [
"filter"
],
"type": "object"
},
"OperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/FilterRequestDto"
}
],
"properties": {
"fieldCode": {
"description": "The field code on which to apply the filter",
"pattern": "\\S",
"type": "string"
},
"filter": {}
},
"required": [
"fieldCode"
],
"type": "object"
},
"OrFilterRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/FilterRequestDto"
}
],
"description": "Combine multiple filters using `or` boolean logic",
"properties": {
"filters": {
"items": {
"$ref": "#/components/schemas/FilterRequestDto"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"filters"
],
"type": "object"
},
"PhysicalPersonContactCaseDto": {
"allOf": [
{
"$ref": "#/components/schemas/ContactCaseDto"
}
],
"properties": {
"physicalPersonId": {
"$ref": "#/components/schemas/UUID"
}
},
"required": [
"physicalPersonId"
],
"type": "object"
},
"PhysicalPersonFolderResponseDto": {
"properties": {
"folderId": {
"pattern": "\\S",
"type": "string"
},
"physicalPersonId": {
"$ref": "#/components/schemas/UUID"
}
},
"required": [
"physicalPersonId",
"folderId"
],
"type": "object"
},
"PhysicalPersonPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/PhysicalPersonResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"PhysicalPersonResponseDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"createdAt": {
"$ref": "#/components/schemas/Instant"
},
"entitySubtypeId": {
"$ref": "#/components/schemas/UUID"
},
"firstname": {
"pattern": "\\S",
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"lastname": {
"pattern": "\\S",
"type": "string"
},
"linkedContactIds": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"versionFrom": {
"$ref": "#/components/schemas/Instant"
},
"versionTo": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"id",
"entitySubtypeId",
"versionFrom",
"firstname",
"lastname",
"createdAt",
"linkedContactIds"
],
"type": "object"
},
"PhysicalPersonVaultConfigResponseDto": {
"properties": {
"administrativeUnitId": {
"pattern": "\\S",
"type": "string"
},
"physicalPersonSchemaCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"administrativeUnitId",
"physicalPersonSchemaCode"
],
"type": "object"
},
"ProjectPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/ProjectResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"ProjectPermissionGroupResponseDto": {
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"descriptionEn": {
"pattern": "\\S",
"type": "string"
},
"descriptionFr": {
"pattern": "\\S",
"type": "string"
},
"nameEn": {
"pattern": "\\S",
"type": "string"
},
"nameFr": {
"pattern": "\\S",
"type": "string"
},
"permissionSlugs": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"code",
"nameFr",
"nameEn",
"descriptionFr",
"descriptionEn",
"permissionSlugs"
],
"type": "object"
},
"ProjectResponseDto": {
"properties": {
"id": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"ProjectVaultConfigResponseDto": {
"properties": {
"collectionCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"collectionCode"
],
"type": "object"
},
"RangeOperatorFilterValueRequestDto": {
"oneOf": [
{
"$ref": "#/components/schemas/LocalDate"
},
{
"$ref": "#/components/schemas/Instant"
},
{
"type": "number"
},
{
"format": "int64",
"type": "integer"
}
],
"type": "object"
},
"RangeOperatorFilterValueRequestDto1": {
"oneOf": [
{
"$ref": "#/components/schemas/LocalDate"
},
{
"$ref": "#/components/schemas/Instant"
},
{
"type": "number"
},
{
"format": "int64",
"type": "integer"
}
],
"type": "object"
},
"ReorderDomainValuesRequestDto": {
"properties": {
"newOrder": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"newOrder"
],
"type": "object"
},
"SaveEntitySchemaDraftRequestDto": {
"properties": {
"schema": {
"$ref": "#/components/schemas/JsonNode"
}
},
"required": [
"schema"
],
"type": "object"
},
"SchemaTypeDto": {
"enum": [
"Create",
"Update",
"Read"
],
"type": "string"
},
"SearchDomainRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"SearchDomainValueRequestDto": {
"properties": {
"active": {
"type": "boolean"
},
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"SearchEntitySubtypeRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/EntityTypeDto"
}
},
"required": [
"type"
],
"type": "object"
},
"SearchGroupRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"searchTerm": {
"type": "string"
}
},
"type": "object"
},
"SearchProjectRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"SearchRequestDto": {
"properties": {
"filter": {
"$ref": "#/components/schemas/FilterRequestDto",
"description": "The filter used to refine search results",
"type": "object"
},
"pageIndex": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"default": 25,
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"sorting": {
"description": "The sorting used to order search results",
"items": {
"$ref": "#/components/schemas/SearchSortingRequestDto"
},
"type": "array"
}
},
"type": "object"
},
"SearchSortingRequestDto": {
"properties": {
"ascending": {
"default": true,
"description": "The direction of the sort",
"type": "boolean"
},
"fieldCode": {
"description": "The field code on which to apply the sort",
"pattern": "\\S",
"type": "string"
}
},
"required": [
"fieldCode",
"ascending"
],
"type": "object"
},
"SearchUserRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"searchTerm": {
"type": "string"
}
},
"type": "object"
},
"SearchVaultItemsRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"searchTerm": {
"type": "string"
}
},
"type": "object"
},
"SearchWebhookRequestDto": {
"properties": {
"pageIndex": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"pageSize": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"StartsWithOperatorRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/OperatorRequestDto"
}
],
"description": "Filter a specific field value to start with the provided string",
"properties": {
"filter": {
"minLength": 1,
"type": "string"
}
},
"required": [
"filter"
],
"type": "object"
},
"StringList": {
"items": {
"type": "string"
},
"type": "array"
},
"SummaryResponseDto": {
"properties": {
"id": {
"$ref": "#/components/schemas/UUID"
},
"subtitle": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"title": {
"pattern": "\\S",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SummaryTypeResponseDto"
}
},
"required": [
"title",
"id",
"type"
],
"type": "object"
},
"SummaryTypeResponseDto": {
"enum": [
"LegalPerson",
"PhysicalPerson",
"Case",
"Domain",
"DomainValue"
],
"type": "string"
},
"SystemDomainCodeResponseDto": {
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"descriptions": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
},
"names": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"code",
"names",
"descriptions"
],
"type": "object"
},
"SystemDomainResponseDto": {
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"id",
"name",
"code"
],
"type": "object"
},
"SystemDomainValueCodeResponseDto": {
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"descriptions": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
},
"names": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"minProperties": 1,
"type": "object"
},
"systemDomainCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"code",
"systemDomainCode",
"names",
"descriptions"
],
"type": "object"
},
"TaskResponseDto": {
"properties": {
"assignee": {
"type": "string"
},
"caseId": {
"$ref": "#/components/schemas/UUID"
},
"creationDate": {
"$ref": "#/components/schemas/Instant"
},
"description": {
"type": "string"
},
"dueDate": {
"$ref": "#/components/schemas/Instant"
},
"fileIds": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"folderIds": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"formKey": {
"type": "string"
},
"formValues": {
"additionalProperties": {},
"type": "object"
},
"groupCandidates": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"id": {
"pattern": "\\S",
"type": "string"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"owner": {
"pattern": "\\S",
"type": "string"
},
"parentTaskId": {
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"startDate": {
"$ref": "#/components/schemas/Instant"
},
"status": {
"type": "string"
},
"userCandidates": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"id",
"name",
"owner",
"creationDate"
],
"type": "object"
},
"TenantPermissionGroupResponseDto": {
"properties": {
"code": {
"pattern": "\\S",
"type": "string"
},
"descriptionEn": {
"pattern": "\\S",
"type": "string"
},
"descriptionFr": {
"pattern": "\\S",
"type": "string"
},
"nameEn": {
"pattern": "\\S",
"type": "string"
},
"nameFr": {
"pattern": "\\S",
"type": "string"
},
"permissionSlugs": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"code",
"nameFr",
"nameEn",
"descriptionFr",
"descriptionEn",
"permissionSlugs"
],
"type": "object"
},
"TenantResponseDto": {
"properties": {
"address": {
"pattern": "\\S",
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"mainContact": {
"pattern": "\\S",
"type": "string"
},
"name": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"id",
"name",
"address",
"mainContact"
],
"type": "object"
},
"TenantVaultConfigResponseDto": {
"properties": {
"url": {
"pattern": "^(https?://.+)/$",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"UUID": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"UpdateCaseRequestDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"contacts": {
"items": {
"$ref": "#/components/schemas/ContactCaseDto"
},
"type": "array",
"uniqueItems": true
},
"linkedCaseId": {
"allOf": [
{
"$ref": "#/components/schemas/UUID"
}
],
"type": "null"
},
"name": {
"type": "string"
},
"responsibles": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/UUID"
}
],
"type": "null"
}
},
"type": "object"
},
"UpdateCaseVaultConfigRequestDto": {
"properties": {
"administrativeUnitId": {
"type": "string"
},
"caseSchemaCode": {
"type": "string"
}
},
"type": "object"
},
"UpdateDomainRequestDto": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"UpdateDomainValueRequestDto": {
"properties": {
"active": {
"type": "boolean"
},
"translations": {
"additionalProperties": {
"pattern": "\\S",
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"UpdateEntitySubtypeRequestDto": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"UpdateFileRequestDto": {
"properties": {
"name": {
"type": "string"
},
"parentId": {
"type": "string"
}
},
"type": "object"
},
"UpdateFolderRequestDto": {
"properties": {
"name": {
"type": "string"
},
"parentId": {
"type": "string"
}
},
"type": "object"
},
"UpdateLegalPersonRequestDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"legalName": {
"type": "string"
},
"linkedContactIds": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"UpdatePhysicalPersonRequestDto": {
"additionalProperties": {
"examples": [
"object"
],
"type": "string"
},
"properties": {
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"linkedContactIds": {
"items": {
"format": "uuid",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"UpdatePhysicalPersonVaultConfigRequestDto": {
"properties": {
"administrativeUnitId": {
"type": "string"
},
"physicalPersonSchemaCode": {
"type": "string"
}
},
"type": "object"
},
"UpdateProjectVaultConfigRequestDto": {
"properties": {
"collectionCode": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"collectionCode"
],
"type": "object"
},
"UpdateTaskRequestDto": {
"properties": {
"assignee": {
"type": "string"
},
"caseId": {
"allOf": [
{
"$ref": "#/components/schemas/UUID"
}
],
"type": "null"
},
"description": {
"type": "string"
},
"dueDate": {
"allOf": [
{
"$ref": "#/components/schemas/Instant"
}
],
"type": "null"
},
"fileIds": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"folderIds": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"formKey": {
"type": "string"
},
"groupCandidates": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
},
"parentTaskId": {
"type": "string"
},
"startDate": {
"allOf": [
{
"$ref": "#/components/schemas/Instant"
}
],
"type": "null"
},
"userCandidates": {
"items": {
"pattern": "\\S",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"UpdateTenantRequestDto": {
"properties": {
"address": {
"type": "string"
},
"mainContact": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"UpdateTenantVaultConfigRequestDto": {
"properties": {
"accessToken": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"UpdateWebhookRequestDto": {
"properties": {
"description": {
"type": "string"
},
"eventTypes": {
"items": {
"$ref": "#/components/schemas/WebhookEventTypeDto"
},
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"UserDomainResponseDto": {
"properties": {
"description": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"UserPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/UserResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"UserResponseDto": {
"properties": {
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"firstName": {
"type": "string"
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"lastName": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"enabled"
],
"type": "object"
},
"UuidList": {
"items": {
"$ref": "#/components/schemas/UUID"
},
"type": "array"
},
"VaultItemPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/VaultItemResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"VaultItemResponseDto": {
"discriminator": {
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/FileResponseDto"
},
{
"$ref": "#/components/schemas/FolderResponseDto"
}
],
"properties": {
"createdAt": {
"$ref": "#/components/schemas/Instant"
},
"id": {
"pattern": "\\S",
"type": "string"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"parentId": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/VaultItemTypeDto"
},
"updatedAt": {
"$ref": "#/components/schemas/Instant"
}
},
"required": [
"type",
"id",
"name",
"createdAt",
"updatedAt"
],
"type": "object"
},
"VaultItemTypeDto": {
"enum": [
"file",
"folder"
],
"type": "string"
},
"Violation": {
"description": "Validation constraint violation details",
"properties": {
"field": {
"description": "The field for which the validation failed",
"examples": [
"#/profile/email"
],
"type": "string"
},
"in": {
"description": "Part of the http request where the validation error occurred such as query, path, header, form, body",
"examples": [
"query",
"path",
"header",
"form",
"body"
],
"type": "string"
},
"message": {
"description": "Description of the validation error",
"examples": [
"Invalid email format"
],
"type": "string"
}
},
"type": "object"
},
"WebhookEventTypeDto": {
"enum": [
"Case_created",
"Case_updated",
"Case_deleted",
"LegalPerson_created",
"LegalPerson_updated",
"LegalPerson_deleted",
"PhysicalPerson_created",
"PhysicalPerson_updated",
"PhysicalPerson_deleted"
],
"type": "string"
},
"WebhookPageResponseDto": {
"properties": {
"currentPageIndex": {
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/WebhookResponseDto"
},
"type": "array"
},
"numberOfItems": {
"format": "int64",
"type": "integer"
},
"numberOfPages": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"required": [
"data",
"numberOfItems",
"currentPageIndex",
"pageSize",
"numberOfPages"
],
"type": "object"
},
"WebhookResponseDto": {
"properties": {
"description": {
"type": "string"
},
"eventTypes": {
"items": {
"$ref": "#/components/schemas/WebhookEventTypeDto"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"id": {
"$ref": "#/components/schemas/UUID"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"url": {
"pattern": "",
"type": "string"
}
},
"required": [
"id",
"name",
"url",
"eventTypes"
],
"type": "object"
}
}
},
"info": {
"title": "API",
"version": "0.1"
},
"openapi": "3.1.0",
"paths": {
"/api/v0/groups/search": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchGroupRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for groups",
"tags": [
"Groups"
]
}
},
"/api/v0/groups/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific group by its ID",
"tags": [
"Groups"
]
}
},
"/api/v0/project-permission-groups/{code}": {
"get": {
"parameters": [
{
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPermissionGroupResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific project permission group by its code",
"tags": [
"Project Permission Groups"
]
}
},
"/api/v0/projects": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new project",
"tags": [
"Projects"
]
}
},
"/api/v0/projects/search": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchProjectRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for Projects",
"tags": [
"Projects"
]
}
},
"/api/v0/projects/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a project by its ID",
"tags": [
"Projects"
]
}
},
"/api/v0/projects/{projectId}/cases": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCaseRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new case",
"tags": [
"Cases"
]
}
},
"/api/v0/projects/{projectId}/cases/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CasePageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for cases",
"tags": [
"Cases"
]
}
},
"/api/v0/projects/{projectId}/cases/vault/config": {
"delete": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Delete the project Cases Vault Config",
"tags": [
"Cases Vault Config"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Get the project Cases Vault Config",
"tags": [
"Cases Vault Config"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCaseVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update the project Cases Vault Config",
"tags": [
"Cases Vault Config"
]
},
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCaseVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseVaultConfigResponseDto"
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Create the project Cases Vault Config",
"tags": [
"Cases Vault Config"
]
}
},
"/api/v0/projects/{projectId}/cases/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Deletes a case",
"tags": [
"Cases"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific case by its ID",
"tags": [
"Cases"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCaseRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific case specified by its ID",
"tags": [
"Cases"
]
}
},
"/api/v0/projects/{projectId}/cases/{id}/vault/folder": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseFolderResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific case folder by its case ID",
"tags": [
"Cases Vault"
]
}
},
"/api/v0/projects/{projectId}/domains": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDomainRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new domain",
"tags": [
"Domain"
]
}
},
"/api/v0/projects/{projectId}/domains/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchDomainRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for domains",
"tags": [
"Domain"
]
}
},
"/api/v0/projects/{projectId}/domains/values/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainValueResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific domain value by its ID",
"tags": [
"Domain Value"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainValueRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainValueResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific value specified by its ID",
"tags": [
"Domain Value"
]
}
},
"/api/v0/projects/{projectId}/domains/{domainId}/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "domainId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchDomainValueRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainValuePageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for domain values",
"tags": [
"Domain Value"
]
}
},
"/api/v0/projects/{projectId}/domains/{domainId}/values": {
"post": {
"parameters": [
{
"in": "path",
"name": "domainId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDomainValueRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainValueResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new domain value",
"tags": [
"Domain Value"
]
}
},
"/api/v0/projects/{projectId}/domains/{domainId}/values/reorder": {
"put": {
"parameters": [
{
"in": "path",
"name": "domainId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReorderDomainValuesRequestDto"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Reorder domain values of a specific domain",
"tags": [
"Domain Value"
]
}
},
"/api/v0/projects/{projectId}/domains/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific domain by its ID or Code",
"tags": [
"Domain"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific domain specified by its ID",
"tags": [
"Domain"
]
}
},
"/api/v0/projects/{projectId}/entity-subtypes": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEntitySubtypeRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySubtypeResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new entity subtypes",
"tags": [
"Entity Subtypes"
]
}
},
"/api/v0/projects/{projectId}/entity-subtypes/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchEntitySubtypeRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySubtypePageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for entity subtypes",
"tags": [
"Entity Subtypes"
]
}
},
"/api/v0/projects/{projectId}/entity-subtypes/{entitySubtypeId}/entity-schema-drafts/{schemaType}": {
"get": {
"parameters": [
{
"in": "path",
"name": "entitySubtypeId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "schemaType",
"required": true,
"schema": {
"$ref": "#/components/schemas/SchemaTypeDto"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySchemaDraftResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific entity schema draft by its entity subtype id and schema type",
"tags": [
"Entity Schema Drafts"
]
},
"post": {
"parameters": [
{
"in": "path",
"name": "entitySubtypeId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "schemaType",
"required": true,
"schema": {
"$ref": "#/components/schemas/SchemaTypeDto"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveEntitySchemaDraftRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySchemaDraftResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates/Updates a entity schema draft",
"tags": [
"Entity Schema Drafts"
]
}
},
"/api/v0/projects/{projectId}/entity-subtypes/{entitySubtypeId}/entity-schemas/deploy": {
"post": {
"parameters": [
{
"in": "path",
"name": "entitySubtypeId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Deploy draft schemas for a specific entity subtype",
"tags": [
"Entity Schemas"
]
}
},
"/api/v0/projects/{projectId}/entity-subtypes/{entitySubtypeId}/entity-schemas/{schemaType}": {
"get": {
"parameters": [
{
"in": "path",
"name": "entitySubtypeId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "schemaType",
"required": true,
"schema": {
"$ref": "#/components/schemas/SchemaTypeDto"
}
},
{
"in": "query",
"name": "version",
"schema": {
"$ref": "#/components/schemas/Instant"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySchemaResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific entity schema by its entity subtype id and schema type",
"tags": [
"Entity Schemas"
]
}
},
"/api/v0/projects/{projectId}/entity-subtypes/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySubtypeResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific entity subtype by its ID",
"tags": [
"Entity Subtypes"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEntitySubtypeRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitySubtypeResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific entitySubtype specified by its ID",
"tags": [
"Entity Subtypes"
]
}
},
"/api/v0/projects/{projectId}/legal-persons": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLegalPersonRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalPersonResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new legal person",
"tags": [
"Legal persons"
]
}
},
"/api/v0/projects/{projectId}/legal-persons/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalPersonPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for Legal Persons",
"tags": [
"Legal persons"
]
}
},
"/api/v0/projects/{projectId}/legal-persons/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Delete Legal person",
"tags": [
"Legal persons"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "query",
"name": "version",
"schema": {
"$ref": "#/components/schemas/Instant"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalPersonResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific legal person by its ID",
"tags": [
"Legal persons"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLegalPersonRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalPersonResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific legal person specified by its ID",
"tags": [
"Legal persons"
]
}
},
"/api/v0/projects/{projectId}/legal-persons/{id}/linked-to-contacts": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "query",
"name": "pageIndex",
"required": true,
"schema": {
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SummaryResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of Contact summaries that are linked to a specific legal person",
"tags": [
"Legal persons"
]
}
},
"/api/v0/projects/{projectId}/legal-persons/{id}/versions": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "query",
"name": "pageIndex",
"schema": {
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalPersonPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a paginated list of all versions of a specific legal person",
"tags": [
"Legal persons"
]
}
},
"/api/v0/projects/{projectId}/physical-persons": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePhysicalPersonRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new physical person",
"tags": [
"Physical persons"
]
}
},
"/api/v0/projects/{projectId}/physical-persons/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for Physical Persons",
"tags": [
"Physical persons"
]
}
},
"/api/v0/projects/{projectId}/physical-persons/vault/config": {
"delete": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Delete the project Physical Persons Vault Config",
"tags": [
"Physical Person Vault Config"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Get the project Physical Persons Vault Config",
"tags": [
"Physical Person Vault Config"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePhysicalPersonVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update the project Physical Person Vault Config",
"tags": [
"Physical Person Vault Config"
]
},
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePhysicalPersonVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonVaultConfigResponseDto"
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Create the project Physical Persons Vault Config",
"tags": [
"Physical Person Vault Config"
]
}
},
"/api/v0/projects/{projectId}/physical-persons/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Delete physical person",
"tags": [
"Physical persons"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "query",
"name": "version",
"schema": {
"$ref": "#/components/schemas/Instant"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific physical person by its ID",
"tags": [
"Physical persons"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePhysicalPersonRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific physical person specified by its ID",
"tags": [
"Physical persons"
]
}
},
"/api/v0/projects/{projectId}/physical-persons/{id}/linked-to-contacts": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "query",
"name": "pageIndex",
"required": true,
"schema": {
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SummaryResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of Contact summaries that are linked to a specific physical person",
"tags": [
"Physical persons"
]
}
},
"/api/v0/projects/{projectId}/physical-persons/{id}/vault/folder": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonFolderResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific case folder by its case ID",
"tags": [
"Physical Person Vault"
]
}
},
"/api/v0/projects/{projectId}/physical-persons/{id}/versions": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "query",
"name": "pageIndex",
"schema": {
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhysicalPersonPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a paginated list of all versions of a specific physical person",
"tags": [
"Physical persons"
]
}
},
"/api/v0/projects/{projectId}/tasks": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaskRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new task",
"tags": [
"Tasks"
]
}
},
"/api/v0/projects/{projectId}/tasks/{id}": {
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaskRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific task specified by its ID",
"tags": [
"Tasks"
]
}
},
"/api/v0/projects/{projectId}/vault/config": {
"delete": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Delete the Project Vault Config",
"tags": [
"Project Vault Config"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Get the Project Vault Config",
"tags": [
"Project Vault Config"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update the Project Vault Config",
"tags": [
"Project Vault Config"
]
},
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectVaultConfigResponseDto"
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Create the Project Vault Config",
"tags": [
"Project Vault Config"
]
}
},
"/api/v0/projects/{projectId}/vault/files": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"file": {
"format": "binary",
"type": "string"
},
"name": {
"pattern": "\\S",
"type": "string"
},
"parentId": {
"pattern": "\\S",
"type": "string"
}
},
"required": [
"file",
"parentId",
"name"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new file",
"tags": [
"Files"
]
}
},
"/api/v0/projects/{projectId}/vault/files/recents": {
"get": {
"parameters": [
{
"in": "query",
"name": "pageSize",
"schema": {
"format": "int32",
"maximum": 25,
"minimum": 1,
"type": "integer"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FileResponseDto"
},
"type": "array"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves the recent files",
"tags": [
"Files"
]
}
},
"/api/v0/projects/{projectId}/vault/files/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Deletes a file",
"tags": [
"Files"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific file by its ID",
"tags": [
"Files"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFileRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific file specified by its ID",
"tags": [
"Files"
]
}
},
"/api/v0/projects/{projectId}/vault/files/{id}/content": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves the content of a file by its ID",
"tags": [
"Files"
]
}
},
"/api/v0/projects/{projectId}/vault/folders": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new folder",
"tags": [
"Folders"
]
}
},
"/api/v0/projects/{projectId}/vault/folders/recents": {
"get": {
"parameters": [
{
"in": "query",
"name": "pageSize",
"schema": {
"format": "int32",
"maximum": 25,
"minimum": 1,
"type": "integer"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FolderResponseDto"
},
"type": "array"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves recent folders",
"tags": [
"Folders"
]
}
},
"/api/v0/projects/{projectId}/vault/folders/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Deletes a folder",
"tags": [
"Folders"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific folder by its ID",
"tags": [
"Folders"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific folder specified by its ID",
"tags": [
"Folders"
]
}
},
"/api/v0/projects/{projectId}/vault/folders/{id}/children": {
"post": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFolderChildrenRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VaultItemPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves the children of a specific folder by its ID",
"tags": [
"Folders"
]
}
},
"/api/v0/projects/{projectId}/vault/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchVaultItemsRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VaultItemPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for vault items",
"tags": [
"Vault Item"
]
}
},
"/api/v0/projects/{projectId}/webhooks": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponseDto"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Creates a new webhook",
"tags": [
"Webhooks"
]
}
},
"/api/v0/projects/{projectId}/webhooks/search": {
"post": {
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchWebhookRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for webhooks",
"tags": [
"Webhooks"
]
}
},
"/api/v0/projects/{projectId}/webhooks/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Deletes a webhook",
"tags": [
"Webhooks"
]
},
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific webhook by its ID",
"tags": [
"Webhooks"
]
},
"patch": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWebhookRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update a specific webhook specified by its ID",
"tags": [
"Webhooks"
]
}
},
"/api/v0/system-domain-codes": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemDomainCodeResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves all System Domain Codes",
"tags": [
"System Domain Code"
]
}
},
"/api/v0/system-domain-codes/values/{code}": {
"get": {
"parameters": [
{
"in": "path",
"name": "code",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemDomainValueCodeResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific System Domain Value Code by its code",
"tags": [
"System Domain Value Code"
]
}
},
"/api/v0/system-domain-codes/{code}": {
"get": {
"parameters": [
{
"in": "path",
"name": "code",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemDomainCodeResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific System Domain Code by its code",
"tags": [
"System Domain Code"
]
}
},
"/api/v0/system-domain-codes/{systemDomainCode}/values": {
"get": {
"parameters": [
{
"in": "path",
"name": "systemDomainCode",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemDomainValueCodeResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves all System Domain Value Codes for a specific System Domain Code",
"tags": [
"System Domain Value Code"
]
}
},
"/api/v0/tenant-permission-groups/{code}": {
"get": {
"parameters": [
{
"in": "path",
"name": "code",
"required": true,
"schema": {
"pattern": "\\S",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantPermissionGroupResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific tenant permission group by its code",
"tags": [
"Tenant Permission Groups"
]
}
},
"/api/v0/tenants/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific Tenant by its ID",
"tags": [
"Tenants"
]
},
"patch": {
"description": "Update a specific tenant by its ID",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTenantRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update Tenant",
"tags": [
"Tenants"
]
}
},
"/api/v0/users/me": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves the current logged-in user",
"tags": [
"Users"
]
}
},
"/api/v0/users/search": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchUserRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPageResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieve a paginated list of search results for users",
"tags": [
"Users"
]
}
},
"/api/v0/users/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Retrieves a specific user by its ID",
"tags": [
"Users"
]
}
},
"/api/v0/vault/config": {
"delete": {
"responses": {
"204": {
"description": "Success No Content"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Delete the Tenant Vault Config",
"tags": [
"Tenant Vault Config"
]
},
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Get the Tenant Vault Config",
"tags": [
"Tenant Vault Config"
]
},
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTenantVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantVaultConfigResponseDto"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Update the Tenant Vault Config",
"tags": [
"Tenant Vault Config"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTenantVaultConfigRequestDto"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantVaultConfigResponseDto"
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpProblem"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"SecurityScheme": []
}
],
"summary": "Create the Tenant Vault Config",
"tags": [
"Tenant Vault Config"
]
}
}
},
"tags": [
{
"name": "Cases"
},
{
"name": "Cases Vault"
},
{
"name": "Cases Vault Config"
},
{
"name": "Domain"
},
{
"name": "Domain Value"
},
{
"name": "Entity Schema Drafts"
},
{
"name": "Entity Schemas"
},
{
"name": "Entity Subtypes"
},
{
"name": "Files"
},
{
"name": "Folders"
},
{
"name": "Groups"
},
{
"name": "Legal persons"
},
{
"name": "Physical Person Vault"
},
{
"name": "Physical Person Vault Config"
},
{
"name": "Physical persons"
},
{
"name": "Project Permission Groups"
},
{
"name": "Project Vault Config"
},
{
"name": "Projects"
},
{
"name": "System Domain Code"
},
{
"name": "System Domain Value Code"
},
{
"name": "Tasks"
},
{
"name": "Tenant Permission Groups"
},
{
"name": "Tenant Vault Config"
},
{
"name": "Tenants"
},
{
"name": "Users"
},
{
"name": "Vault Item"
},
{
"name": "Webhooks"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment