Document

Schema

id:

string, auto-generated, read-only

Internal identifier of the object within an array.

documentType:

string, optional

Possible values for Contract

  • notice - Contract notice

The formal notice that gives details of a contract being signed and valid to start implementation. This may be a link to a downloadable document, to a web page, or to an official gazette in which the notice is contained.

  • contractSigned - Signed Contract

A copy of the signed contract. Consider providing both machine-readable (e.g. original PDF, Word or Open Document format files), and a separate document entry for scanned-signed pages where this is required.

  • contractAnnexe - Annexes to the Contract

Copies of annexes and other supporting documentation related to the contract.

  • rejectionProtocol - Rejection Protocol

Documents containing the reasons for termination of work with the participant.

  • act - Act

Documents containing the reasons for termination of work with the participant.

  • approvalProtocol - Approval Protocol

Confirming the presence of the order on privatization.

title:

string, multilingual, required

OpenContracting Description: The document title.

description:

string, multilingual, optional

OpenContracting Description: A short description of the document. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

format:

string, optional

OpenContracting Description: The format of the document taken from the IANA Media Types code list, with the addition of one extra value for ‘offline/print’, used when this document entry is being used to describe the offline publication of a document.

url:

string, auto-generated, read-only

OpenContracting Description: Direct link to the document or attachment.

index:

integer, optional

Sorting (display order) parameter used for illustrations. The smaller number is, the higher illustration is in the sorting. If index is not specified, illustration will be displayed the last. If two illustrations have the same index, they will be sorted depending on their publishing date.

datePublished:

string, Date, auto-generated, read-only

OpenContracting Description: The date on which the document was first published.

dateModified:

string, Date, auto-generated, read-only

OpenContracting Description: Date that the document was last modified

language:

string, optional

OpenContracting Description: Specifies the language of the linked document using either two-digit ISO 639-1, or extended BCP47 language tags.

documentOf:

string, required

Possible values are:

  • contract
  • milestone
relatedItem:

string, required

Id of related Milestone