# Entities

## Get file

> Returns file

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/ipfs/{cid}":{"get":{"description":"Returns file","operationId":"EntityApi_loadFile","parameters":[{"name":"cid","required":true,"in":"path","description":"CID","schema":{"type":"string"}}],"responses":{"200":{"description":"File","content":{"application/json":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get file","tags":["entities"]}}},"components":{"schemas":{"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get standard registries

> Returns standard registries

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/registries":{"get":{"description":"Returns standard registries","operationId":"EntityApi_getRegistries","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Global topic identifier","schema":{"type":"string"}},{"name":"options.did","required":false,"in":"query","description":"Registry did","schema":{"type":"string"}},{"name":"options.registrantTopicId","required":false,"in":"query","description":"Registry user topic identifier","schema":{"type":"string"}},{"name":"options.attributes.OrganizationName","required":false,"in":"query","description":"Registry organization name","schema":{"type":"string"}}],"responses":{"200":{"description":"Registries","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegistryDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get standard registries","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"RegistryDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/RegistryOptionsDTO"},"analytics":{"$ref":"#/components/schemas/RegistryAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"RegistryOptionsDTO":{"type":"object","properties":{"did":{"type":"string","description":"DID"},"registrantTopicId":{"type":"string","description":"Registrant topic id"},"lang":{"type":"string","description":"Lang"},"attributes":{"type":"object","description":"Attributes"}},"required":["did","registrantTopicId","lang","attributes"]},"RegistryAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get registry

> Returns registry

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/registries/{messageId}":{"get":{"description":"Returns registry","operationId":"EntityApi_getRegistry","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Registry details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get registry","tags":["entities"]}}},"components":{"schemas":{"RegistryDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/RegistryDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/RegistryActivityDTO"}},"required":["id","uuid","item","row","activity"]},"RegistryDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/RegistryOptionsDTO"},"analytics":{"$ref":"#/components/schemas/RegistryAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"RegistryOptionsDTO":{"type":"object","properties":{"did":{"type":"string","description":"DID"},"registrantTopicId":{"type":"string","description":"Registrant topic id"},"lang":{"type":"string","description":"Lang"},"attributes":{"type":"object","description":"Attributes"}},"required":["did","registrantTopicId","lang","attributes"]},"RegistryAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"RegistryActivityDTO":{"type":"object","properties":{"vcs":{"type":"number","description":"VCs"},"vps":{"type":"number","description":"VPs"},"policies":{"type":"number","description":"Policies"},"roles":{"type":"number","description":"Roles"},"tools":{"type":"number","description":"Tools"},"modules":{"type":"number","description":"Modules"},"tokens":{"type":"number","description":"Tokens"},"users":{"type":"number","description":"Registry users"},"contracts":{"type":"number","description":"Contracts"}},"required":["vcs","vps","policies","roles","tools","modules","tokens","users","contracts"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get registry relationships

> Returns registry relationships

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/registries/{messageId}/relationships":{"get":{"description":"Returns registry relationships","operationId":"EntityApi_getRegistriesRelationships","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Registry relationships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get registry relationships","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get registry users

> Returns registry users

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/registry-users":{"get":{"description":"Returns registry users","operationId":"EntityApi_getRegistryUsers","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"User topic identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Registry users","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegistryUserGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get registry users","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"RegistryUserGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/RegistryUserOptionsDTO"},"analytics":{"$ref":"#/components/schemas/RegistryUserAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"RegistryUserOptionsDTO":{"type":"object","properties":{"did":{"type":"string","description":"DID"}},"required":["did"]},"RegistryUserAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get registry user

> Returns registry user

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/registry-users/{messageId}":{"get":{"description":"Returns registry user","operationId":"EntityApi_getRegistryUser","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Registry user details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryUserDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get registry user","tags":["entities"]}}},"components":{"schemas":{"RegistryUserDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/RegistryUserDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/RegistryUserActivityDTO"}},"required":["id","uuid","item","row","activity"]},"RegistryUserDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/RegistryUserOptionsDTO"},"analytics":{"$ref":"#/components/schemas/RegistryUserAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"RegistryUserOptionsDTO":{"type":"object","properties":{"did":{"type":"string","description":"DID"}},"required":["did"]},"RegistryUserAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"RegistryUserActivityDTO":{"type":"object","properties":{"vcs":{"type":"number","description":"VCs"},"vps":{"type":"number","description":"VPs"},"roles":{"type":"number","description":"Roles"}},"required":["vcs","vps","roles"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get policies

> Returns policies

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/policies":{"get":{"description":"Returns policies","operationId":"EntityApi_getPolicies","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Policy topic identifier","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Policy owner","schema":{"type":"string"}},{"name":"analytics.tools","required":false,"in":"query","description":"Tool","schema":{"type":"string"}}],"responses":{"200":{"description":"Policies","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PolicyDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get policies","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/PolicyOptionsDTO"},"analytics":{"$ref":"#/components/schemas/PolicyAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"PolicyOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"topicDescription":{"type":"string","description":"Topic description"},"version":{"type":"string","description":"Version"},"policyTag":{"type":"string","description":"Policy tag"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"instanceTopicId":{"type":"string","description":"Policy instance topic identifier"},"synchronizationTopicId":{"type":"string","description":"Synchronization topic identifier"},"commentsTopicId":{"type":"string","description":"Comments topic identifier"},"discontinuedDate":{"type":"string","description":"Discontinued date"}},"required":["uuid","name","description","topicDescription","version","policyTag","owner","policyTopicId","instanceTopicId","synchronizationTopicId","commentsTopicId","discontinuedDate"]},"PolicyAnalyticsDTO":{"type":"object","properties":{"owner":{"type":"string","description":"Owner"},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"vcCount":{"type":"number","description":"VC count"},"vpCount":{"type":"number","description":"VP count"},"tokensCount":{"type":"number","description":"Tokens count"},"tags":{"description":"Tags","type":"array","items":{"type":"string"}},"hash":{"type":"string","description":"Hash"},"hashMap":{"type":"object","description":"Hash map","additionalProperties":true},"tools":{"description":"Tools","type":"array","items":{"type":"string"}},"registryId":{"type":"string","description":"Registry identifier"},"textSearch":{"type":"string","description":"Text search"}},"required":["owner","tokens","vcCount","vpCount","tokensCount","tags","hash","hashMap","tools","registryId","textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get policy

> Returns policy

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/policies/{messageId}":{"get":{"description":"Returns policy","operationId":"EntityApi_getPolicy","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Policy details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get policy","tags":["entities"]}}},"components":{"schemas":{"PolicyDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/PolicyDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/PolicyActivityDTO"}},"required":["id","uuid","item","row","activity"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/PolicyOptionsDTO"},"analytics":{"$ref":"#/components/schemas/PolicyAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"PolicyOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"topicDescription":{"type":"string","description":"Topic description"},"version":{"type":"string","description":"Version"},"policyTag":{"type":"string","description":"Policy tag"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"instanceTopicId":{"type":"string","description":"Policy instance topic identifier"},"synchronizationTopicId":{"type":"string","description":"Synchronization topic identifier"},"commentsTopicId":{"type":"string","description":"Comments topic identifier"},"discontinuedDate":{"type":"string","description":"Discontinued date"}},"required":["uuid","name","description","topicDescription","version","policyTag","owner","policyTopicId","instanceTopicId","synchronizationTopicId","commentsTopicId","discontinuedDate"]},"PolicyAnalyticsDTO":{"type":"object","properties":{"owner":{"type":"string","description":"Owner"},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"vcCount":{"type":"number","description":"VC count"},"vpCount":{"type":"number","description":"VP count"},"tokensCount":{"type":"number","description":"Tokens count"},"tags":{"description":"Tags","type":"array","items":{"type":"string"}},"hash":{"type":"string","description":"Hash"},"hashMap":{"type":"object","description":"Hash map","additionalProperties":true},"tools":{"description":"Tools","type":"array","items":{"type":"string"}},"registryId":{"type":"string","description":"Registry identifier"},"textSearch":{"type":"string","description":"Text search"}},"required":["owner","tokens","vcCount","vpCount","tokensCount","tags","hash","hashMap","tools","registryId","textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"PolicyActivityDTO":{"type":"object","properties":{"schemas":{"type":"number","description":"Schemas"},"schemaPackages":{"type":"number","description":"Schemas Packages"},"vcs":{"type":"number","description":"VCs"},"vps":{"type":"number","description":"VPs"},"roles":{"type":"number","description":"Roles"},"formulas":{"type":"number","description":"Formulas"}},"required":["schemas","schemaPackages","vcs","vps","roles","formulas"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get policy relationships

> Returns policy relationships

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/policies/{messageId}/relationships":{"get":{"description":"Returns policy relationships","operationId":"EntityApi_getPolicyRelationships","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Policy relationships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get policy relationships","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get tools

> Returns tools

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/tools":{"get":{"description":"Returns tools","operationId":"EntityApi_getTools","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Tool owner","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Tools","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ToolDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get tools","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"ToolDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/ToolOptionsDTO"},"analytics":{"$ref":"#/components/schemas/ToolAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"ToolOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"hash":{"type":"string","description":"Hash"},"toolTopicId":{"type":"string","description":"Tool topic identifier"},"tagsTopicId":{"type":"string","description":"Tags topic identifier"}},"required":["uuid","name","description","owner","hash","toolTopicId","tagsTopicId"]},"ToolAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get tool

> Returns tool

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/tools/{messageId}":{"get":{"description":"Returns tool","operationId":"EntityApi_getTool","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Tool details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get tool","tags":["entities"]}}},"components":{"schemas":{"ToolDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/ToolDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/ToolActivityDTO"}},"required":["id","uuid","item","row","activity"]},"ToolDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/ToolOptionsDTO"},"analytics":{"$ref":"#/components/schemas/ToolAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"ToolOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"hash":{"type":"string","description":"Hash"},"toolTopicId":{"type":"string","description":"Tool topic identifier"},"tagsTopicId":{"type":"string","description":"Tags topic identifier"}},"required":["uuid","name","description","owner","hash","toolTopicId","tagsTopicId"]},"ToolAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"ToolActivityDTO":{"type":"object","properties":{"schemas":{"type":"number","description":"Schemas"},"policies":{"type":"number","description":"Policies"}},"required":["schemas","policies"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get modules

> Returns modules

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/modules":{"get":{"description":"Returns modules","operationId":"EntityApi_getModules","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Module owner","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Modules","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ModuleDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get modules","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/ModuleOptionsDTO"},"analytics":{"$ref":"#/components/schemas/ModuleAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"ModuleOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"moduleTopicId":{"type":"string","description":"Module topic identifier"}},"required":["uuid","name","description","owner","moduleTopicId"]},"ModuleAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get module

> Returns module

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/modules/{messageId}":{"get":{"description":"Returns module","operationId":"EntityApi_getModule","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Module details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get module","tags":["entities"]}}},"components":{"schemas":{"ModuleDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/ModuleDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"}},"required":["id","uuid","item","row"]},"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/ModuleOptionsDTO"},"analytics":{"$ref":"#/components/schemas/ModuleAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"ModuleOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"moduleTopicId":{"type":"string","description":"Module topic identifier"}},"required":["uuid","name","description","owner","moduleTopicId"]},"ModuleAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get schemas

> Returns schemas

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/schemas":{"get":{"description":"Returns schemas","operationId":"EntityApi_getSchemas","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Policy topic identifier","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Schema owner","schema":{"type":"string"}}],"responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SchemaGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get schemas","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"SchemaGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/SchemaOptionsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options"]},"SchemaOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"entity":{"type":"string","description":"Entity"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"version":{"type":"string","description":"Version"},"codeVersion":{"type":"string","description":"Code version"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["name","description","entity","owner","uuid","version","codeVersion","relationships"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get schema

