Onboarding Playbook (OB 1.0)

Download OpenAPI specification:Download

This page contains the essential endpoints of the InfoSum API that help users securely manage data throughout the onboarding process, allowing them to import, normalize, prepare, and publish data for analysis from cloud vaults to datasets. You can download the swagger file above or email solutions@infosum.com to share a Postman Collection.

InfoSum Support: support@infosum.com | Terms of Service | Official Documentation

We highly suggest that you complete your initial data onboarding in the UI first. Please contact your InfoSum representative to organize data onboarding training if this hasn’t happened yet. You will be able to create the setup together and have all the configurations you need to leverage the API. You can get an overview of data onboarding in the linked article.

Note on local file imports: We can support local file onboarding via the API but we discourage the use as it provides less flexibility, it’s harder to manage, and it has lower data privacy protections. If you wish to use local file imports via API please reach out to your InfoSum representative to discuss your setup.

Task List

Identify your server via an import connector configuration or ICC
Import the data to your Cloud Vault using an Importer
Confirm import was created successfully
Create a recordset of the data’s format
Confirm recordset was created successfully
List Normalization Configurations
Normalize the data (standardization)
Confirm normalization was created successfully
List Dataset Prepare Configurations
Prepare the data
Confirm bunker was prepared successfully
Publish the data to a Bunker
Confirm bunker was published successfully

Parameter Reference Table

Postman Step Number	ID Name	ID Structure	Where to find it	When to collect
1, 4, 7, 10	Cloud Vault ID	CLV.AWS_Region_selected.xx	in URL of Cloud Vaults page	Have ready before hand
2	Import ID	IMP.xx	in URL of Importing page, when an Importer has been selected	Have ready before hand
3	Import Execution ID	IMT.xx	Response from step 2	Can be grabbed from output of step 2
4	Recordset Config ID	RSC.xx	Go Recordset Configs on the Cloud Vault in URL of Recordset Configs, when a config has been selected	Have ready before hand
5	Recordset Execution ID	MRC.xx	Response from step 4	Can be grabbed from output of step 4
7	Recordset ID	RSC.xx	Response from step 5	Can be grabbed from output of step 5
6	Normalization Config Name	text	Dropdown Normalization Config on the Normalize page	Have ready before hand
7	Normalization Config ID	NMC.xx	Response from step 5	Can be grabbed from output of step 6
8	Normalization Execution ID	NMZ.xx	Response from step 7	Can be grabbed from output of step 7
9	Dataset Prepare Config Name	text-DD MMM YYYY - HH:MM	Automations page	When creating a dataset config, save the name Have ready before hand
10	Normalized Recordset ID	RCS.xx	Response from step 8	Can be grabbed from output of step 8
10	Dataset Prepare ID	AWS_Region_selected.xx	in URL of Datasets page, when a dataset is selected	Have ready before hand
10	Dataset Prepare Config ID	DPC.xx	Response from step 9	Can be grabbed from output of step 9
11, 12, 13	Prepare/Publish Execution ID	PUB.xx	Response from step 10	Can be grabbed from output of step 10

Onboarding

1. Get a Cloud Vault.

Get the details of a specific Cloud Vault.

Authorizations:

API_Key

path Parameters

Cloud Vault ID

required

string

Example: CLV.xx

ID of Cloud Vault you would like to upload file to

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"cloud_vault": {"created_by": "<string>",
"created_date_time": "<dateTime>",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"owner_id": "<string>",
"region": "<string>",
"updated_date_time": "<dateTime>"
}
}

2. Execute Import

Executes an import for the specified import ID.

Authorizations:

API_Key

path Parameters

Import ID

required

string

Example: IMP.xx

ID of the Importer used to import data from server

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"execution_id": "<string>"
}

3. Gets Import Execution

Gets a specific import execution.

Authorizations:

API_Key

path Parameters

execution_id

required

string

Example: IMT.xx

The ID of the Import execution task to retrieve.

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"execution_details": {"execution": {"cloud_vault_id": "<string>",
"created_date_time": "<dateTime>",
"current_status": "NO_STATUS",
"id": "<string>",
"import_id": "<string>",
"progress": {"completion_percentage": "<float>",
"speed": "<int64>",
"total_bytes": "<int64>",
"transferred_bytes": "<int64>"
},
"updated_date_time": "<dateTime>",
"user_id": "<string>"
},
"history": [{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"status": "NO_STATUS"
},
{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"status": "NO_STATUS"
}
]
}
}

4. Create a Recordset.

Create a recordset from files on a cloud vault. Valid characters for recordset names: alphanumeric, '_', '-', ' '.

Authorizations:

API_Key

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"cloud_vault_id": "Cloud Vault ID (CLV)",
"recordset_name": "RecordSet Name",
"config_id": "Recordset Config ID (RSC)",
"filepaths": ["CloudVault_Filename.csv"
]
}

Response samples

Content type

application/json

{"execution_id": "<string>"
}

5. Get a Recordset Execution.

Get the details of a specific recordset execution.

Authorizations:

API_Key

path Parameters

execution_id

required

string

Example: MRC.xx

The ID of the normalization execution to retrieve.

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"execution_details": {"cloud_vault_id": "<string>",
"config_id": "<string>",
"created_date_time": "<dateTime>",
"current_status": "NO_STATUS",
"execution_config": {"file_type": "AUTO",
"header_names": ["<string>",
"<string>"
],
"header_row": "<boolean>",
"primary_delimiter": "<string>",
"secondary_delimiter": "<string>"
},
"filepaths": ["<string>",
"<string>"
],
"history": [{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"status": "NO_STATUS"
},
{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"status": "NO_STATUS"
}
],
"id": "<string>",
"progress": {"completion_percentage": "<float>",
"lines_processed": "<int64>",
"malformed_lines": "<int64>",
"total_lines": "<int64>"
},
"recordset_id": "<string>",
"recordset_name": "<string>",
"updated_date_time": "<dateTime>",
"user_id": "<string>"
}
}

6. List company Normalization Configurations.

List company normalization configurations.

Authorizations:

API_Key

query Parameters

filter

string

Example: filter=name eq <Normalization Config Name>

Filter is a string containing logic that can specify a restricted set of Cloud Vaults to be returned. e.g. name co 'Test' or name co 'Acme'

The following values are permitted: name created_date_time (RFC3339 format) updated_date_time (RFC3339 format)

header Parameters

Accept

string

Example: application/json

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"configs": [{"created_date_time": "<dateTime>",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"updated_date_time": "<dateTime>"
},
{"created_date_time": "<dateTime>",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"updated_date_time": "<dateTime>"
}
],
"pagination": {"next_page": "<integer>",
"results": "<integer>",
"total_results": "<integer>"
}
}

7. Start a Normalization.

Start a normalization

Authorizations:

API_Key

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"cloud_vault_id": "Cloud Vault ID (CLV)",
"input_recordset_id": "RecordSet ID (RSC 2)",
"normalization_config_id": "Normalization Config ID (NMC)",
"output_recordset_name": "RecordSet Name",
"processing_speed": 1
}

Response samples

Content type

application/json

{"execution_id": "<string>"
}

8. Get a Normalization.

Get a normalization

Authorizations:

API_Key

path Parameters

execution_id

required

string

Example: NMZ.xx

Normalization Execution ID (NMZ) is the ID of the normalization execution.

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"normalization_details": {"history": [{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"status": "NO_STATUS"
},
{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"status": "NO_STATUS"
}
],
"normalization": {"cloud_vault_id": "<string>",
"config_id": "<string>",
"created_date_time": "<dateTime>",
"current_status": "NO_STATUS",
"id": "<string>",
"input_recordset_id": "<string>",
"output_recordset_id": "<string>",
"output_recordset_name": "<string>",
"processing_speed": "<long>",
"progress": {"completion_percentage": "<float>"
},
"updated_date_time": "<dateTime>",
"user_id": "<string>"
}
}
}

9. List company Dataset Prepare Configurations.

List company dataset prepare configurations

Authorizations:

API_Key

query Parameters

filter

string

Example: filter=name eq 'Dataset Prepare Config Name'

Filter is a string containing logic that can specify a restricted set of Cloud Vaults to be returned. e.g. name co 'Test' or name co 'Acme'

The following values are permitted: name created_date_time (RFC3339 format) updated_date_time (RFC3339 format)

header Parameters

Accept

string

Example: application/json

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"configs": [{"created_date_time": "<dateTime>",
"dataset_publish_config_summary": {"category_column_count": "<long>",
"export_column_count": "<long>",
"incremental_full_refresh": "<boolean>",
"key_column_count": "<long>",
"purge_expired_rows_only": "<boolean>",
"redaction_threshold": "<long>",
"rounding_threshold": "<long>"
},
"description": "<string>",
"id": "<string>",
"name": "<string>",
"updated_date_time": "<dateTime>",
"user_id": "<string>"
},
{"created_date_time": "<dateTime>",
"dataset_publish_config_summary": {"category_column_count": "<long>",
"export_column_count": "<long>",
"incremental_full_refresh": "<boolean>",
"key_column_count": "<long>",
"purge_expired_rows_only": "<boolean>",
"redaction_threshold": "<long>",
"rounding_threshold": "<long>"
},
"description": "<string>",
"id": "<string>",
"name": "<string>",
"updated_date_time": "<dateTime>",
"user_id": "<string>"
}
],
"pagination": {"next_page": "<integer>",
"results": "<integer>",
"total_results": "<integer>"
}
}

