Create/Update an Entity

POST

Creates an entity.

Consumes

This API call consumes the application/json media type via the Content-Type request header.

Request Syntax

POST /v1/simpleIngest

Request Body

JSON

Usage Sample

{

   "Description": "Test Simple Ingestion",

   "Recipe":

   {

       "PrimaryPlan":

       {

          "KeyFieldIds": [

              "MI_EQUIP000_EQUIP_ID_C"

           ],

           "Id": "MI_EQUIP000",

           "Action": "ACTION_INSERTUPDATE",

           "Genealogy": "Primary",

          "FamilyType": "Entity",

          "GedaTypeName": "UNIFIED_ASSET__assettype"

       }

   },

   "Rows": [

   {

       "MI_EQUIP000_EQUIP_ID_C" : "PWR-APM-ASSET99",

      "MI_EQUIP000_SAP_SYSTEM_C" : "PRF-800",

      "MI_EQUIP000_UNIQUE_ID_C"                                   : "PRF-800-PWR-APM-ASSET99",

      "MI_EQUIP000_MAINT_PLANT_C"                             : "PRF-800",

       "MI_SITE_NAME" : "PRF-800"     

   }]

}

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": "9d1568a0-3147-45a3-ba93-e50fc2f05411",
"userld": "MIADMIN", "dataloaderld": "FamilyDataloader", "origin": "Simplelngestion",
"created": "2024-02-21T22:57:32.713",
"expires": "2024-02-23T22:57:32.713",
"status": "Completed",
"description": "Test Simple Ingestion", "recipe": {CJ},
"sliceCount": 1,
"latestTimeStamp": "2024-02-21T22:57:33.210",
"insertedRowCount": 0,
"updatedRowCount": 1,
"deletedRowCount": 0,
"rejectedRm.Count": 0, "skipSynchronization":alse, "manualRun": 1 e,
"progressPercentage": 100
},
"rejectedRows": [), "warningR011s": []
}
Table 1. Explanation of the response properties
PropertyDescription
id Bundle Id whichis 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