Use Cases for Agreement Specification

I want to
Request TypeExample URL
Retrieve and display details of a particular agreement specification.GET by ID{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification/{id-of-the-resouce-to-be-retrieved}

NOTE:
For invalid customer ID, you will receive HTTP 404 error.
Based on the provided field values, retrieve and display details of agreement specification.GET with Fields{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification?fields=name

NOTE:
The requested fields will be part of output, if they have value.
List all the agreement specifications present in the system.GET List{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification
List agreement specifications present in the system based on the filter applied.GET List with Filtering{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification?name=testing

NOTE:
The requested fields will be part of output, if they have value.
List agreement specifications, limit the number of agreement specifications to a maximum of specified limit, and
display the results from page specified by offset.
GET List by limit and offset{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification?pageLimit=1&offset=1
Create a new agreement specification by providing the required details.POST{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification

NOTE:
A new agreement specification gets created based on the values mentioned for the mandatory fields.
Update details of particular agreement specification.PATCH{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification/{ID}
Delete an agreement specification.DELETE{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification/{ID}

Consider you want to retrieve details of a particular agreement specification.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000eLAAQ

Consider you want to retrieve details of an agreement specification with requested attributes (id, href are always included).

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification?fields=name

Consider there are agreement specifications in the system and you want to list all of them.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification

Consider you want to retrieve all the agreement specifications in the system with applied filter values.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification?name=testing

Consider you want to

  • Retrieve a list of agreement specifications
  • Limit the number of results to a maximum of specified limit
  • Start the results display from page specified by offset

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification?pageLimit=1&offset=1

NOTE: The above pagination query - limit=1&offset=1 will start display from page 1 and will have 1 record.

Consider you want to create a new agreement specification.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification

Consider you want to update details of a particular agreement specification.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000eLAAQ

Request body will have fields that needs to be updated.

Consider you want to delete details of a particular agreement specification.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v61.0/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000eLAAQ

No request body.

Status code 204 with no response body