Documents

A document is a single instance of a resource, e.g. a user is a document of the instance users. Every document has a _meta object, which can't be modified. In most cases, fields outside of the _meta object can be modified.

Keep in mind Some fields outside of the _meta object should not be modified, because doing so could corrupt the document or resource. Please don't modify a field if you're not sure what its for.

Metadata of document

The document _meta object contains metadata about the document.

Property	Type	Contract	Description
index	string	required	The resource / index where the document is stored.
guid	string	required	The globally unique identifier of the document.
created	integer	required	Timestamp in milliseconds of when the document was created.
updated	integer	required	Timestamp in milliseconds of the last change to the document.
removed	integer	required	Timestamp in milliseconds of when the document was removed, 0 if not removed.
expiry	integer	required	Timestamp in milliseconds of when the document will expire, 0 if no expiry is set.
created_by.host	string	required	Hostname of server that created the document.
created_by.resource.name	string	optional	Name of resource that created the document.
created_by.resource.guid	string	optional	The guid of the resource that created the document.
created_by.resource.index	string	optional	The resource / index of the resource that created the document.