CFDocument

A CASE document

  • caseVersion
    enum
    const:  
    1.1
    required

    The CASE version for the CFDocument. Currently, the only expected value is 1.1 since this field does not exist for previous versions

    values
    • 1.1
  • creator
    Type: string
    required

    The creator of the document

  • identifier
    Type: string
    required

    The unique identifier for this document

  • lastChangeDateTime
    Type: stringFormat: date-time
    required

    Date/time when the entity was last modified

  • title
    Type: string
    required

    The title of the document

  • uri
    Type: stringFormat: uri
    required

    URI that identifies this CASE entity

  • adoptionStatus
    Type: string

    Current adoption status of the document

  • CFPackageURI
    Type: object

    A generic link type containing identifier, uri and title

    • identifier
      Type: string
      required

      The identifier of the referenced entity

    • title
      Type: string
      required

      The title of the referenced entity

    • uri
      Type: stringFormat: uri
      required

      The URI of the referenced entity

  • description
    Type: string

    A human readable description of the document

  • extensions
    Type: object

    Additional properties for the document

  • frameworkType
    Type: string

    Specify the framework type of the CFDocument

  • language
    Type: string

    Language code for this document

  • licenseURI
    Type: object

    A generic link type containing identifier, uri and title

    • identifier
      Type: string
      required

      The identifier of the referenced entity

    • title
      Type: string
      required

      The title of the referenced entity

    • uri
      Type: stringFormat: uri
      required

      The URI of the referenced entity

  • notes
    Type: string

    Additional notes about the document

  • officialSourceURL
    Type: stringFormat: uri

    URL of the official source of this document

  • publisher
    Type: string

    The publisher of the document

  • statusEndDate
    Type: stringFormat: date

    End date of the current status

  • statusStartDate
    Type: stringFormat: date

    Start date of the current status

  • subject
    Type: array string[]

    List of subjects covered by this document

  • subjectURI
    Type: array object[] · CfLinkUri[]

    List of subject references for this document

    A generic link type containing identifier, uri and title

    • identifier
      Type: string
      required

      The identifier of the referenced entity

    • title
      Type: string
      required

      The title of the referenced entity

    • uri
      Type: stringFormat: uri
      required

      The URI of the referenced entity

  • version
    Type: string

    Version of the document