10. Start a Prepare on normalized data.

Start a Prepare Operation

Authorizations:

API_Key

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"cloud_vault_id": "Cloud Vault ID (CLV)",
"config_id": "Dataset Prepare Config ID (DPC)",
"dataset_id": "Dataset Prepare ID",
"recordset_id": "Normalized Recordset ID (RCS)"
}

Response samples

Content type

application/json

{"execution_id": "<string>"
}

11. Get details on a Prepare operation.

Get details on a Prepare operation.

Authorizations:

API_Key

path Parameters

execution_id

required

string

Example: PUB.xx

(Required) ExecutionID is the ID of the prepare execution to fetch.

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"prepare_details": {"history": [{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"prepare_status": "NO_STATUS",
"status": "NO_STATUS"
},
{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"prepare_status": "NO_STATUS",
"status": "NO_STATUS"
}
],
"prepare": {"cloud_vault_id": "<string>",
"config": {"category_selection": ["<int64>",
"<int64>"
],
"export_column_selection": ["<string>",
"<string>"
],
"incremental_full_refresh": "<boolean>",
"key_selection": ["<int64>",
"<int64>"
],
"purge_expired_rows_only": "<boolean>",
"redaction_threshold": "<long>",
"rounding_threshold": "<long>"
},
"config_embedded": {"category_selection": ["<int64>",
"<int64>"
],
"export_column_selection": ["<string>",
"<string>"
],
"incremental_full_refresh": "<boolean>",
"key_selection": ["<int64>",
"<int64>"
],
"purge_expired_rows_only": "<boolean>",
"redaction_threshold": "<long>",
"rounding_threshold": "<long>"
},
"config_id": "<string>",
"created_date_time": "<dateTime>",
"current_status": "NO_STATUS",
"dataset_id": "<string>",
"expiration_date_time": "<dateTime>",
"id": "<string>",
"prepare_status": "NO_STATUS",
"progress": {"completion_percentage": "<float>"
},
"recordset_id": "<string>",
"updated_date_time": "<dateTime>",
"user_id": "<string>"
}
}
}

12. Publishes prepared data to a dataset.

Publishes prepared data to a dataset.

Authorizations:

API_Key

path Parameters

execution_id

required

string

Example: PUB.xx

ExecutionID is the id of the prepare execution to publish to the dataset.

header Parameters

Accept

string

Example: application/json

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"execution_id": "<string>"
}

13. Get details on a Publish operation.

Get details on a Publish operation.

Authorizations:

API_Key

path Parameters

execution_id

required

string

Example: PUB.xx

(Required) ExecutionID is the ID of the publish execution to fetch.

header Parameters

Accept

string

Example: application/json

Responses

Response samples

Content type

application/json

{"prepare_details": {"history": [{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"prepare_status": "NO_STATUS",
"status": "NO_STATUS"
},
{"date_time": "<dateTime>",
"error": {"details": {"code": "<string>",
"message": "<string>"
},
"error": {"code": "<string>",
"message": "<string>"
},
"help_url": "<string>",
"request_id": "<string>",
"time": "<dateTime>"
},
"message": "<string>",
"prepare_status": "NO_STATUS",
"status": "NO_STATUS"
}
],
"prepare": {"cloud_vault_id": "<string>",
"config": {"category_selection": ["<int64>",
"<int64>"
],
"export_column_selection": ["<string>",
"<string>"
],
"incremental_full_refresh": "<boolean>",
"key_selection": ["<int64>",
"<int64>"
],
"purge_expired_rows_only": "<boolean>",
"redaction_threshold": "<long>",
"rounding_threshold": "<long>"
},
"config_embedded": {"category_selection": ["<int64>",
"<int64>"
],
"export_column_selection": ["<string>",
"<string>"
],
"incremental_full_refresh": "<boolean>",
"key_selection": ["<int64>",
"<int64>"
],
"purge_expired_rows_only": "<boolean>",
"redaction_threshold": "<long>",
"rounding_threshold": "<long>"
},
"config_id": "<string>",
"created_date_time": "<dateTime>",
"current_status": "NO_STATUS",
"dataset_id": "<string>",
"expiration_date_time": "<dateTime>",
"id": "<string>",
"prepare_status": "NO_STATUS",
"progress": {"completion_percentage": "<float>"
},
"recordset_id": "<string>",
"updated_date_time": "<dateTime>",
"user_id": "<string>"
}
}
}