Extended Output Data Format
You can specify output data formats by using the data_format parameter. Supported values are basic (default) and extended. In extended format, data includes additional information for the following data types:
• Option List
• Currency Amount
• Quantity
• Document
• Image
• Status
• Relationships (referential static and dynamic, master, and hierarchical)
Response Example
Following is an example response for a Showcase record in extended output format:
{
"__object_identifier": "io_showcase",
"io_uuid": "41f19ff6-2738-4000-8bfd-a18950caa1d1",
"io_supported_languages": null,
"io_path": null,
"io_updated_by": <-- Output data for Relationship datatype
"__object_identifier": "io_user",
"__primary_name_field": "io_full_name",
"io_uuid": "f7c60684-f87d-4bda-af8a-af8a23f7da3b",
"io_full_name": "Juan Olguin",
"io_deleted": false
},
"io_showcase_dynamic_relationship": { <-- Output data for Dynamic Relationship datatype
"__object_identifier": "io_user",
"__primary_name_field": "io_full_name",
"io_uuid": "764f0869-8b2a-4e43-8f23-88f593863eff",
"io_full_name": "System Administrator",
"io_deleted": false
},
"io_showcase_option_list": { <-- Output data for Option List (with single selection) datatype
"options": {
"ad9bebb4-271c-4eb4-9706-8e6b91bece5f": {
"option_identifier": "option_one",
"option_name": "Option 1"
}
}
},
"io_showcase_multiselect_option_list": { <-- Output data for Option List (with multiple selection) datatype
"options": {
"68e86df4-2c07-48dd-992f-a2e6b9d5c2a8": {
"option_identifier": "option_two",
"option_name": "Option 2"
},
"277f6bae-da5f-4bd9-abfd-cc27577ff90d": {
"option_identifier": "option_three",
"option_name": "Option 3"
}
}
},
"io_showcase_quantity": { <-- Output data for Quantity datatype
"amount": 1888,
"unit_symbol": "s",
"unit_name": "seconds"
},
"io_showcase_currency_amount": { <-- Output data for Currency Amount datatype
"amount": 248,
"currency_symbol": "$",
"currency_position": "5e64c122-e4ec-4913-8606-a8ac4c65f6de",
"currency_precision": 2,
"currency_alphabetic_code": "USD"
},
"io_showcase_image": { <-- Output data for Image datatype
"__object_identifier": "io_document",
"__primary_name_field": "io_name",
"io_uuid": "b43d607f-6e1c-4098-abb1-475030a3488a",
"io_name": "2015-SMX-logo.png"
},
"io_status": { <-- Output data for Status datatype
"status_name": "Canceled"
}
.
.
.
}
Error Response Messages
|
HTTP Status Code
|
Error Type
|
Error Message
|
|
400
|
missing_parameter_error
|
Missing or invalid required parameter
|
|
400
|
smql_query_error
|
SMQL query error
|
|
400
|
serialization_error
|
Serialization error
|
|
404
|
entity_not_found
|
Entity not found
|
|
500
|
server_error
|
Server error
|
Access Control
This REST API endpoint respects access control and permissions for each record. Data that users lack permissions to read is not returned. All authenticated users (for example, with the Standard User role) can execute this REST endpoint.
Examples
• Retrieve the Showcase record with UUID 41f19ff6-2738-4000-8bfd-a18950caa1d1:
GET https://<server>/v2/io_showcase/41f19ff6-2738-4000-8bfd-a18950caa1d1
• Retrieve the Showcase record with UUID 41f19ff6-2738-4000-8bfd-a18950caa1d1, load only a subset of its fields, and eager-load the first and last name of the record owner:
GET https://<server>/v2/io_showcase/41f19ff6-2738-4000-8bfd-a18950caa1d1?fields=io_uuid, io_name,io_owner.io_last_name,io_owner.io_first_name
• Retrieve all related Showcase Details of Showcase records:
GET https://<server>/v2/io_showcase/42f64596-c42f-4ba2-8138-cc40188d2a88?incomingRelationships=io_showcase_detail_showcase