Document

A document as represented in the Family Graph API.

A family site can include media items such as photos, documents, videos, and audios. Individuals and events in the family tree can be associated to documents and other media items using tags. A document contains a file that is accessible via a url. Documents and other media items can be organized in albums in the family site.


Fields

The Document object contains the following fields:

Name Description Type Access Mode

id

The document's id

id

read

type

The media item type

string

read

name

The document's name (title)

string

read, write

date

The document's date

EventDate object: gedcom, text, date, structured_date and class_name fields

read, write

place

The document's place

string

read, write

description

The document's description

string

read, write

link

Link to document on MyHeritage.com

string

read

url

The url for the document

string

read

thumbnails

List of different thumbnails of different sizes for the document

array of Image objects containing the url, width, height and class_name fields

read

extension

The extension of the document's file name

string

read

submitter

The user who submitted the document to the site

User object: id and name fields

read

created_time

The time when the document was submitted to the site

string (YYYY-MM-DD HH:MM:SS)

read

updated_time

The date and time when the document was last updated on the site

string (YYYY-MM-DD HH:MM:SS)

read

site

The site of the document

Site object: id and name fields

read

source

Id of the document file part in format 'cid:<filename>'

string

write

class_name

The object class name

string

read

Connections

The Document object contains the following connections:
Name Description Type Access Mode

keywords

Keywords associated with the document

array of strings

read

items

List of objects that are associated with the document (individuals, families, events, family events and sources)

array of TreeItem objects

read

albums

List of albums the document is in

array of Album objects

read

tags

List of tags of individuals in the document

array of Tag objects

read

comments

List of comments associated with the media item

array of Comment objects

read

Example

https://familygraph.myheritage.com/document-144530322-1-1000009 (open in browser)
{
"id": "document-144530322-1-1000009",
"type": "document",
"name": "JFKs Moon Speech",
"date": {
"gedcom": "Sep 12 1962",
"text": "Sep 12 1962",
"date": "1962-09-12",
"structured_date": {
"first_date": {
"day": 12,
"month": 9,
"year": 1962,
"type": "exact",
"class_name": "SingleDate"
},
"type": "exact",
"class_name": "StructuredDate"
},
"class_name": "EventDate"
},
"link": "https:\/\/www.myheritage.com\/document-1000009_144530322_144530322\/jfks-moon-speech",
"url": "https:\/\/www.myheritageimages.com\/D\/storage\/site144530322\/files\/00\/00\/09\/000009_4614646pof4gd42b425bgv.doc",
"thumbnails": [
{
"url": "https:\/\/www.myheritageimages.com\/Z\/storage\/site144530322\/files\/00\/00\/09\/000009_31572441dy19c5b7f7l6p6.jpg",
"width": 111,
"height": 142,
"class_name": "Image"
},
{
"url": "https:\/\/thumbnail.myheritageimages.com\/530\/322\/144530322\/000\/000009_31572441dy19c5b7f7l6p6_Z_31x40.jpg",
"width": 31,
"height": 40,
"class_name": "Image"
}
],
"extension": "doc",
"submitter": {
"id": "user-10",
"name": "Developer MyHeritage"
},
"created_time": "2011-03-03T16:01:15+0000",
"updated_time": "2011-03-03T16:01:15+0000",
"site": {
"id": "site-144530322",
"name": "Demo Family Site"
},
"class_name": "Document"
}