Resources

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

Try it out!

name path methods description
FamilyMembersController
  • /family-members/{coupleId}/children
  • /family-members/{personId}/parents
  • /family-members/{personId}/spouses
  • GET
  • GET
  • GET
Responsible for endpoints to manage family member data for persons in Assisted Tree Building
PedigreeController
  • /pedigree/canned
  • /pedigree/{compositePersonId}
  • GET
  • GET
Responsible for the endpoints to manage pedigrees in Assisted Tree Building
PersonController
  • /person/
  • /person/bulk
  • /person/bulk-s3
  • /person/canned
  • /person/copy-ids-to-s3
  • /person/random-ids
  • /person/search
  • /person/search-quality-data
  • /person/{personId}
  • /person/lookup/{sourceId}
  • /person/lookup-item/{sourceId}
  • /person/{personId}/parents
  • /person/{personId}/raw
  • /person/{personId}/preferredSpouse/{spouseId}
  • POST
  • POST
  • POST
  • GET
  • PUT
  • GET
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • POST
  • GET
  • POST
Responsible for endpoints related to reading/writing person data
PipelineDataController
  • /pipeline-data/graph-pairs
  • /pipeline-data/graph-scores-ark1-ark2
  • /pipeline-data/load-graph-pairs
  • /pipeline-data/load-graph-scores
  • /pipeline-data/load-input-mobs
  • /pipeline-data/load-status
  • /pipeline-data/load-tree
  • /pipeline-data/load-tree-attachments
  • /pipeline-data/record-load-failure
  • /pipeline-data/record-load-success
  • /pipeline-data/scale-web-servers
  • /pipeline-data/graph-pairs-all/{ark}
  • /pipeline-data/graph-scores/{ark}
  • /pipeline-data/input-mob/{mobId}
  • /pipeline-data/tree-attachments/{ark}
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
QualityDataController
  • /quality-data/
  • /quality-data/bulk
  • /quality-data/bulk-s3
  • /quality-data/{personId}
  • /quality-data/flags/bulk
  • /quality-data/flags/bulk-s3
  • /quality-data/metrics/bulk
  • /quality-data/metrics/bulk-s3
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
RemoteLoggingController
  • /remote-logging
  • /remote-logging/metrics
  • POST
  • POST
VersionCatalogController
  • /version-catalog
  • /version-catalog/reset-local-database
  • /version-catalog/{versionname}
  • /version-catalog/add-child/{versionname}
  • /version-catalog/add-parent/{versionname}
  • /version-catalog/add-property/{versionname}
  • /version-catalog/current-version/{versionname}
  • /version-catalog/log-quality-metrics/{versionname}
  • /version-catalog/observed-flags/{versionname}
  • /version-catalog/quality-metrics/{versionname}
  • GET POST PUT
  • DELETE
  • DELETE GET
  • PUT
  • PUT
  • PUT
  • PUT
  • GET
  • GET
  • GET

Data Types

JSON

type description
AtbChildren
AtbConclusion
AtbConclusionDetails
AtbCouple
AtbDate
AtbParentCouple
AtbParents
AtbPedigree
AtbPerson
AtbPlace
AtbSpouse
AtbSpouses
BCulture
BDate
BFact
BHalfCentury
BName
BPerson
BPlace
BStandardPlace
BobId
BobSystem
Flag
FlagCount
FsFactType
GenderType
GraphPair
GraphPairEncoding
GraphPairNeighbor
GraphScore
InputMob
LogItem
LookupItem
Metric
MetricSearchSpec
MetricsLogItem
NameDelimiter
ObservedFlagCounts
Person
PersonBob
PersonBobList
PersonCard
PersonQualityData
PersonQualityDataList
PersonQualityFlags
PersonQualityFlagsList
PersonQualityMetrics
PersonQualityMetricsList
PreferredParent
PreferredParents
QualityDataSearchResult
QualityDataSearchSpec
SearchResult
SearchSpec
StdScript
TreeAttachment
VersionCatalogItem