Using the Siebel REST API to Access Attachments

This chapter describes how Siebel REST API supports attaching external documents and files to records. For example, attaching a spreadsheet file to an account. You can use inbound REST APIs to develop applications that can attach files to records, allowing you to insert, update, delete, query, and download an attachment.

For more information on HTTP methods supported by the Siebel REST API and the corresponding Siebel CRM operation, see About Supported HTTP Methods.

When accessing attachments using Siebel REST API, the following considerations apply:

• In order to insert, update, delete, or query attachments, the integration components and business components must have an attachment integration component or business component.
• The contents of the attached file must be Base64 encoded, and must be added as business component field value in the request JSON or XML body.
• All create, read, update and delete (CRUD) operations are supported for attachment APIs and can be performed on a single or multiple attachment records at a time.
• The maximum number of attachments in a single REST request is restricted to 100.
• The attachment size is restricted by the heap size of the Tomcat and process memory size of the Siebel OM process.

It includes the following topics:

• About Using the Siebel REST API

• Using Siebel REST API to Access Attachments JSON Examples

• Using Siebel REST API to Access Attachments XML Examples

• Using Siebel REST API Business Services to Access Attachments JSON Examples

• Using Siebel REST API Business Services to Access Attachments XML Examples