Interface BaseFactSheet

Describes the structure of a Base FactSheet response from the API.

interface BaseFactSheet {
    category?: null | string;
    completion?: Completion;
    description?: string;
    diff?: FactSheetDiff;
    disabled?: boolean;
    displayName?: string;
    fullName?: string;
    id?: string;
    naFields?: string[];
    name?: string;
    permissions?: PermissionList;
    permittedReadACL?: AccessControlEntityReference[];
    permittedWriteACL?: AccessControlEntityReference[];
    qualitySeal?: FactSheetQualityState;
    rev?: number;
    status?: FactSheetStatusState;
    subscriptions?: GraphqlConnection<FactSheetSubscription>;
    tags?: Tag[];
    type?: string;
    updatedAt?: string;
}

Hierarchy

MinimalFactSheet
- BaseFactSheet
  - FactSheet

Properties

`Optional` category

category?: null | string

`Optional` completion

completion?: Completion

`Optional` description

description?: string

`Optional` diff

diff?: FactSheetDiff

`Optional` disabled

disabled?: boolean

`Optional` displayName

displayName?: string

`Optional` fullName

fullName?: string

`Optional` id

id?: string

`Optional` naFields

naFields?: string[]

`Optional` name

name?: string

`Optional` permissions

permissions?: PermissionList

`Optional` permittedReadACL

permittedReadACL?: AccessControlEntityReference[]

`Optional` permittedWriteACL

permittedWriteACL?: AccessControlEntityReference[]

`Optional` qualitySeal

qualitySeal?: FactSheetQualityState

`Optional` rev

rev?: number

`Optional` status

status?: FactSheetStatusState

`Optional` subscriptions

subscriptions?: GraphqlConnection<FactSheetSubscription>

`Optional` tags

tags?: Tag[]

`Optional` type

type?: string

`Optional` updatedAt

updatedAt?: string

Generated using TypeDoc