document

Document

Structure for submitted documents including reference, metadata, and file information

Fields

• Reference reference:

  Unique reference for the document within this application submission, generated by the submitting system

  Required

  True

  Datatype

  string

  Expected number

  1

• Required: True
• Datatype: string
• Expected number: 1
• Name name:

  The name or title of the document

  Required

  True

  Datatype

  string

  Expected number

  1

• Required: True
• Datatype: string
• Expected number: 1
• Description description:

  Brief description of what the document contains

  Required

  False

  Datatype

  string

  Expected number

  1

• Required: False
• Datatype: string
• Expected number: 1
• Document types document-types:

  Planning requirement references identifying the information this document provides. A document may address more than one requirement. These references identify its coverage; they do not establish that the requirements have been satisfied.

  Required

  True

  Datatype

  enum

  Allowed values

  Planning requirement codelist

  Expected number

  1 or more

• Required: True
• Datatype: enum
• Allowed values: Planning requirement codelist
• Expected number: 1 or more
• Uploaded date uploaded-date:

  The date the document was uploaded to the application

  Required

  True

  Datatype

  datetime

  Expected number

  1

• Required: True
• Datatype: datetime
• Expected number: 1
• File file: Component

  Details of the digital file attached to a submission

  Required

  True

  Datatype

  object

  Expected number

  1

  File component

  Base64

  base64-content

  Base64-encoded content of the file for inline file uploads

  Required

  False

  Datatype

  string

  Expected number

  1

  Filename

  filename

  Name of the file being uploaded

  Required

  True

  Datatype

  string

  Expected number

  1

  MIME type

  mime-type

  The file's MIME type such as application/pdf or image/jpeg

  Required

  False

  Datatype

  string

  Expected number

  1

  File size

  file-size

  Size of the file in bytes that can be used to enforce limits

  Required

  False

  Datatype

  integer

  Expected number

  1

• Required: True
• Datatype: object
• Expected number: 1
• Base64 base64-content:

  Base64-encoded content of the file for inline file uploads

  Required

  False

  Datatype

  string

  Expected number

  1

• Required: False
• Datatype: string
• Expected number: 1
• Filename filename:

  Name of the file being uploaded

  Required

  True

  Datatype

  string

  Expected number

  1

• Required: True
• Datatype: string
• Expected number: 1
• MIME type mime-type:

  The file's MIME type such as application/pdf or image/jpeg

  Required

  False

  Datatype

  string

  Expected number

  1

• Required: False
• Datatype: string
• Expected number: 1
• File size file-size:

  Size of the file in bytes that can be used to enforce limits

  Required

  False

  Datatype

  integer

  Expected number

  1

• Required: False
• Datatype: integer
• Expected number: 1

Where this is used

Fields

This component is used in 1 field:

• Documents