Update Records
|
Method
|
PUT
|
|
URLs
|
/v2/<object_full_identifier>/<record_uuid> (one record), /v2/<object_full_identifier> (many records)
|
|
Parameters
|
|
|
Response Content Type
|
application/json
|
Update Single Records
The request body is a JSON representation of a Map of <field_full_identifier, value> for each field to be set in the record to be updated.
Input Example
PUT https://<server>/v2/io_showcase/84a33b7e-833a-47da-95ed-8da49ee9eeb0
{
"io_name": "showcase new2",
"io_supported_languages": null,
"io_search_filter_language": null,
"io_showcase_number": "233.3",
"io_release": "759db0ad-ab90-441c-a7b7-8e2028b26edc",
"io_showcase_quantity": "66 dd574d5a-c7bf-11e0-b724-001ec950a80f",
.
.
}
{
"io_name": "showcase new2",
"io_supported_languages": null,
"io_search_filter_language": null,
"io_showcase_number": "233.3",
"io_release": "759db0ad-ab90-441c-a7b7-8e2028b26edc",
"io_showcase_quantity": "66 dd574d5a-c7bf-11e0-b724-001ec950a80f",
.
.
}
Response Example
The response is a JSON representation of the updated record. Following is an example Status Code 200 response for the Showcase object.
{
"io_uuid":"84a33b7e-833a-47da-95ed-8da49ee9eeb0",
"io_showcase_phone_number": "+1 (925) 965-7859"
"io_search_filter_file_object": null
"io_owner": "baa32325-5f0e-43a5-9976-43b25e847ab4"
"io_showcase_document": null
"io_private": false,
....
}
"io_uuid":"84a33b7e-833a-47da-95ed-8da49ee9eeb0",
"io_showcase_phone_number": "+1 (925) 965-7859"
"io_search_filter_file_object": null
"io_owner": "baa32325-5f0e-43a5-9976-43b25e847ab4"
"io_showcase_document": null
"io_private": false,
....
}
Update Multiple Records
The request body is a JSON representation of an array of Map of <field_full_identifier, value> for each field to set and record to update.
Input Example
 |
In each Map, the io_uuid field must point to existing records to specify which record to update.
|
PUT https://<server>/v2/io_showcase/
[ {
"io_uuid":"84a33b7e-833a-47da-95ed-8da49ee9eeb0",
"io_name": "showcase new2",
"io_supported_languages": null,
"io_search_filter_language": null,
"io_showcase_number": "233.3",
"io_release": "759db0ad-ab90-441c-a7b7-8e2028b26edc",
"io_showcase_quantity": "30 dd574d5a-c7bf-11e0-b724-001ec950a80f",
.
.
},
{"io_uuid":"99a55b7e-833a-47da-95ed-8da49ee96344",...},{...}...
]
[ {
"io_uuid":"84a33b7e-833a-47da-95ed-8da49ee9eeb0",
"io_name": "showcase new2",
"io_supported_languages": null,
"io_search_filter_language": null,
"io_showcase_number": "233.3",
"io_release": "759db0ad-ab90-441c-a7b7-8e2028b26edc",
"io_showcase_quantity": "30 dd574d5a-c7bf-11e0-b724-001ec950a80f",
.
.
},
{"io_uuid":"99a55b7e-833a-47da-95ed-8da49ee96344",...},{...}...
]
Response Example
The response is a JSON representation of an array of updated records. Following is an example Status Code 200 response for the Showcase object.
[{
"io_uuid":"84a33b7e-833a-47da-95ed-8da49ee9eeb0",
"io_showcase_phone_number": "+1 (925) 965-7859"
"io_search_filter_file_object": null
"io_owner": "baa32325-5f0e-43a5-9976-43b25e847ab4"
"io_showcase_name": "showcase 1",
"io_private": false,
....
}, {
"io_uuid":"99a55b7e-833a-47da-95ed-8da49ee96344",
"io_showcase_phone_number": "+1 (925) 965-7859"
"io_search_filter_file_object": null
"io_owner": "baa32325-5f0e-43a5-9976-43b25e847ab4"
"io_showcase_name": "showcase 2",
"io_private": false,
....
}, {...}, {....},...
]
"io_uuid":"84a33b7e-833a-47da-95ed-8da49ee9eeb0",
"io_showcase_phone_number": "+1 (925) 965-7859"
"io_search_filter_file_object": null
"io_owner": "baa32325-5f0e-43a5-9976-43b25e847ab4"
"io_showcase_name": "showcase 1",
"io_private": false,
....
}, {
"io_uuid":"99a55b7e-833a-47da-95ed-8da49ee96344",
"io_showcase_phone_number": "+1 (925) 965-7859"
"io_search_filter_file_object": null
"io_owner": "baa32325-5f0e-43a5-9976-43b25e847ab4"
"io_showcase_name": "showcase 2",
"io_private": false,
....
}, {...}, {....},...
]
Error Response Messages
|
HTTP Status Code
|
Error Type
|
Error Detail
|
|---|---|---|
|
400
|
missing_parameter_error
|
The body of the request did not contain valid data to update one record
|
|
400
|
missing_parameter_error
|
The body of the request did not contain a list of data to update records
|
|
400
|
missing_parameter_error
|
The body of the request contained data for a record without a UUID
|
|
400
|
invalid_parameter_error
|
Error Updating Records. Error: ...
|
|
400
|
entity_validation_error
|
Validation error(s) details
|
|
400
|
operation_error
|
Error Updating Record. Error: ...
|
|
404
|
entity_not_found
|
The body of the request contained data for a record that could not be found <UUID>
|
|
404
|
entity_not_found
|
Entity not found UUID: ...
|
|
500
|
server_error
|
Server error
|
For more information: