Use Cases for Agreement Specification

I want to	Request Type	Example 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}

GET by ID

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

Sample URL

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

Sample Response

1{
2    "attachment": [
3        {
4            "attachmentType": "PDF",
5            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D3UAAU",
6            "id": "069xx0000004D3UAAU",
7            "mimeType": "pdf",
8            "name": "TMF651B_Agreement_Management_API_Conformance_Profile_R19.0.0",
9        }
10    ],
11    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000eLAAQ",
12    "id": "2dtxx00000000eLAAQ",
13    "lifecycleStatus": "Draft",
14    "name": "Sample Unique Name",
15    "@type": "AgreementSpecification",
16    "relatedParty": [
17        {
18            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
19            "id": "005xx000001X8CjAAK",
20            "name": "min user"
21        }
22    ]
23}

GET with Fields

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

Sample URL

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

Sample Response

1[
2    {
3        "@type": "AgreementSpecification",
4        "name": "testing",
5        "id": "2dtxx0000000001AAA",
6        "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx0000000001AAA"
7    },
8    {
9        "@type": "AgreementSpecification",
10        "name": "Test Document 2",
11        "id": "2dtxx00000000CvAAI",
12        "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000CvAAI"
13    },
14    {
15        "@type": "AgreementSpecification",
16        "name": "testing",
17        "id": "2dtxx00000000EXAAY",
18        "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000EXAAY"
19    }
20]

GET List

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

Sample URL

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

Sample Response

1[
2{
3    "lifecycleStatus": "Draft",
4    "@type": "AgreementSpecification",
5    "attachment": [
6        {
7            "id": "069xx0000004D8KAAU",
8            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D8KAAU",
9            "attachmentType": "PDF",
10            "mimeType": "pdf",
11            "name": "TMF651_Agreement_Management_API_REST_Specification_R19.0.1",
12        }
13    ],
14    "name": "Sample name",
15    "id": "2dtxx00000000fxAAA",
16    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000fxAAA",
17    "relatedParty": [
18        {
19            "id": "005xx000001X8CjAAK",
20            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
21            "name": "min user"
22        }
23    ]
24},
25{
26    "lifecycleStatus": "Draft",
27    "@type": "AgreementSpecification",
28    "attachment": [
29        {
30            "id": "069xx0000004D6iAAE",
31            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D6iAAE",
32            "attachmentType": "JSON",
33            "mimeType": "json",
34            "name": "637_Collection.postman_collection",
35        }
36    ],
37    "name": "Sample name for testing",
38    "id": "2dtxx00000000hZAAQ",
39    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000hZAAQ",
40    "relatedParty": [
41        {
42            "id": "005xx000001X8CjAAK",
43            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
44            "name": "min user"
45        }
46    ]
47}
48]

GET List with Filtering

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

Sample URL

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

Sample Response

1[
2{
3    "lifecycleStatus": "Draft",
4    "@type": "AgreementSpecification",
5    "attachment": [
6        {
7            "id": "069xx0000004D8KAAU",
8            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D8KAAU",
9            "attachmentType": "PDF",
10            "mimeType": "pdf",
11            "name": "TMF651_Agreement_Management_API_REST_Specification_R19.0.1",
12        }
13    ],
14    "name": "Sample name",
15    "id": "2dtxx00000000fxAAA",
16    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000fxAAA",
17    "relatedParty": [
18        {
19            "id": "005xx000001X8CjAAK",
20            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
21            "name": "min user"
22        }
23    ]
24},
25{
26    "lifecycleStatus": "Draft",
27    "@type": "AgreementSpecification",
28    "attachment": [
29        {
30            "id": "069xx0000004D6iAAE",
31            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D6iAAE",
32            "attachmentType": "JSON",
33            "mimeType": "json",
34            "name": "637_Collection.postman_collection",
35        }
36    ],
37    "name": "Sample name for testing",
38    "id": "2dtxx00000000hZAAQ",
39    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000hZAAQ",
40    "relatedParty": [
41        {
42            "id": "005xx000001X8CjAAK",
43            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
44            "name": "min user"
45        }
46    ]
47}
48]