> Returns schema

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/schemas/{messageId}":{"get":{"description":"Returns schema","operationId":"EntityApi_getSchema","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Schema details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get schema","tags":["entities"]}}},"components":{"schemas":{"SchemaDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/SchemaDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/SchemaActivityDTO"}},"required":["id","uuid","item","row","activity"]},"SchemaDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/SchemaOptionsDTO"},"analytics":{"$ref":"#/components/schemas/SchemaAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"SchemaOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"entity":{"type":"string","description":"Entity"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"version":{"type":"string","description":"Version"},"codeVersion":{"type":"string","description":"Code version"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["name","description","entity","owner","uuid","version","codeVersion","relationships"]},"SchemaAnalyticsDTO":{"type":"object","properties":{"policyIds":{"description":"Policy message identifiers","type":"array","items":{"type":"string"}},"childSchemas":{"$ref":"#/components/schemas/ChildSchemaDTO"},"properties":{"description":"Schema properties","type":"array","items":{"type":"string"}},"textSearch":{"type":"string","description":"Text search"}},"required":["policyIds","childSchemas","properties","textSearch"]},"ChildSchemaDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"name":{"type":"string","description":"Name"}},"required":["id","name"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"SchemaActivityDTO":{"type":"object","properties":{"vcs":{"type":"number","description":"VCs"},"vps":{"type":"number","description":"VPs"}},"required":["vcs","vps"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get schema tree

