Named Object Operations

Use Named Object Operations to perform basic actions against Business Objects. Named Object Operations include nine API operations with simplified URL paths that you can run against any major Business Object.

Named Object Operations are not automatically visible in Swagger. To add the Named Object Operations for a specific Business Object, follow the steps to Add Operations for Named Objects.

Important: For the operation URLs listed below, {BusObName} is replaced in Swagger with the internal name of the Business Object on which the action is performed. For example, for Incident, the Delete Business Object URL is DELETE /api/V1/object/Incident/{id}.

Operations are ordered by URL.

Delete Business Object

URL
DELETE /api/V1/object/{BusObName}/{id}
Description:
Delete a Business Object using its name and ID.

Get Business Object

URL
GET /api/V1/object/{BusObName}/{id}
Description:
Get a Business Object using its name and ID.

Update Business Object

URL
PATCH /api/V1/object/{BusObName}/{id}
Description:
Update a Business Object using its name, ID, and properties.

Create Business Object

URL
POST /api/V1/object/{BusObName}
Description:
Create a Business Object using its name and properties.

Get Business Object Field List

URL
GET /api/V1/object/{BusObName}/describe
Description:
Get a Business Object Field list using its name.

Delete Business Object Comment

URL
DELETE /api/V1/object/{BusObName}/{id}/comments/{commentid}
Description:
Delete a Business Object comment using its name, ID, and comment ID.

Get Business Object Comments

URL
GET /api/V1/object/{BusObName}/{id}/comments
Description:
Get a list of comments for a Business Object using its name and ID.

Create Business Object Comment

URL
POST /api/V1/object/{BusObName}/{id}/comments
Description:
Create a comment for a Business Object using its name and ID.

Search for Business Object

URL
POST /api/V1/object/{BusObName}/search
Description:
Search for a Business Object using its name and an array of filters.

More Information

See the Introducing the Named Object REST API free Video Learning Library course.