Getting Started

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

• The records and links being loaded through this API follow the same ingestion logic, as if you were loading the data through the Data Loader UI.
• The body or payload of the request consists of the Description, DataLoaderId, Origin, DaysToLive and list of Tables.

Table 1. Request properties

Property	Description
Description	Freeform description of the data being loaded
DataLoaderId	A value from the below list of valid DataLoaderIds
Origin	SimpleIngestion
DaysToLive	Number of days that the Bundle data and associated logs should remain before they are deleted
Tables	List of Json Table objects

Table 2. List of valid DataLoaderIds

Property	Description
Asset Criticality Analysis (ACA Checklist)	ACACheckListDataLoader
Asset Criticality Analysis (ACA)	ACAMatrixDataLoader
Asset Strategy Implementation (ASI)	AsiDataLoader
Asset Strategy Management (ASM)	AsmDataLoader
Asset Strategy Management (ASM) Template	AsmTemplateDataLoader
Calibration Management	CalibrationBatchDataLoader
Calibration Management - Functional Test	FuncTestCalibrationBatchDataLoader
Equipment and Functional Location Loader	EquipmentFunctionalLocationLoader
Failure Modes and Effects Analysis (FMEA)	FMEAAnalysisDataLoader
Failure Modes and Effects Analysis (FMEA) Analysis Templates	FMEAAnalysisTemplateDataLoader
Failure Modes and Effects Analysis (FMEA) Asset Templates	FMEAAssetTemplateDataLoader
Family Data Loader	FamilyDataLoader
GAA Wind Asset Hierarchy	GAAWindAssetHierarchyDataLoader
GAA Wind Events	GAAWindEventDataloader
GAA Wind Subgroup Capacity	GAAWindSubgroupCapacityDataLoader
Generation Availability Analysis (GAA) Events	GAAEventsDataLoader
Generation Availability Analysis (GAA) GADS Amplification Codes	GAAAmplificationCodeDataLoader
Generation Availability Analysis (GAA) GADS Cause Code	GAACauseCodeDataLoader
GIS Data Loader	GISDataLoader
Hazard Analysis	HazardAnalysisBatchDataLoader
Inspection Management (IM) Assets	IMBatchAssetDataLoader
Inspection Management (IM) Functional Location	IMBatchFLDataLoader
Link TMLs To Inspection Task	TMBatchLinkTMLsToInspectionTask
Policy Instance Data Loader	PolicyInstanceBatchDataLoader
Production Loss Analysis (PLA) 1 – Admin	PLAAdminBatchDataLoader
Production Loss Analysis (PLA) 2 – Event	PLAEventBatchDataLoader
Production Loss Analysis (PLA) 3 – Plan	PLAPlanBatchDataLoader
RBI Components to TML Groups Relationship	RBITMBatchDataLoader
Reliability Centered Maintenance (RCM)	RCMAnalysisDataLoader
Reliability Centered Maintenance (RCM) Analysis Template	RCMAnalysisTemplateDataLoader
Risk Based Inspection (RBI) 580	RBI580BatchDataLoader
Risk Based Inspection (RBI) 581	RBI581BatchDataLoader
Risk Based Inspection (RBI) Corrosion Loop	RBICorrosionLoopBatchDataLoader
Risk Matrix	RiskMatrixDataLoader
Role Data Loader	RolesDataLoader
Root Cause Analysis (RCA)	RCABatchDataLoader
Rounds Allowable Values	AllowableValuesBatchDataLoader
Rounds Pro - Picklist Dataloader	PicklistDataloader
Rounds Pro - Route Master Dataloader	RouteMasterDataloader
Rounds Pro - Step Conditions	StepConditionDataloader
Rounds Pro - Step Dataloader	StepDataloader
Rounds Pro - Step Reading	StepReadingDataloader
Rounds Pro - Step Template	StepTemplateDataloader
Rounds Readings	ReadingsBatchDataLoader
Rounds Routes	RouteBatchDataLoader
Rounds Templates and Template Groups	TemplateBatchDataLoader
Spares Analysis	SpareAnalysisDataLoader
System Reliability Data Loader	SystemReliabilityBatchDataLoader
Taxonomy Data Loader	TaxonomyLoader
Thickness Measurement - Assets	TMBatchThicknessMeasurementAssetsDataloader
Thickness Monitoring (TM) Equipment	TMBatchAssetDataLoader
Thickness Monitoring (TM) Functional Location	TMBatchFLDataLoader
Thickness Monitoring (TM) Piping Equipment	TMBatchPipingAssetDataLoader
Thickness Monitoring (TM) Piping Functional Location	TMBatchPipingFLDataLoader
Work History Loader	WorkHistoryLoader

Below is a sample payload for the FamilyDataLoader, but a similar pattern is followed when loading data through any data loader. You can see that the list of Tables directly coincides with the Worksheets in the source Data Loader Template.

{
  "Description": "Load Rotary Pump 76335",
  "DataLoaderId": "FamilyDataLoader",
  "Origin": "SimpleIngestion",
  "DaysToLive": 15,
  "Tables": [
    {
        "Name": "Configuration",
        "Table": [
        {
            "LOAD_DATA_WORKSHEET": "true",
            "DATA_WORKSHEET_ID": "Rotary_Pump",
            "BATCH_SIZE": "100",
            "PRIMARY_FAMILY_ID": "Rotary Pump",
            "PRIMARY_FAMILY_KEY_FIELDS": "ASSET_ID_CHR",
            "FAMILY_TYPE": "Entity",
            "PRED_FAMILY_ID": "<none>",
            "PRED_FAMILY_KEY_FIELDS": "<none>",
            "SUCC_FAMILY_ID": "<none>",
            "SUCC_FAMILY_KEY_FIELDS": "<none>",
            "PRIMARY_ACTION": "ACTION_INSERTUPDATE",
            "PRED_ACTION": "ACTION_NONE",
            "SUCC_ACTION": "ACTION_NONE",
            "OPTION_INSERT_ON_NULL": "true",
            "OPTION_UPDATE_ON_NULL": "true",
            "OPTION_REPLACE_EXISTING_LINK": "false",
            "OPTION_ALLOW_CHANGE_OF_FAMILY": "false",
            "ROW_ID": "3"
        }]
   },
   {
        "Name": "Rotary_Pump",
        "Table": [
        {
            "ASSET_ID_CHR": "RP-IMPELLER-76335",
            "ASSET_DESC_CHR": "Rotary Pump Impellers",
            "ASSET_MANUF_CHR": "Acme",
            "ASSET_CRIT_IND": "True",
            "AROT_FLWRT_NBR": 885.32
        },
        {
            "ASSET_ID_CHR": "RP-POWER-76335",
            "ASSET_DESC_CHR": "Rotary Pump Power Component",
            "ASSET_MANUF_CHR": "Acme",
            "ASSET_CRIT_IND": "False",
            "AROT_FLWRT_NBR": 7899.122
        }]  
   }
   ]
}