> Returns schema tree

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/schemas/{messageId}/tree":{"get":{"description":"Returns schema tree","operationId":"EntityApi_getSchemaTree","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Schema tree","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaTreeDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get schema tree","tags":["entities"]}}},"components":{"schemas":{"SchemaTreeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/SchemaGridDTO"},"root":{"$ref":"#/components/schemas/SchemaTreeNodeDTO"}},"required":["id","item","root"]},"SchemaGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/SchemaOptionsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options"]},"SchemaOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"entity":{"type":"string","description":"Entity"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"version":{"type":"string","description":"Version"},"codeVersion":{"type":"string","description":"Code version"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["name","description","entity","owner","uuid","version","codeVersion","relationships"]},"SchemaTreeNodeDTO":{"type":"object","properties":{"label":{"type":"string","description":"Label"},"expanded":{"type":"boolean","description":"Expanded"},"data":{"$ref":"#/components/schemas/SchemaTreeNodeDataDTO"},"children":{"type":"array","description":"Schema tree node children"}},"required":["label","expanded","data","children"]},"SchemaTreeNodeDataDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"color":{"type":"string","description":"Color"}},"required":["id","color"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get schemas packages

> Returns schemas packages

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/schemas-packages":{"get":{"description":"Returns schemas packages","operationId":"EntityApi_getSchemasPackages","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Policy topic identifier","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Schema owner","schema":{"type":"string"}}],"responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SchemaGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get schemas packages","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"SchemaGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/SchemaOptionsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options"]},"SchemaOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"entity":{"type":"string","description":"Entity"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"version":{"type":"string","description":"Version"},"codeVersion":{"type":"string","description":"Code version"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["name","description","entity","owner","uuid","version","codeVersion","relationships"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get schemas package

> Returns schemas package

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/schemas-packages/{messageId}":{"get":{"description":"Returns schemas package","operationId":"EntityApi_getSchemasPackage","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Schemas package details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemasPackageDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get schemas package","tags":["entities"]}}},"components":{"schemas":{"SchemasPackageDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/SchemaDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/SchemasPackageActivityDTO"}},"required":["id","uuid","item","row","activity"]},"SchemaDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/SchemaOptionsDTO"},"analytics":{"$ref":"#/components/schemas/SchemaAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"SchemaOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"entity":{"type":"string","description":"Entity"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"version":{"type":"string","description":"Version"},"codeVersion":{"type":"string","description":"Code version"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["name","description","entity","owner","uuid","version","codeVersion","relationships"]},"SchemaAnalyticsDTO":{"type":"object","properties":{"policyIds":{"description":"Policy message identifiers","type":"array","items":{"type":"string"}},"childSchemas":{"$ref":"#/components/schemas/ChildSchemaDTO"},"properties":{"description":"Schema properties","type":"array","items":{"type":"string"}},"textSearch":{"type":"string","description":"Text search"}},"required":["policyIds","childSchemas","properties","textSearch"]},"ChildSchemaDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"name":{"type":"string","description":"Name"}},"required":["id","name"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"SchemasPackageActivityDTO":{"type":"object","properties":{"schemas":{"type":"number","description":"Schemas"}},"required":["schemas"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get tokens

