Agreements Version APIs
Provides the functionality to manage, record, and track agreements for orgs, apps, and experiments.
This endpoint allows users to fetch all available versions of a specified agreement. It provides visibility into the historical changes and updates made to the agreement, ensuring users can track its evolution over time. Ideal for organizations needing to manage their agreements effectively.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to add a major version to an existing agreement. It is intended for managing agreement versions within the organization. Ensure that the provided agreement ID and version type are valid to successfully update the agreement.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to access a particular version of an agreement by its ID. It is essential for tracking changes and managing agreements effectively. Ensure you have the necessary permissions to view this version.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to update a specific version of an agreement identified by its ID. It requires the agreement ID and version ID as path variables, along with the updated details in the request body. Proper authentication is necessary to ensure secure access to this operation.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to delete a specific version of an agreement identified by agreementId and versionId. It is crucial for maintaining the integrity of agreement records. Ensure that the user has the necessary permissions to perform this action.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to create a copy of an existing agreement version. It is designed for managing agreement versions within an organization. Ensure that the necessary permissions are in place to access and modify agreement details.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to obtain validation information for a specific version of an agreement. It is essential for ensuring compliance and correctness in agreement management. The operation is intended for authorized users to verify the integrity of agreement versions.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to publish a designated version of an agreement. It is essential for managing the lifecycle of agreements within the organization. Ensure that the correct version ID is provided for successful publication.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to remove a specific version of an agreement. It is essential for maintaining the accuracy and relevance of agreement records. Ensure that the correct version ID is provided to avoid unintentional deletions.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to update the content associated with a specific version of an agreement. It is designed for managing agreement details effectively. Ensure that the correct agreementId and versionId are provided for accurate updates.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to delete content associated with a specific version of an agreement. It is crucial for maintaining the accuracy and relevance of agreement data. Ensure that the correct version and language are specified to avoid unintended deletions.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to upload content associated with a specific agreement version. The uploaded content is identified by the agreement ID and version ID, ensuring proper management of agreement materials. This functionality is essential for maintaining up-to-date agreement documentation.
👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.
An OIDC service account that was authenticated.
OK
Unauthorized
Last updated