Get New or Empty Records
|
Method
|
GET
|
|
URL
|
/v2/<object_full_identifier>/new_record
|
|
Parameters
|
data_format
|
|
Response Content Type
|
application/json
|
Response Example
The response is a JSON representation of an empty record, with all default field values set or initialized, whether corresponding. The response also includes field values for the io_created_by and io_owner fields, which reference the authenticated user who issues the REST call, plus the io_custodian field, which references the assigned custodian. Fields with default NULL values are excluded from the response.
Following is an example Status Code 200 response for a new or empty Showcase record in extended output format.
{
"__object_identifier": "io_showcase",
"io_uuid": "37609e83-0e26-4105-ba52-535c5bb45379",
"io_deleted": false,
"__primary_name_field": "io_name",
"io_private": false,
"io_showcase_code": [
"groovy",
""
],
"io_owner": {
"__object_identifier": "io_user",
"io_uuid": "764f0869-8b2a-4e43-8f23-88f593863eff",
"io_deleted": false,
"__primary_name_field": "io_full_name",
"io_full_name": "System Administrator"
},
"io_showcase_boolean": false,
"io_created_by": {
"__object_identifier": "io_user",
"io_uuid": "764f0869-8b2a-4e43-8f23-88f593863eff",
"io_deleted": false,
"__primary_name_field": "io_full_name",
"io_full_name": "System Administrator"
},
"io_custodian": {
"__object_identifier": "io_custodian",
"io_uuid": "c9d336e0-824c-4be1-9bf2-feff5261b69e",
"io_deleted": false,
"__primary_name_field": "io_name",
"io_name": "ServiceMax"
},
"io_active": true
}
"__object_identifier": "io_showcase",
"io_uuid": "37609e83-0e26-4105-ba52-535c5bb45379",
"io_deleted": false,
"__primary_name_field": "io_name",
"io_private": false,
"io_showcase_code": [
"groovy",
""
],
"io_owner": {
"__object_identifier": "io_user",
"io_uuid": "764f0869-8b2a-4e43-8f23-88f593863eff",
"io_deleted": false,
"__primary_name_field": "io_full_name",
"io_full_name": "System Administrator"
},
"io_showcase_boolean": false,
"io_created_by": {
"__object_identifier": "io_user",
"io_uuid": "764f0869-8b2a-4e43-8f23-88f593863eff",
"io_deleted": false,
"__primary_name_field": "io_full_name",
"io_full_name": "System Administrator"
},
"io_custodian": {
"__object_identifier": "io_custodian",
"io_uuid": "c9d336e0-824c-4be1-9bf2-feff5261b69e",
"io_deleted": false,
"__primary_name_field": "io_name",
"io_name": "ServiceMax"
},
"io_active": true
}
 |
Be aware that new or empty returned entitles are not persisted in any datastore by the platform when this endpoint is invoked.
|
|
Parameter
|
Description
|
Data Type
|
Example
|
|---|---|---|---|
|
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 new or empty record in the extended output data format:
/v2/<object_full_identifier>/new_record?data_formatextended
|
Error Response Messages
|
HTTP Status Code
|
Error Type
|
Error Message
|
|---|---|---|
|
400
|
missing_parameter_error
|
Invalid object identifier specified
|
|
500
|
server_error
|
Server error
|
Input Examples
• Retrieve a new or empty Showcase record in default output data format:
GET https://<server>/v2/io_showcase/new_record
• Retrieve a new or empty Showcase record in extended output data format:
GET https://<server>/v2/io_showcase/new_record?data_format=extended
For more information: