Version: Latest

DocumentType

description

Base interface for document types

interface DocumentType {
  display: String
  displayWide: String
  idsV2: [String!]
  ids: [String!]! @deprecated
  codeLevels: CodeLevels
  fileInfo: FileInformation
  solrSub: String
  name: String
  description: String
}

Fields

`DocumentType`.`display` ● `String` scalar graph-ql-types

The display name of a filing type to the user @exposed(scopes: ['docviewer'])

`DocumentType`.`displayWide` ● `String` scalar graph-ql-types

A lengthed version of name displayed to the user sometimes including additional information, e.g. as 'sourcename - LexisNexis' @exposed(scopes: ['docviewer'])

`DocumentType`.`idsV2` ● `[String!]` list scalar graph-ql-types

Document source type ids.

Document source types have hierarchical structure. Some document types depend on user permissions, e.g. AMR/SSR. At the moment returning the top most available source id from that hierarchy.

The changes compared to the 'ids' field are that this field is nullable. This is for the sake of returning partial data in case the field cannot be resolved. @exposed

`DocumentType`.`ids` ● `[String!]!` deprecated non-null scalar graph-ql-types

⚠️ DEPRECATED

Use idsV2 instead

Document source type ids

Document source types have hierarchical structure. Some document types depend on user permissions, eg AMR/SSR At the moment returning top most available source id from that hierarchy. @exposed