Resource Document

A document is a set of items grouped by the same meta-information.

Range

A document contains zero or more items.

Domain

A document is contained in one or more domains.

A document is only contained in one source.

Meta-Information

The meta-information of a document may has (extracted from Research Object Bundle):

• id: universally unique message identifier (UUID) of the resource. It is mandatory.
• createdOn: The time the resource representation was created (e.g. when it was saved from an application). Should be present, in which case it must be a xsd:dateTime formatted timestamp (ISO 8601), and should include the time zone.
• createdBy: The creator of the resource representation (e.g. who saved it from an application). The creator is an agent, e.g. a person, organization or software. This may be different from the agent who conceptually formed the resource (e.g. wrote the document), which should be indicated with authoredBy. The creator should be an object with the following members:
  • name: The full name of the agent. The name must be present.
  • uri: A URI identifying the agent. The URI should be present, and should be a valid WebID.
  • orcid: An ORCID identifier for this agent. An ORCID may be present if known, and must be a URI.
• authoredOn: The time the resource was conceptually formed. The author time should be present if different from createdOn. The value must be a xsd:dateTime formatted timestamp (ISO 8601), and should include the time zone.
• authoredBy: The author of the resource, i.e. the agent(s) that conceptually formed its content. The author should be present if different from createdBy. The author should be a JSON object with the same members and requirements as for createdBy, but may be a list to indicate multiple authors.
• retrievedFrom: The absolute URI where a resource has been retrieved from. This property should be accompanied with retrievedOn and retrievedBy.
• retrievedOn: The time the resource was retrieved on. If this property is present, then retrievedFrom must also be present. The value must be a xsd:dateTime formatted timestamp (ISO 8601), and should include the time zone.
• retrievedBy: The agent that the resource was retrievedBy, i.e. the person that uploaded the resource using the UIA API. If this property is present, then retrievedFrom must also be present. The agent should be a JSON object with the same members and requirements as for createdBy.
• mediatype: The IANA media type of the resource.
• annotations: Annotations about this research resource. This member may be present, in which case it member must be a list. An annotation provides additional metadata or descriptions which are somewhat about or related to the research resource. An annotation is specified as an object, which have the following members:
  • uri: The identifier for this annotation. The identifier should be present, and should consist of the prefix urn:uuid: and a lowercased UUID string [RFC4122]. For example: urn:uuid:1a876f9e-4ffe-4c99-a05d-cd9d0cbd4cbb.
  • about: The identifier for the annotated resource. It must be present. This is considered the target of the annotation, the resource the annotation content is "somewhat about". The "about" identifier should be one of these types:
    • The research resource itself, which must match the value of its id.
    • Another annotation, which must match the uri as listed under annotations.