Interface: ReadableTermsResponse
@kortexya/reasoninglayer / ReadableTermsResponse
Interface: ReadableTermsResponse
Section titled “Interface: ReadableTermsResponse”Defined in: src/types/compliance-markings.ts:84
The tenant’s terms a requester holding a given clearance may read.
Remarks
Section titled “Remarks”Returned by GET /api/v1/compliance/markings/readable-terms. Withheld
(residuated) terms are absent from readable and only reflected in
withheldCount.
Properties
Section titled “Properties”clearance
Section titled “clearance”clearance:
string
Defined in: src/types/compliance-markings.ts:86
The clearance level that was evaluated.
readable
Section titled “readable”readable:
ReadableTermDto[]
Defined in: src/types/compliance-markings.ts:88
The readable terms with their markings.
readableCount
Section titled “readableCount”readableCount:
number
Defined in: src/types/compliance-markings.ts:90
Number of terms the requester may read.
withheldCount
Section titled “withheldCount”withheldCount:
number
Defined in: src/types/compliance-markings.ts:92
Number of terms withheld (residuated) from the requester.