Salesforce Docs Portal

TMF651 v4 Agreement Management

GET Get a List of Agreement Specifications

GET /agreementspecification

Retrieves a list of Agreement Specification entities. Attribute selection is enabled for first-level attributes - name.

Parameters

  • fields (query, string) fields for attribute selection. supported values- name
  • name (query, string) Name of the Contract
  • offset (query, integer) Specifies the requested index for the start of the resources to be included in the response.
  • pageLimit (query, integer) Specifies the requested number of the resources to be included in the response.
  • Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
  • Version (header, string, required) Specifies the version to use with the URL path. version should be greater than or equal to v61.0
  • Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.

Responses

  • 200 successfully retrieved the agreement specification list

    Media type: application/json. Schema: array of agreement_spec.

    Array of agreement_spec.

  • 404 Resource not found.

    Media type: application/json. Schema: Error.

    Example

    code: RECORD_NOT_FOUND
reason: The specified resource ID doesn’t exist. Provide a valid resource ID and try again.