Service Modules > Scheduling and Optimization > Service Board > Max for Developers > Appendix B: Max REST API > REST API Version 2 > Create Records
 
Create Records
Method
POST
URL
/v2/<object_full_identifier>
Parameters
Response
Content Type
application/json
Create Single Records
The request body is a JSON representation of a Map of <field_full_identifier, value> for each field to set in the record to be created.
Input Example
{
 "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",
 .
 .
}
For information on data type formats, see REST API Data Type Representation.
Response Example
The response is a JSON representation of the newly created record. Following is an example Status Code 200 response for the Showcase object:
{
"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,
....
}
Create Multiple Records
The request body is a JSON representation of an array of Map of <field_full_identifier, value> for each field to be set in each record to be created.
Input Example
[ {
  "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",
  .
  .
},
{...},{...}...
]
Response Example
The response is a JSON representation of an array of newly created records. Following is an example Status Code 200 response for the Showcase object:
[{
"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_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 any data
400
missing_parameter_error
The body of the request did not contain any valid data to create record/records
400
invalid_parameter_error
Error Creating Records. Error: ...
400
operation_error
Error Creating Record. Error: ...
500
server_error
Server Error
For more information:
Was this helpful?