ON THIS PAGE
POST /reference_data/tables/bulk_load/{namespace}/{name}/{domain_id}
SUMMARY Adds or updates data in a reference table.
Adds or updates data in a reference table.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
namespace |
path |
Required |
String |
text/plain |
Required - Either SHARED or TENANT. |
name |
path |
Required |
String |
text/plain |
Required - The name of table to add or update data in. |
domain_id |
path |
Required |
String |
text/plain |
Required - Specify the numeric domain_id tag for the data or SHARED for Admin users. Must be a domain ID for which the caller has access. |
fields |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
data |
Array |
application/json |
Required - The JSON-formatted data to add or update in the reference table. |
{"key1":{"col1":"Data11","col2":"Data12","col3":"Data13","col4":"Data14"}, "key2":{"col1":"Data21","col2":"Data22","col3":"Data23","col4":"Data24"}, "key3":{"col1":"Data31","col2":"Data32","col3":"Data33","col4":"Data34"}, "key4":{"col1":"Data41","col2":"Data42","col3":"Data43","col4":"Data44"}, "key5":{"col1":"Data51","col2":"Data52","col3":"Data53","col4":"Data54"}, "key6":{"col1":"Data61","col2":"Data62","col3":"Data63","col4":"Data64"}} |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
Data was successfully added or updated in the reference table. |
|
400 |
1001 |
An error occurred parsing the JSON-formatted message body. |
404 |
1002 |
The reference table does not exist. |
404 |
1011 |
Domain not found |
422 |
1005 |
A request parameter is not valid. |
422 |
1012 |
The namespace value of SHARED was expected |
422 |
1014 |
The domain_id parameter must be specified |
422 |
1015 |
The namespace parameter must be either SHARED or TENANT |
500 |
1020 |
An error occurred during the attempt to add or update data in the reference table. |
Response Description
Information about the reference table where data was added or updated. This returns information about the reference table but not the data that it contains.
Response Sample
{ "collection_id": 42, "creation_time": 42, "element_type": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>", "key_label": "String", "key_name_types": { "String": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>" }, "name": "String", "namespace": "String <one of: PRIVATE, SHARED, TENANT>", "number_of_elements": 42, "time_to_live": "String", "timeout_type": "String <one of: UNKNOWN, FIRST_SEEN, LAST_SEEN>" }