> Returns tokens

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/tokens":{"get":{"description":"Returns tokens","operationId":"EntityApi_getTokens","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"tokenId","required":false,"in":"query","description":"Token identifier","schema":{"type":"string"}},{"name":"treasury","required":false,"in":"query","description":"Treasury","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Tokens","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TokenDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get tokens","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"TokenDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"tokenId":{"type":"string","description":"Token identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"serialNumber":{"type":"number","description":"Serial number"},"hasNext":{"type":"boolean","description":"Has next"},"name":{"type":"string","description":"Name"},"symbol":{"type":"string","description":"Symbol"},"type":{"type":"string","description":"Symbol","enum":["NON_FUNGIBLE_UNIQUE","FUNGIBLE_COMMON"]},"treasury":{"type":"string","description":"Treasury"},"memo":{"type":"string","description":"Memo"},"totalSupply":{"type":"object","description":"Total supply"},"decimals":{"type":"string","description":"Decimals"}},"required":["id","tokenId","status","lastUpdate","serialNumber","hasNext","name","symbol","type","treasury","memo","totalSupply","decimals"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get token

> Returns token

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/tokens/{tokenId}":{"get":{"description":"Returns token","operationId":"EntityApi_getToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Token details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get token","tags":["entities"]}}},"components":{"schemas":{"TokenDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"row":{"$ref":"#/components/schemas/TokenDTO"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/VPDetailsItemDTO"}}},"required":["id","row","labels"]},"TokenDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"tokenId":{"type":"string","description":"Token identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"serialNumber":{"type":"number","description":"Serial number"},"hasNext":{"type":"boolean","description":"Has next"},"name":{"type":"string","description":"Name"},"symbol":{"type":"string","description":"Symbol"},"type":{"type":"string","description":"Symbol","enum":["NON_FUNGIBLE_UNIQUE","FUNGIBLE_COMMON"]},"treasury":{"type":"string","description":"Treasury"},"memo":{"type":"string","description":"Memo"},"totalSupply":{"type":"object","description":"Total supply"},"decimals":{"type":"string","description":"Decimals"}},"required":["id","tokenId","status","lastUpdate","serialNumber","hasNext","name","symbol","type","treasury","memo","totalSupply","decimals"]},"VPDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VPOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VPAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"VPOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["issuer","relationships"]},"VPAnalyticsDTO":{"type":"object","properties":{"schemaIds":{"description":"Schema message identifiers","type":"array","items":{"type":"string"}},"schemaNames":{"description":"Schema names","type":"array","items":{"type":"string"}},"policyId":{"type":"string","description":"Policy message identifier"},"textSearch":{"type":"string","description":"Text search"},"issuer":{"type":"string","description":"Document issuer"},"tokenId":{"type":"string","description":"Token ID"},"tokenAmount":{"type":"string","description":"Token amount"},"labelName":{"type":"string","description":"Label name"},"labels":{"description":"Label IDs","type":"array","items":{"type":"string"}}},"required":["schemaIds","schemaNames","policyId","textSearch","issuer","tokenId","tokenAmount","labelName","labels"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get roles

> Returns roles

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/roles":{"get":{"description":"Returns roles","operationId":"EntityApi_getRoles","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"options.issuer","required":false,"in":"query","description":"Issuer","schema":{"type":"string"}},{"name":"options.role","required":true,"in":"query","schema":{"type":"string"}},{"name":"analytics.sr","required":true,"in":"query","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"analytics.policyId","required":false,"in":"query","description":"Policy identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Roles","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RoleDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get roles","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"RoleDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/RoleOptionsDTO"},"analytics":{"$ref":"#/components/schemas/RoleAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"RoleOptionsDTO":{"type":"object","properties":{"role":{"type":"string","description":"Role"},"group":{"type":"string","description":"Role"},"issuer":{"type":"string","description":"Issuer"}},"required":["role","group","issuer"]},"RoleAnalyticsDTO":{"type":"object","properties":{"policyId":{"type":"string","description":"Policy message identifier"},"textSearch":{"type":"string","description":"Text search"}},"required":["policyId","textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get role

> Returns role

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/roles/{messageId}":{"get":{"description":"Returns role","operationId":"EntityApi_getRole","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Role details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get role","tags":["entities"]}}},"components":{"schemas":{"RoleDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/RoleDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/RoleActivityDTO"}},"required":["id","uuid","item","row","activity"]},"RoleDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/RoleOptionsDTO"},"analytics":{"$ref":"#/components/schemas/RoleAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"RoleOptionsDTO":{"type":"object","properties":{"role":{"type":"string","description":"Role"},"group":{"type":"string","description":"Role"},"issuer":{"type":"string","description":"Issuer"}},"required":["role","group","issuer"]},"RoleAnalyticsDTO":{"type":"object","properties":{"policyId":{"type":"string","description":"Policy message identifier"},"textSearch":{"type":"string","description":"Text search"}},"required":["policyId","textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"RoleActivityDTO":{"type":"object","properties":{"vcs":{"type":"number","description":"VCs"}},"required":["vcs"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get statistics

> Returns statistics

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/statistics":{"get":{"description":"Returns statistics","operationId":"EntityApi_getStatistics","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Statistic topic identifier","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Statistic owner","schema":{"type":"string"}},{"name":"options.policy","required":false,"in":"query","description":"Policy","schema":{"type":"string"}}],"responses":{"200":{"description":"Statistics","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StatisticDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get statistics","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"StatisticDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/StatisticOptionsDTO"},"analytics":{"$ref":"#/components/schemas/StatisticAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"StatisticOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"policyInstanceTopicId":{"type":"string","description":"Policy instance topic identifier"}},"required":["uuid","name","description","owner","policyTopicId","policyInstanceTopicId"]},"StatisticAnalyticsDTO":{"type":"object","properties":{}},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get statistic

> Returns statistic

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/statistics/{messageId}":{"get":{"description":"Returns statistic","operationId":"EntityApi_getStatistic","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Statistic details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatisticDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get statistic","tags":["entities"]}}},"components":{"schemas":{"StatisticDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/StatisticDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/StatisticActivityDTO"}},"required":["id","uuid","item","row","activity"]},"StatisticDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/StatisticOptionsDTO"},"analytics":{"$ref":"#/components/schemas/StatisticAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"StatisticOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"policyInstanceTopicId":{"type":"string","description":"Policy instance topic identifier"}},"required":["uuid","name","description","owner","policyTopicId","policyInstanceTopicId"]},"StatisticAnalyticsDTO":{"type":"object","properties":{}},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"StatisticActivityDTO":{"type":"object","properties":{"schemas":{"type":"number","description":"Schemas"},"vcs":{"type":"number","description":"VCs"}},"required":["schemas","vcs"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VCs

> Returns VCs

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/statistic-documents":{"get":{"description":"Returns VCs","operationId":"EntityApi_getStatisticDocuments","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"options.issuer","required":false,"in":"query","description":"Issuer","schema":{"type":"string"}},{"name":"analytics.policyId","required":false,"in":"query","description":"Policy identifier","schema":{"type":"string"}},{"name":"analytics.schemaId","required":false,"in":"query","description":"Schema identifier","schema":{"type":"string"}},{"name":"options.relationships","required":false,"in":"query","description":"Relationships","schema":{"type":"string"}}],"responses":{"200":{"description":"VCs","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VCGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VCs","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"VCGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VCOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VCAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"VCOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}},"documentStatus":{"type":"string","description":"Document status"},"encodedData":{"type":"boolean","description":"Encoded EVC data"}},"required":["issuer","relationships","documentStatus","encodedData"]},"VCAnalyticsDTO":{"type":"object","properties":{"policyId":{"type":"string","description":"Policy message identifier"},"schemaId":{"type":"string","description":"Schema message identifier"},"schemaName":{"type":"string","description":"Schema name"},"textSearch":{"type":"string","description":"Text search"}},"required":["policyId","schemaId","schemaName","textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get labels

> Returns labels

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/labels":{"get":{"description":"Returns labels","operationId":"EntityApi_getLabels","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Label topic identifier","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"Label owner","schema":{"type":"string"}},{"name":"options.policy","required":false,"in":"query","description":"Policy","schema":{"type":"string"}}],"responses":{"200":{"description":"Labels","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LabelDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get labels","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"LabelDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/LabelOptionsDTO"},"analytics":{"$ref":"#/components/schemas/LabelAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"LabelOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"policyInstanceTopicId":{"type":"string","description":"Policy instance topic identifier"}},"required":["uuid","name","description","owner","policyTopicId","policyInstanceTopicId"]},"LabelAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"},"owner":{"type":"string","description":"Owner"},"config":{"type":"object","description":"Label Config","additionalProperties":true}},"required":["textSearch","owner","config"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get label

> Returns label

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/labels/{messageId}":{"get":{"description":"Returns label","operationId":"EntityApi_getLabel","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Label details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get label","tags":["entities"]}}},"components":{"schemas":{"LabelDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/LabelDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/LabelActivityDTO"}},"required":["id","uuid","item","row","activity"]},"LabelDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/LabelOptionsDTO"},"analytics":{"$ref":"#/components/schemas/LabelAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"LabelOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"policyInstanceTopicId":{"type":"string","description":"Policy instance topic identifier"}},"required":["uuid","name","description","owner","policyTopicId","policyInstanceTopicId"]},"LabelAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"},"owner":{"type":"string","description":"Owner"},"config":{"type":"object","description":"Label Config","additionalProperties":true}},"required":["textSearch","owner","config"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"LabelActivityDTO":{"type":"object","properties":{"schemas":{"type":"number","description":"Schemas"},"vps":{"type":"number","description":"VPs"}},"required":["schemas","vps"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get label document

> Returns label document

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/label-documents/{messageId}":{"get":{"description":"Returns label document","operationId":"EntityApi_getLabelDocument","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Label document details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelDocumentDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get label document","tags":["entities"]}}},"components":{"schemas":{"LabelDocumentDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/VPDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"history":{"type":"array","items":{"$ref":"#/components/schemas/VPDetailsItemDTO"}},"label":{"type":"array","items":{"$ref":"#/components/schemas/VPDetailsItemDTO"}}},"required":["id","uuid","item","row","history","label"]},"VPDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VPOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VPAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"VPOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["issuer","relationships"]},"VPAnalyticsDTO":{"type":"object","properties":{"schemaIds":{"description":"Schema message identifiers","type":"array","items":{"type":"string"}},"schemaNames":{"description":"Schema names","type":"array","items":{"type":"string"}},"policyId":{"type":"string","description":"Policy message identifier"},"textSearch":{"type":"string","description":"Text search"},"issuer":{"type":"string","description":"Document issuer"},"tokenId":{"type":"string","description":"Token ID"},"tokenAmount":{"type":"string","description":"Token amount"},"labelName":{"type":"string","description":"Label name"},"labels":{"description":"Label IDs","type":"array","items":{"type":"string"}}},"required":["schemaIds","schemaNames","policyId","textSearch","issuer","tokenId","tokenAmount","labelName","labels"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get Label Documents

> Returns Label Documents

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/label-documents":{"get":{"description":"Returns Label Documents","operationId":"EntityApi_getLabelDocuments","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"options.issuer","required":false,"in":"query","description":"Issuer","schema":{"type":"string"}},{"name":"analytics.policyId","required":false,"in":"query","description":"Policy identifier","schema":{"type":"string"}},{"name":"analytics.schemaIds","required":false,"in":"query","description":"Schema identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Label Documents","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VPGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get Label Documents","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"VPGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VPOptionsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options"]},"VPOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["issuer","relationships"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get formulas

> Returns formulas

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/formulas":{"get":{"description":"Returns formulas","operationId":"EntityApi_getFormulas","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Policy topic identifier","schema":{"type":"string"}},{"name":"options.owner","required":false,"in":"query","description":"formula owner","schema":{"type":"string"}}],"responses":{"200":{"description":"formulas","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FormulaDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get formulas","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"FormulaDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/FormulaOptionsDTO"},"analytics":{"$ref":"#/components/schemas/FormulaAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"FormulaOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"policyInstanceTopicId":{"type":"string","description":"Policy instance topic identifier"}},"required":["uuid","name","description","owner","policyTopicId","policyInstanceTopicId"]},"FormulaAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"},"owner":{"type":"string","description":"Owner"},"config":{"type":"object","description":"Formula Config","additionalProperties":true}},"required":["textSearch","owner","config"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get formula

> Returns formula

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/formulas/{messageId}":{"get":{"description":"Returns formula","operationId":"EntityApi_getFormula","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Formula details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormulaDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get formula","tags":["entities"]}}},"components":{"schemas":{"FormulaDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/FormulaDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"activity":{"$ref":"#/components/schemas/FormulaActivityDTO"}},"required":["id","uuid","item","row","activity"]},"FormulaDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/FormulaOptionsDTO"},"analytics":{"$ref":"#/components/schemas/FormulaAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"FormulaOptionsDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"owner":{"type":"string","description":"Owner"},"policyTopicId":{"type":"string","description":"Policy topic identifier"},"policyInstanceTopicId":{"type":"string","description":"Policy instance topic identifier"}},"required":["uuid","name","description","owner","policyTopicId","policyInstanceTopicId"]},"FormulaAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"},"owner":{"type":"string","description":"Owner"},"config":{"type":"object","description":"Formula Config","additionalProperties":true}},"required":["textSearch","owner","config"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"FormulaActivityDTO":{"type":"object","properties":{"schemas":{"type":"number","description":"Schemas"},"vps":{"type":"number","description":"VPs"}},"required":["schemas","vps"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get formula relationships

> Returns formula relationships

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/formulas/{messageId}/relationships":{"get":{"description":"Returns formula relationships","operationId":"EntityApi_getFormulaRelationships","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Formula relationships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormulaRelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get formula relationships","tags":["entities"]}}},"components":{"schemas":{"FormulaRelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/MessageDTO"}},"formulas":{"type":"array","items":{"$ref":"#/components/schemas/MessageDTO"}}},"required":["id","item","schemas","formulas"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get DIDs

> Returns DIDs

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/did-documents":{"get":{"description":"Returns DIDs","operationId":"EntityApi_getDidDocuments","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"options.did","required":false,"in":"query","description":"DID","schema":{"type":"string"}}],"responses":{"200":{"description":"DIDs","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DIDGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get DIDs","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"DIDGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/DIDOptionsDTO"},"analytics":{"$ref":"#/components/schemas/DIDAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"DIDOptionsDTO":{"type":"object","properties":{"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}},"did":{"type":"string","description":"DID"}},"required":["relationships","did"]},"DIDAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get DID

> Returns DID

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/did-documents/{messageId}":{"get":{"description":"Returns DID","operationId":"EntityApi_getDidDocument","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"DID details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DIDDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get DID","tags":["entities"]}}},"components":{"schemas":{"DIDDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/DIDDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"history":{"type":"array","items":{"$ref":"#/components/schemas/DIDDetailsItemDTO"}}},"required":["id","uuid","item","row","history"]},"DIDDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/DIDOptionsDTO"},"analytics":{"$ref":"#/components/schemas/DIDAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"DIDOptionsDTO":{"type":"object","properties":{"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}},"did":{"type":"string","description":"DID"}},"required":["relationships","did"]},"DIDAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get DID relationships

> Returns DID relationships

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/did-documents/{messageId}/relationships":{"get":{"description":"Returns DID relationships","operationId":"EntityApi_getDidRelationships","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"DID relationships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get DID relationships","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VPs

> Returns VPs

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vp-documents":{"get":{"description":"Returns VPs","operationId":"EntityApi_getVpDocuments","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"options.issuer","required":false,"in":"query","description":"Issuer","schema":{"type":"string"}},{"name":"analytics.policyId","required":false,"in":"query","description":"Policy identifier","schema":{"type":"string"}},{"name":"analytics.schemaIds","required":false,"in":"query","description":"Schema identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"VPs","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VPGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VPs","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"VPGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VPOptionsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options"]},"VPOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["issuer","relationships"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VP

