Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AdminService
  • /admin
  • /admin/cells
  • /admin/health
  • /admin/live
  • /admin/volumes
  • /admin/writable
  • /admin/apids/{storageCellID}
  • /admin/apidsperday/{date}
  • /admin/cells/{cellname}
  • /admin/db/connections
  • /admin/db/pool
  • /admin/modifications/{date}
  • /admin/moveapids/{storageCellID}
  • GET
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
  • DELETE GET
  • GET
  • GET
Handle admin requests
AliveService
  • /healthcheck/heartbeat
  • /healthcheck/heartbeat/checked
  • DELETE GET POST
  • GET
ArtifactService_v1
  • /v1/exists
  • /v1/{nodeLocator}
  • /v1/{nodeLocator}/children
  • /v1/{nodeLocator}/streams
  • /v1/{nodeLocator}/{streamName}
  • /v1/{nodeLocator}/{streamName}/data
  • POST
  • DELETE GET HEAD PUT
  • GET
  • GET
  • DELETE HEAD POST PUT
  • GET
Handle Node namespace
ArtifactService_v2
  • /v2/exists
  • /v2/live
  • /v2/readonly
  • /v2/{nodeLocator}
  • /v2/forward/{nodeLocator}
  • /v2/{nodeLocator}/children
  • /v2/{nodeLocator}/copy
  • /v2/{nodeLocator}/exists
  • /v2/{nodeLocator}/location
  • /v2/{nodeLocator}/locations
  • /v2/{nodeLocator}/move
  • /v2/{nodeLocator}/name
  • /v2/{nodeLocator}/parents
  • /v2/{nodeLocator}/permission
  • /v2/{nodeLocator}/purge
  • /v2/{nodeLocator}/redact
  • /v2/{nodeLocator}/security
  • /v2/{nodeLocator}/size
  • /v2/{nodeLocator}/streams
  • /v2/{nodeLocator}/streamsdata
  • /v2/{nodeLocator}/{children}
  • /v2/{nodeLocator}/{streamName}
  • /v2/{replica}/cell
  • /v2/forward/{nodeLocator}/{targetApid}
  • /v2/{nodeLocator}/db/{cell}
  • /v2/{nodeLocator}/location/db
  • /v2/{nodeLocator}/{streamName}/data
  • POST
  • GET
  • GET POST
  • DELETE GET HEAD POST PUT
  • DELETE
  • GET
  • POST
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • DELETE
  • POST
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • GET
  • DELETE GET HEAD POST PUT
  • GET
  • PUT
  • DELETE
  • GET
  • GET
Handle Node namespace
PendingDeleteService
  • /pending-deletes/{cellName}
  • /pending-deletes/{cellName}/{apid}
  • DELETE GET POST
  • DELETE HEAD POST
Handle Node namespace
SecurityService
  • /security/v2/children
  • /security/v2/restrictions
  • /security/v2/root
  • /security/v2/{nodeLocator}
  • /security/v2/{nodeLocator}/actions
  • /security/v2/{nodeLocator}/cas
  • /security/v2/{nodeLocator}/children
  • /security/v2/{nodeLocator}/parent
  • /security/v2/{nodeLocator}/permission
  • /security/v2/{nodeLocator}/properties
  • GET POST
  • POST
  • GET
  • DELETE GET
  • GET PUT
  • GET
  • GET
  • GET PUT
  • GET
  • GET PUT
ThrottleService
  • /throttle
  • DELETE GET POST
Handle throttle information

Data Types

JSON

type description
Actions Used to get and set security actions on a node
AdminData
Apid Used by get, put, create security parent and get Security Root Apid
ApidList
ApidsByGroup Apids by user
ArtifactBase
ArtifactChild
ArtifactChildren Data representation of a node's children - transfer object

Used to return data about an node's children when accessing chilren resource, e.g. http://10.10.10.10/das/v1/dgs:root/children

ArtifactParent
ArtifactSecurity
AuditSettings
AuditStatus
CellData
Child Data representation of a node's child - transfer object

Used by the ChildrenData class which is used to return data about an node's children

ChildrenData Data representation of a node's children - transfer object

Used to return data about an node's children when accessing chilren resource, e.g. http://10.10.10.10/das/v1/dgs:root/children

ChildrenExist Used to get/return if children exist for a node
ChildrenExistsItem Child name and whether it exists
ExistsData Data representation of information about whether a node exists or not - transfer object
ExistsList Data representation of the node existence information - transfer object
ExistsListQuery Data representation of the nodes whose existence is to be tested - transfer object
GroupApids
IndexNameEntry Created by Tim Painter on 2/1/16.
IndexNameList Created by Tim Painter on 1/28/16.
JaxbLink
Location Contains list of locations, ie 127.0.0.1:/mnt/storagecell/small/WK-dgsrootapid
LocationData
Locations
NodeData Data representation of the a node - transfer object
NodeSize
ParentData
ParentsData
PendingDelete Created by Tim Painter on 12/3/2014.
PermissionData
PurgeResult
PurgeStatus
ReplicaData
RestrictData
RestrictNode
SecurityChildren Security node children apids
SecurityNode Security node data, actions, child count, security parent, apid
SecurityProperty
SecurityPropertyList
StatisticData
Stream Data representation of a node's stream - transfer object
StreamData Data representation of data about a stream - transfer object
StreamDataList
Streams Data representation of a nodes streams - transfer object
StringList
ThrottleData
ThrottleListItem Created by Tim Painter on 4/18/17.
ThrottlePatternItem

XML

Default Namespace (schema)
type description
jaxbLink
Namespace http://digitalarchive.familysearch.org/v1 (schema)
type description
childrenExist Used to get/return if children exist for a node
childrenExistsItem Child name and whether it exists
existsData Data representation of information about whether a node exists or not - transfer object
existsList Data representation of the node existence information - transfer object
existsListQuery Data representation of the nodes whose existence is to be tested - transfer object
location Contains list of locations, ie 127.0.0.1:/mnt/storagecell/small/WK-dgsrootapid
locationData
locations
parentsData
actions Used to get and set security actions on a node
adminData
apid Used by get, put, create security parent and get Security Root Apid
apidsByGroup Apids by user
artifactBase
artifactChild
artifactChildren Data representation of a node's children - transfer object

Used to return data about an node's children when accessing chilren resource, e.g. http://10.10.10.10/das/v1/dgs:root/children

artifactParent
artifactSecurity
auditSettings
auditStatus
cellData
groupApids
permissionData
purgeResult
purgeStatus
replicaData
restrictData
restrictNode
securityChildren Security node children apids
securityNode Security node data, actions, child count, security parent, apid
securityProperty
securityPropertyList
statisticData
apidList
child Data representation of a node's child - transfer object

Used by the ChildrenData class which is used to return data about an node's children

childrenData Data representation of a node's children - transfer object

Used to return data about an node's children when accessing chilren resource, e.g. http://10.10.10.10/das/v1/dgs:root/children

nodeData Data representation of the a node - transfer object
nodeSize
parentData
stream Data representation of a node's stream - transfer object
streamData Data representation of data about a stream - transfer object
streamDataList
streams Data representation of a nodes streams - transfer object
stringList