Getting Started

This API is subject to all requirements and constraints of the existing WebApi endpoints, specifically, authentication, authorization, localization, globalization, and serialization.

Both the records/entities and relationships/connections can be created or updated through the API
The payload consists of two high level categories:
- Recipe: This contains Plan sections that define the PrimaryPlan, PredecessorPlan, and SuccessorPlan.
- Rows: This contains records that are to the ingested.

Recipe

Provide the following information in the recipe section:

PrimaryPlan: Defines the family or relationship for the primary records and the associated action.
PredecessorPlan: Defines the predecessor family details of the relationship and the associated action.
SuccessorPlan: Defines the sucessor family details of the relationship and the associated action.

The following items are defined for each plan:

Id: Faimly or Relationship name
Action: ACTION_LOCATE, ACTION_INSERTUPDATE. For more information, refer to the section, About the Configuration Worksheet, in the Data Loaders documentation.
Genealogy: Primary, Predecessor, or Succesor
FamilyType: Entity or Relationship
GedaTypeName: This field will be blank for the on-premise application.
KeyFields: Lists the family fields that need to be considerd as the key fields for the insert or update. For inserting relationship rows, this field will be empty for the PrimaryPlan.

Rows

In the row section, provide the data for ingestion. For data upload to a Family, the values need to be provided for each field. For the relationship, the fields need to be prefixed by either “PRED|” or “SUCC|” as a qualifier.

The response will be the Bundle ID of the ingestion along with additional information.