GET List by limit and offset

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

Sample URL

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.

Sample Response

1[
2{
3    "lifecycleStatus": "Draft",
4    "@type": "AgreementSpecification",
5    "attachment": [
6        {
7            "id": "069xx0000004D8KAAU",
8            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D8KAAU",
9            "attachmentType": "PDF",
10            "mimeType": "pdf",
11            "name": "TMF651_Agreement_Management_API_REST_Specification_R19.0.1",
12        }
13    ],
14    "name": "Sample name",
15    "id": "2dtxx00000000fxAAA",
16    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000fxAAA",
17    "relatedParty": [
18        {
19            "id": "005xx000001X8CjAAK",
20            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
21            "name": "min user"
22        }
23    ]
24},
25{
26    "lifecycleStatus": "Draft",
27    "@type": "AgreementSpecification",
28    "attachment": [
29        {
30            "id": "069xx0000004D6iAAE",
31            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D6iAAE",
32            "attachmentType": "JSON",
33            "mimeType": "json",
34            "name": "637_Collection.postman_collection",
35        }
36    ],
37    "name": "Sample name for testing",
38    "id": "2dtxx00000000hZAAQ",
39    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000hZAAQ",
40    "relatedParty": [
41        {
42            "id": "005xx000001X8CjAAK",
43            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
44            "name": "min user"
45        }
46    ]
47}
48]

POST

Consider you want to create a new agreement specification.

Sample URL

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

Sample Request

1{
2    "name" : "Sample Unique Name",
3    "lifecycleStatus" : "Draft",
4    "relatedParty": [
5        {
6        "id": "005xx000001X8CjAAK",
7        "name": "Jimmy Doe"
8        }
9    ],
10    "attachment" : [
11        {
12            "id" : "069xx0000004D3UAAU"
13        }
14    ]
15}

Sample Response

1{
2    "attachment": [
3        {
4            "attachmentType": "PDF",
5            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D3UAAU",
6            "id": "069xx0000004D3UAAU",
7            "mimeType": "pdf",
8            "name": "TMF651B_Agreement_Management_API_Conformance_Profile_R19.0.0",
9        }
10    ],
11    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000eLAAQ",
12    "id": "2dtxx00000000eLAAQ",
13    "lifecycleStatus": "Draft",
14    "name": "Sample Unique Name",
15    "@type": "AgreementSpecification",
16    "relatedParty": [
17        {
18            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
19            "id": "005xx000001X8CjAAK",
20            "name": "Jimmy Doe"
21        }
22    ]
23}

PATCH

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

Sample URL

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

Sample Request

Request body will have fields that need to be updated.

1{
2    "attachment" : [
3        {
4            "id" : "069xx0000004D56AAE"
5        }
6    ]
7}

Sample Response

1{
2    "attachment": [
3        {
4            "attachmentType": "JSON",
5            "href": "/services/data/v60.0/sobjects/attachment/069xx0000004D56AAE",
6            "id": "069xx0000004D56AAE",
7            "mimeType": "json",
8            "name": "OpenAPI-Framework.postman_collection",
9        }
10    ],
11    "href": "/connect/comms/agreementmanagement/v4/agreementspecification/2dtxx00000000eLAAQ",
12    "id": "2dtxx00000000eLAAQ",
13    "lifecycleStatus": "Draft",
14    "name": "Feb 24 - 4",
15    "@type": "AgreementSpecification",
16    "relatedParty": [
17        {
18            "href": "/services/data/v60.0/sobjects/User/005xx000001X8CjAAK",
19            "id": "005xx000001X8CjAAK",
20            "name": "min user"
21        }
22    ]
23}

DELETE

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

Sample URL

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

Sample Request

No request body.

Sample Response

Status code 204 with no response body