> Returns VP

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vp-documents/{messageId}":{"get":{"description":"Returns VP","operationId":"EntityApi_getVpDocument","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"VP details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VPDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VP","tags":["entities"]}}},"components":{"schemas":{"VPDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/VPDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"history":{"type":"array","items":{"$ref":"#/components/schemas/VPDetailsItemDTO"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/VPDetailsItemDTO"}}},"required":["id","uuid","item","row","history","labels"]},"VPDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VPOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VPAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"VPOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["issuer","relationships"]},"VPAnalyticsDTO":{"type":"object","properties":{"schemaIds":{"description":"Schema message identifiers","type":"array","items":{"type":"string"}},"schemaNames":{"description":"Schema names","type":"array","items":{"type":"string"}},"policyId":{"type":"string","description":"Policy message identifier"},"textSearch":{"type":"string","description":"Text search"},"issuer":{"type":"string","description":"Document issuer"},"tokenId":{"type":"string","description":"Token ID"},"tokenAmount":{"type":"string","description":"Token amount"},"labelName":{"type":"string","description":"Label name"},"labels":{"description":"Label IDs","type":"array","items":{"type":"string"}}},"required":["schemaIds","schemaNames","policyId","textSearch","issuer","tokenId","tokenAmount","labelName","labels"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VP relationships

> Returns VP relationships

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vp-documents/{messageId}/relationships":{"get":{"description":"Returns VP relationships","operationId":"EntityApi_getVpRelationships","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"VP relationships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VP relationships","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VCs

> Returns VCs

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vc-documents":{"get":{"description":"Returns VCs","operationId":"EntityApi_getVcDocuments","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"options.issuer","required":false,"in":"query","description":"Issuer","schema":{"type":"string"}},{"name":"analytics.policyId","required":false,"in":"query","description":"Policy identifier","schema":{"type":"string"}},{"name":"analytics.schemaId","required":false,"in":"query","description":"Schema identifier","schema":{"type":"string"}},{"name":"options.relationships","required":false,"in":"query","description":"Relationships","schema":{"type":"string"}}],"responses":{"200":{"description":"VCs","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VCGridDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VCs","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"VCGridDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VCOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VCAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"VCOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}},"documentStatus":{"type":"string","description":"Document status"},"encodedData":{"type":"boolean","description":"Encoded EVC data"}},"required":["issuer","relationships","documentStatus","encodedData"]},"VCAnalyticsDTO":{"type":"object","properties":{"policyId":{"type":"string","description":"Policy message identifier"},"schemaId":{"type":"string","description":"Schema message identifier"},"schemaName":{"type":"string","description":"Schema name"},"textSearch":{"type":"string","description":"Text search"}},"required":["policyId","schemaId","schemaName","textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VC

> Returns VC

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vc-documents/{messageId}":{"get":{"description":"Returns VC","operationId":"EntityApi_getVcDocument","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"VC details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VCDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VC","tags":["entities"]}}},"components":{"schemas":{"VCDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/VCDetailsItemDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"},"history":{"type":"array","items":{"$ref":"#/components/schemas/VCDetailsItemDTO"}},"schema":{"type":"object","description":"VC Schema","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"readOnly":true},"type":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"readOnly":true},"id":{"type":"string","readOnly":true},"geography":{"type":"string","readOnly":false},"law":{"type":"string","readOnly":false},"tags":{"type":"string","readOnly":false},"ISIC":{"type":"string","readOnly":false}},"required":["geography","law","tags"],"additionalProperties":false},"formulasData":{"type":"object","description":"Formulas data"}},"required":["id","uuid","item","row","history","formulasData"]},"VCDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VCOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VCAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"VCOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}},"documentStatus":{"type":"string","description":"Document status"},"encodedData":{"type":"boolean","description":"Encoded EVC data"}},"required":["issuer","relationships","documentStatus","encodedData"]},"VCAnalyticsDTO":{"type":"object","properties":{"policyId":{"type":"string","description":"Policy message identifier"},"schemaId":{"type":"string","description":"Schema message identifier"},"schemaName":{"type":"string","description":"Schema name"},"textSearch":{"type":"string","description":"Text search"}},"required":["policyId","schemaId","schemaName","textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VC relationships

> Returns VC relationships

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vc-documents/{messageId}/relationships":{"get":{"description":"Returns VC relationships","operationId":"EntityApi_getVcRelationships","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"VC relationships","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VC relationships","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VC comments

> Returns VC comments

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vc-documents/{messageId}/discussions":{"get":{"description":"Returns VC comments","operationId":"EntityApi_getDiscussions","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"VC comments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VC comments","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get VC comments

> Returns VC comments

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/vc-documents/{messageId}/discussions/{discussionId}/comments":{"get":{"description":"Returns VC comments","operationId":"EntityApi_getVcComments","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}},{"name":"discussionId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}},{"name":"pageIndex","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"VC comments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get VC comments","tags":["entities"]}}},"components":{"schemas":{"RelationshipsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"item":{"$ref":"#/components/schemas/MessageDTO"},"target":{"$ref":"#/components/schemas/RelationshipDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipDTO"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipLinkDTO"}},"categories":{"description":"Categories","type":"array","items":{"type":"string"}}},"required":["id","item","target","relationships","links","categories"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"RelationshipDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"category":{"type":"number","description":"Category"},"name":{"type":"string","description":"Name"},"tagsCount":{"type":"number","description":"Tags count"}},"required":["id","uuid","type","category","name","tagsCount"]},"RelationshipLinkDTO":{"type":"object","properties":{"source":{"type":"string","description":"Source message identifier"},"target":{"type":"string","description":"Target message identifier"}},"required":["source","target"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get NFTs

> Returns NFTs

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/nfts":{"get":{"description":"Returns NFTs","operationId":"EntityApi_getNFTs","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"tokenId","required":false,"in":"query","description":"Token identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"NFTs","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NFTDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get NFTs","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"NFTDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"tokenId":{"type":"string","description":"Token identifier"},"lastUpdate":{"type":"number","description":"Last update"},"serialNumber":{"type":"number","description":"Serial number"},"metadata":{"type":"string","description":"metadata"}},"required":["id","tokenId","lastUpdate","serialNumber","metadata"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get NFT

> Returns NFT

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/nfts/{tokenId}/{serialNumber}":{"get":{"description":"Returns NFT","operationId":"EntityApi_getNFT","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token identifier","schema":{"type":"string"}},{"name":"serialNumber","required":true,"in":"path","description":"Serial number","schema":{"type":"string"}}],"responses":{"200":{"description":"NFT details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NFTDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get NFT","tags":["entities"]}}},"components":{"schemas":{"NFTDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"row":{"$ref":"#/components/schemas/NFTDTO"},"history":{"type":"array","description":"NFT transaction history","items":{"type":"object"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/VPDetailsItemDTO"}}},"required":["id","row","history","labels"]},"NFTDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"tokenId":{"type":"string","description":"Token identifier"},"lastUpdate":{"type":"number","description":"Last update"},"serialNumber":{"type":"number","description":"Serial number"},"metadata":{"type":"string","description":"metadata"}},"required":["id","tokenId","lastUpdate","serialNumber","metadata"]},"VPDetailsItemDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/VPOptionsDTO"},"analytics":{"$ref":"#/components/schemas/VPAnalyticsDTO"},"documents":{"type":"array","description":"Documents","items":{"type":"string"}}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics","documents"]},"VPOptionsDTO":{"type":"object","properties":{"issuer":{"type":"string","description":"Issuer"},"relationships":{"description":"Relationships","type":"array","items":{"type":"string"}}},"required":["issuer","relationships"]},"VPAnalyticsDTO":{"type":"object","properties":{"schemaIds":{"description":"Schema message identifiers","type":"array","items":{"type":"string"}},"schemaNames":{"description":"Schema names","type":"array","items":{"type":"string"}},"policyId":{"type":"string","description":"Policy message identifier"},"textSearch":{"type":"string","description":"Text search"},"issuer":{"type":"string","description":"Document issuer"},"tokenId":{"type":"string","description":"Token ID"},"tokenAmount":{"type":"string","description":"Token amount"},"labelName":{"type":"string","description":"Label name"},"labels":{"description":"Label IDs","type":"array","items":{"type":"string"}}},"required":["schemaIds","schemaNames","policyId","textSearch","issuer","tokenId","tokenAmount","labelName","labels"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get topics

> Returns topics

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/topics":{"get":{"description":"Returns topics","operationId":"EntityApi_getTopics","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"options.parentId","required":false,"in":"query","description":"Parent topic identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Topics","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TopicDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get topics","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"TopicDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/TopicOptionsDTO"},"analytics":{"$ref":"#/components/schemas/TopicAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"TopicOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Name"},"owner":{"type":"string","description":"Owner"},"messageType":{"type":"string","description":"Message type","enum":["USER_TOPIC","POLICY_TOPIC","INSTANCE_POLICY_TOPIC","DYNAMIC_TOPIC","SCHEMA_TOPIC","SYNCHRONIZATION_TOPIC","RETIRE_TOPIC","TOKEN_TOPIC","MODULE_TOPIC","CONTRACT_TOPIC","TOOL_TOPIC","TAGS_TOPIC"]},"childId":{"type":"string","description":"Child topic identifier"},"parentId":{"type":"string","description":"Parent topic identifier"},"rationale":{"type":"string","description":"Rationale"}},"required":["name","description","owner","messageType","childId","parentId","rationale"]},"TopicAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get topic

> Returns topic

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/topics/{topicId}":{"get":{"description":"Returns topic","operationId":"EntityApi_getTopic","parameters":[{"name":"topicId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Topic details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get topic","tags":["entities"]}}},"components":{"schemas":{"TopicDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/TopicDTO"},"row":{"$ref":"#/components/schemas/RawTopicDTO"},"activity":{"$ref":"#/components/schemas/TopicActivityDTO"}},"required":["id","uuid","item","row","activity"]},"TopicDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/TopicOptionsDTO"},"analytics":{"$ref":"#/components/schemas/TopicAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"TopicOptionsDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Name"},"owner":{"type":"string","description":"Owner"},"messageType":{"type":"string","description":"Message type","enum":["USER_TOPIC","POLICY_TOPIC","INSTANCE_POLICY_TOPIC","DYNAMIC_TOPIC","SCHEMA_TOPIC","SYNCHRONIZATION_TOPIC","RETIRE_TOPIC","TOKEN_TOPIC","MODULE_TOPIC","CONTRACT_TOPIC","TOOL_TOPIC","TAGS_TOPIC"]},"childId":{"type":"string","description":"Child topic identifier"},"parentId":{"type":"string","description":"Parent topic identifier"},"rationale":{"type":"string","description":"Rationale"}},"required":["name","description","owner","messageType","childId","parentId","rationale"]},"TopicAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawTopicDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"lastUpdate":{"type":"number","description":"Last update"},"messages":{"type":"number","description":"Messages"},"hasNext":{"type":"boolean","description":"Has next"}},"required":["id","topicId","lastUpdate","messages","hasNext"]},"TopicActivityDTO":{"type":"object","properties":{"registries":{"type":"number","description":"Registries"},"topics":{"type":"number","description":"Topics"},"policies":{"type":"number","description":"Policies"},"tools":{"type":"number","description":"Tools"},"modules":{"type":"number","description":"Modules"},"tokens":{"type":"number","description":"Tokens"},"dids":{"type":"number","description":"DIDs"},"contracts":{"type":"number","description":"Contracts"},"schemas":{"type":"number","description":"Schemas"},"vcs":{"type":"number","description":"VCs"},"vps":{"type":"number","description":"VPs"},"roles":{"type":"number","description":"Roles"}},"required":["registries","topics","policies","tools","modules","tokens","dids","contracts","schemas","vcs","vps","roles"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get contracts

> Returns contracts

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/contracts":{"get":{"description":"Returns contracts","operationId":"EntityApi_getContracts","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"Page index","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"type":"number","maximum":100}},{"name":"orderField","required":false,"in":"query","description":"Order field","schema":{"type":"string"}},{"name":"orderDir","required":false,"in":"query","description":"Order direction","schema":{"type":"string"}},{"name":"keywords","required":false,"in":"query","description":"Keywords to search","schema":{"type":"string"}},{"name":"topicId","required":false,"in":"query","description":"Topic identifier","schema":{"type":"string"}},{"name":"owner","required":false,"in":"query","description":"Owner","schema":{"type":"string"}}],"responses":{"200":{"description":"Contracts","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PageDTO"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ContractDTO"}}}}]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get contracts","tags":["entities"]}}},"components":{"schemas":{"PageDTO":{"type":"object","properties":{"pageIndex":{"type":"number","description":"Page index"},"pageSize":{"type":"number","description":"Page size"},"total":{"type":"number","description":"Total size"},"order":{"type":"object","description":"Order"}},"required":["pageIndex","pageSize","total","order"]},"ContractDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/ContractOptionsDTO"},"analytics":{"$ref":"#/components/schemas/ContractAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"ContractOptionsDTO":{"type":"object","properties":{"contractId":{"type":"string","description":"Contract identifier"},"description":{"type":"string","description":"Description"},"contractType":{"type":"string","description":"Contract type","enum":["WIPE","RETIRE"]},"owner":{"type":"string","description":"Owner"}},"required":["contractId","description","contractType","owner"]},"ContractAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get contract

