Read Object Records by UUID
|
Method
|
GET
|
|
URL
|
/v2/<object_full_identifier>/<record_uuid>
|
|
Parameters
|
fields, incomingRelationships, data_format, ignore_delete. suppress_ror
|
|
Response Content Type
|
application/json
|
Response Example
The response is a JSON representation of the record. Following is an example Status Code 200 response for a Showcase record in default output format:
{
"__object_identifier": "io_showcase",
"io_showcase_phone_number": "+1 (650) 123456",
"io_search_filter_file_object": null,
"io_owner": "bbbf0872-b9dc-11e0-adfd-00ff8314382b",
"io_showcase_document": null,
"io_private": false,
"io_platform_changes_permitted": null,
.
.
}
"__object_identifier": "io_showcase",
"io_showcase_phone_number": "+1 (650) 123456",
"io_search_filter_file_object": null,
"io_owner": "bbbf0872-b9dc-11e0-adfd-00ff8314382b",
"io_showcase_document": null,
"io_private": false,
"io_platform_changes_permitted": null,
.
.
}
 |
Each returned record includes the __object_identifier pseudo-field, which contains the full identifier of the object to which the record belongs.
|
Parameters
|
Parameter
|
Description
|
Data Type
|
Example
|
|---|---|---|---|
|
fields
|
Object fields to be retrieved. Eager loading is supported in depth, and related record fields can be eager-loaded if relationships between records exist.
If not specified, all object fields are retrieved by default.
|
String
|
Retrieve only the uuid, owner, private, active and deleted fields for each record:
/v2/<object_full_identifier>/<record_uuid>?fields=io_uuid,io_owner,io_private,io_active,io_deleted
|
|
incomingRelationships
|
Incoming relationships of the object to use to retrieve related records.
|
String
|
Retrieve the related records for the application_log_related_to incoming relationship for each record:
/v2/<object_full_identifier>?incomingRelationships=application_log_related_to
In cases where the same identifier is used for multiple relationships, one approach is to specify <source_object_full_identifier>,<relationship_full_identifier>, for example:
/v2/io_user/<record_uuid>?incomingRelationships=io_role_io_users,io_group_io_users
Alternatively, you can add a reverse identifier to the io_users relationship, for example, io_roles, and specify the reverse identifier instead:
/v2/io_user/<record_uuid>?incomingRelationships=io_roles
|
|
data_format
|
The output data format. Supported values are basic (default) and extended.
The basic format corresponds to the example response shown above. The extended format includes additional information for specific data types. For more information, see Extended Output Data Format.
|
String
|
Retrieve a record in the extended output data format:
/v2/<object_full_identifier>/<record_uuid>?data_format=extended
|
|
ignore_delete
|
Set this flag to specify whether to ignore deleted records or retrieve logically deleted records. The default value is false.
|
Boolean
|
Retrieve a record that was previously logically deleted:
/v2/<object_full_identifier>/<record_uuid>?ignore_delete=true
|
|
suppress_ror
|
Whether to bypass recalculation for recalculate-on-read fields.When specified, RoR fields are read instead of recalculated, and their values are returned from the database.
|
Boolean
|
Retrieve a record with recalculate-on-read suppressed:
/v2/<object_full_identifier>/<record_UUID>?suppress_ror=true
|
For more information: