Basics

The Agreement Services API follows a microservice architecture that enables CLM into any part of an application and is built on the JSON API specification, follows predictable REST URLs and supports cross-origin resource sharing .

Endpoint

The Agreement Services API is installed with the CLM managed package and can be exposed to external applications via a Salesforce site or community. https://myorg.force.com/services/apexrest/Apttus/clm/:version/:API

Versions

The Agreement Services API ensures backward compatibility by properly versioning any changes to the APIs. Should changes to the API structure need to be made, it will occur within a new version and older functionality will be preserved.

Content Type

Requests made to the API must be encoded as JSON and contain the header

Content-Type: application/json

Includes

You can easily include resource relationships on most top-level resources. Multiple includes are defined using comma-delimited values.

Caching

Server side caching is used and can be configured per request using the cacheStrategy query parameter.

Errors

Any request that returns an error follows a standard format. The Agreement Services API will return an array of errors that contains objects containing the status, title, and data with the error details.