> Returns contract

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/contracts/{messageId}":{"get":{"description":"Returns contract","operationId":"EntityApi_getContract","parameters":[{"name":"messageId","required":true,"in":"path","description":"Message identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Contract details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get contract","tags":["entities"]}}},"components":{"schemas":{"ContractDetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"},"uuid":{"type":"string","description":"UUID"},"item":{"$ref":"#/components/schemas/ContractDTO"},"row":{"$ref":"#/components/schemas/RawMessageDTO"}},"required":["id","uuid","item","row"]},"ContractDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"},"type":{"type":"string","description":"Type","enum":["EVC-Document","VC-Document","DID-Document","Schema","schema-document","Policy","Instance-Policy","VP-Document","Standard Registry","Topic","Token","Module","Tool","Tag","Role-Document","Synchronization Event","Contract","Guardian-Role-Document","User-Permissions","Policy-Statistic","Policy-Label","Formula","Schema-Package","Policy-Diff","Policy-Action","Policy-Discussion","Policy-Comment"]},"action":{"type":"string","description":"Action","enum":["create-did-document","create-vc-document","create-policy","publish-policy","delete-policy","create-schema","publish-schema","publish-schemas","delete-schema","create-topic","create-vp-document","publish-system-schema","publish-system-schemas","Init","change-message-status","revoke-document","delete-document","token-issue","create-token","create-multi-policy","mint","publish-module","publish-tag","delete-tag","publish-tool","create-tool","create-contract","discontinue-policy","deferred-discontinue-policy","migrate-vc-document","migrate-vp-document","create-role","update-role","delete-role","set-role","publish-policy-statistic","create-assessment-document","publish-policy-label","create-label-document","publish-formula","create-policy-comment","create-policy-discussion"]},"options":{"$ref":"#/components/schemas/ContractOptionsDTO"},"analytics":{"$ref":"#/components/schemas/ContractAnalyticsDTO"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber","type","action","options","analytics"]},"ContractOptionsDTO":{"type":"object","properties":{"contractId":{"type":"string","description":"Contract identifier"},"description":{"type":"string","description":"Description"},"contractType":{"type":"string","description":"Contract type","enum":["WIPE","RETIRE"]},"owner":{"type":"string","description":"Owner"}},"required":["contractId","description","contractType","owner"]},"ContractAnalyticsDTO":{"type":"object","properties":{"textSearch":{"type":"string","description":"Text search"}},"required":["textSearch"]},"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Try to load ipfs files

