Create/Update a Relationship
POST
Creates or updates a relationship.
Consumes
This API call consumes the application/json media types via the Content-Type request header.
Request Syntax
POST /v1/simpleIngest
Request Body
JSON
Request Example
{
"Description": "Test Simple Ingestion Relationship",
"Recipe":
{
"PrimaryPlan":
{
"KeyFieldIds": [
],
"Id": "MIR_EQHSEQ",
"Action": "ACTION_INSERTUPDATE",
"Genealogy": "Primary",
"FamilyType": "Relationship",
"GedaTypeName": "assettype_assettype"
},
"PredecessorPlan":
{
"KeyFieldIds": [
"MI_EQUIP000_EQUIP_ID_C",
"MI_EQUIP000_SAP_SYSTEM_C"
],
"Id": "MI_EQUIP000",
"GedaTypeName" : "UNIFIED_ASSET__assettype",
"Action": "ACTION_INSERTUPDATE",
"Genealogy": "Predecessor",
"FamilyType": "Entity"
},
"SuccessorPlan":
{
"KeyFieldIds": [
"MI_EQUIP000_EQUIP_ID_C",
"MI_EQUIP000_SAP_SYSTEM_C"
],
"Id": "MI_EQUIP000",
"GedaTypeName" : "UNIFIED_ASSET__assettype",
"Action": "ACTION_INSERTUPDATE",
"Genealogy": "Successor",
"FamilyType": "Entity"
}
},
"Rows": [
{
"PRED|MI_EQUIP000_EQUIP_ID_C": "PWR-APM-ASSET97",
"PRED|MI_EQUIP000_SAP_SYSTEM_C": "PRF-800",
"PRED|MI_EQUIP000_UNIQUE_ID_C": "PRF-800-PWR-APM-ASSET97",
"SUCC|MI_EQUIP000_EQUIP_ID_C": "PWR-APM-ASSET99",
"SUCC|MI_EQUIP000_SAP_SYSTEM_C": "PRF-800",
"SUCC|MI_EQUIP000_UNIQUE_ID_C": "PRF-800-PWR-APM-ASSET99"
}
]
}Return Type
200 OK
Produces
This API call produces the application/json media type according to the Accept request header. The media type will be conveyed by the Content-Type response header.
Success Response
"bundle": {
"id": "827782f7-2867-4176-8a38-52c44b166340", "userId": "MIADMIN",
"dataloaderld": "FamilyDataloader", "origin": "Simpleingestion", "created": "2024-02-21T22:01:48.782",
"expires": "2024-02-23T22:01:48.782",
"status": "Completed",
"description": "Test Simple Ingestion Relationship", "recipe": { },
"sliceCount": 1,
"latestTimeStamp": "2024-02-21T22:01:49.820",
"insertedR01-1Count": 1,
"updatedRowCount": 0,
"deletedRowCount": 0,
"rejectedR01,1Count": 0, "skipSynchronization": calse, "manualRun": "progressPercentage": 100
},
"rejectedRm,is": [],
"warningR01-1s": []
| Property | Description |
|---|---|
| id | Bundle Id which is represented by a GUID |
| userId | User that ingested the data |
| dataLoaderId | Data Loader used to ingest the data |
| origin | SimpleIngestion |
| created | DateTime of when the Bundle was created |
| expires | DateTime of when the Bundle will be removed from the database |
| status | (Started, Failed, Completed, CompletedWithRejects, CompletedWithWarnings) |
| description | Description provided by the user |
| recipe | Compilation of ingestion instructions received in the configuration plans |
| sliceCount | Number of Slices in the Bundle |
| latestTimeStamp | DateTime of the latest update |
| insertedRowCount | Number of rows inserted |
| updatedRowCount | Number of rows updated |
| deletedRowCount | Number of rows deleted |
| rejectedRowCount | Number of rows rejected |
| skipSynchronization | Skip the synchronization step |
| manualRun | Data ingested manually |
| progressPercentage | Bundle ingestion progress expressed as a percentage |
| rejectedRows | List of rejected rows |
| warningRows | List of warning rows |