> Returns ipfs files

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/update-files":{"post":{"description":"Returns ipfs files","operationId":"EntityApi_search","parameters":[],"requestBody":{"required":true,"description":"Entity Timestamp","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFileDTO"}}}},"responses":{"200":{"description":"ipfs files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Try to load ipfs files","tags":["entities"]}}},"components":{"schemas":{"UpdateFileDTO":{"type":"object","properties":{"messageId":{"type":"string","description":"Entity Timestamp"}},"required":["messageId"]},"DetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"}},"required":["id"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Try to unpack schemas

> Returns schemas

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/entities/unpack-schemas":{"post":{"description":"Returns schemas","operationId":"EntityApi_unpackSchemas","parameters":[],"requestBody":{"required":true,"description":"Entity Timestamp","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFileDTO"}}}},"responses":{"200":{"description":"Try to unpack schemas","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailsDTO"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Try to unpack schemas","tags":["entities"]}}},"components":{"schemas":{"UpdateFileDTO":{"type":"object","properties":{"messageId":{"type":"string","description":"Entity Timestamp"}},"required":["messageId"]},"DetailsDTO":{"type":"object","properties":{"id":{"type":"string","description":"Message identifier"}},"required":["id"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dev.guardian.hedera.com/api-reference-indexer/entities.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.