AgreementsApi

All URIs are relative to http://localhost/api/rest/v6

Method	HTTP request	Description
addTemplateFieldsToAgreement	POST /agreements/{agreementId}/formFields	Adds template fields to an agreement
createAgreement	POST /agreements	Creates an agreement. Sends it out for signatures, and returns the agreementID in the response to the client.
createAgreementView	POST /agreements/{agreementId}/views	Retrieves the latest state view url of agreement.
createDelegatedParticipantSets	POST /agreements/{agreementId}/members/participantSets/{participantSetId}/delegatedParticipantSets	Creates a participantSet to which the agreement is forwarded for taking appropriate action.
createReminderOnParticipant	POST /agreements/{agreementId}/reminders	Creates a reminder on the specified participants of an agreement identified by agreementId in the path.
createShareOnAgreement	POST /agreements/{agreementId}/members/share	Share an agreement with someone.
deleteDocuments	DELETE /agreements/{agreementId}/documents	Deletes all the documents of an agreement.
getAgreementInfo	GET /agreements/{agreementId}	Retrieves the current status of an agreement.
getAgreementNoteForApiUser	GET /agreements/{agreementId}/me/note	Retrieves the latest note associated with an agreement.
getAgreementReminders	GET /agreements/{agreementId}/reminders	Retrieves the reminders of an agreement, identified by agreementId in the path.
getAgreements	GET /agreements	Retrieves agreements for the user.
getAllDocuments	GET /agreements/{agreementId}/documents	Retrieves the IDs of the documents of an agreement identified by agreementId.
getAllDocumentsImageUrls	GET /agreements/{agreementId}/documents/imageUrls	Retrieves image urls of all visible pages of all the documents associated with an agreement.
getAllMembers	GET /agreements/{agreementId}/members	Retrieves information of members of the agreement.
getAuditTrail	GET /agreements/{agreementId}/auditTrail	Retrieves the audit trail of an agreement identified by agreementId.
getCombinedDocument	GET /agreements/{agreementId}/combinedDocument	Retrieves a single combined PDF document for the documents associated with an agreement.
getCombinedDocumentPagesInfo	GET /agreements/{agreementId}/combinedDocument/pagesInfo	Retrieves info of all pages of a combined PDF document for the documents associated with an agreement.
getDocument	GET /agreements/{agreementId}/documents/{documentId}	Retrieves the file stream of a document of an agreement.
getDocumentImageUrls	GET /agreements/{agreementId}/documents/{documentId}/imageUrls	Retrieves image urls of all visible pages of a document associated with an agreement.
getEvents	GET /agreements/{agreementId}/events	Retrieves the events information for an agreement.
getFormData	GET /agreements/{agreementId}/formData	Retrieves data entered into the interactive form fields of the agreement.
getFormFields	GET /agreements/{agreementId}/formFields	Retrieves details of form fields of an agreement.
getMergeInfo	GET /agreements/{agreementId}/formFields/mergeInfo	Retrieves the merge info stored with an agreement.
getParticipantSet	GET /agreements/{agreementId}/members/participantSets/{participantSetId}	Retrieves the participant set of an agreement identified by agreementId in the path.
getSigningUrl	GET /agreements/{agreementId}/signingUrls	Retrieves the URL for the e-sign page for the current signer(s) of an agreement.
rejectAgreementForParticipation	PUT /agreements/{agreementId}/members/participantSets/{participantSetId}/participants/{participantId}/reject	Rejects the agreement for a participant.
updateAgreement	PUT /agreements/{agreementId}	Updates the agreement in draft state.
updateAgreementMergeInfo	PUT /agreements/{agreementId}/formFields/mergeInfo	Set the merge info for an agreement.
updateAgreementState	PUT /agreements/{agreementId}/state	Updates the state of an agreement identified by agreementId in the path.
updateAgreementVisibility	PUT /agreements/{agreementId}/me/visibility	Updates the visibility of an agreement.
updateFormFields	PUT /agreements/{agreementId}/formFields	Updates form fields of an agreement.
updateParticipantSet	PUT /agreements/{agreementId}/members/participantSets/{participantSetId}	Updates the participant set of an agreement identified by agreementId in the path.

addTemplateFieldsToAgreement

AgreementFormFields addTemplateFieldsToAgreement(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser)

Adds template fields to an agreement

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
FormFieldPostInfo formFieldPostInfo = new FormFieldPostInfo(); // FormFieldPostInfo | List of form fields to add or replace
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
    AgreementFormFields result = apiInstance.addTemplateFieldsToAgreement(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#addTemplateFieldsToAgreement");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
formFieldPostInfo	FormFieldPostInfo	List of form fields to add or replace
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]

Return type

AgreementFormFields

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

createAgreement

AgreementCreationResponse createAgreement(authorization, agreementInfo, xApiUser, xOnBehalfOfUser)

Creates an agreement. Sends it out for signatures, and returns the agreementID in the response to the client.

This is a primary endpoint which is used to create a new agreement. An agreement can be created using transientDocument, libraryDocument or a URL. You can create an agreement in one of the 3 mentioned states: a) DRAFT - to incrementally build the agreement before sending out, b) AUTHORING - to add/edit form fields in the agreement, c) IN_PROCESS - to immediately send the agreement. You can use the PUT /agreements/{agreementId}/state endpoint to transition an agreement between the above mentioned states. An allowed transition would follow the following sequence: DRAFT -> AUTHORING -> IN_PROCESS -> CANCELLED.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
AgreementInfo agreementInfo = new AgreementInfo(); // AgreementInfo | Information about the agreement that you want to create.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    AgreementCreationResponse result = apiInstance.createAgreement(authorization, agreementInfo, xApiUser, xOnBehalfOfUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#createAgreement");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementInfo	AgreementInfo	Information about the agreement that you want to create.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

AgreementCreationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

createAgreementView

AgreementViews createAgreementView(authorization, agreementId, agreementViewInfo, xApiUser, xOnBehalfOfUser)

Retrieves the latest state view url of agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
AgreementViewInfo agreementViewInfo = new AgreementViewInfo(); // AgreementViewInfo | Name of the required view and its desired configuration.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    AgreementViews result = apiInstance.createAgreementView(authorization, agreementId, agreementViewInfo, xApiUser, xOnBehalfOfUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#createAgreementView");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('user_login')" oncontextmenu="this.href=oauthDoc('user_login')" target="oauthDoc">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
agreementViewInfo	AgreementViewInfo	Name of the required view and its desired configuration.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

AgreementViews

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

createDelegatedParticipantSets

DelegationResponse createDelegatedParticipantSets(authorization, agreementId, participantSetId, delegatedParticipantSetInfo, xApiUser)

Creates a participantSet to which the agreement is forwarded for taking appropriate action.

Participants marked as delegator can call this API endpoint.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String participantSetId = "participantSetId_example"; // String | The participant set identifier
DelegatedParticipantSetInfo delegatedParticipantSetInfo = new DelegatedParticipantSetInfo(); // DelegatedParticipantSetInfo | Information about the delegate participant Set
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
    DelegationResponse result = apiInstance.createDelegatedParticipantSets(authorization, agreementId, participantSetId, delegatedParticipantSetInfo, xApiUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#createDelegatedParticipantSets");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
participantSetId	String	The participant set identifier
delegatedParticipantSetInfo	DelegatedParticipantSetInfo	Information about the delegate participant Set
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]

Return type

DelegationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

createReminderOnParticipant

ReminderCreationResult createReminderOnParticipant(authorization, agreementId, reminderInfo, xApiUser, xOnBehalfOfUser)

Creates a reminder on the specified participants of an agreement identified by agreementId in the path.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
ReminderInfo reminderInfo = new ReminderInfo(); // ReminderInfo | The information about the reminder that you want to create on the participantSet of the agreement.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    ReminderCreationResult result = apiInstance.createReminderOnParticipant(authorization, agreementId, reminderInfo, xApiUser, xOnBehalfOfUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#createReminderOnParticipant");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
reminderInfo	ReminderInfo	The information about the reminder that you want to create on the participantSet of the agreement.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

ReminderCreationResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

createShareOnAgreement

ShareCreationResponseList createShareOnAgreement(authorization, agreementId, shareCreationInfoList, xApiUser, xOnBehalfOfUser)

Share an agreement with someone.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
ShareCreationInfoList shareCreationInfoList = new ShareCreationInfoList(); // ShareCreationInfoList | List of agreement share creation information objects.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    ShareCreationResponseList result = apiInstance.createShareOnAgreement(authorization, agreementId, shareCreationInfoList, xApiUser, xOnBehalfOfUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#createShareOnAgreement");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
shareCreationInfoList	ShareCreationInfoList	List of agreement share creation information objects.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

ShareCreationResponseList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteDocuments

deleteDocuments(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser)

Deletes all the documents of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_retention')\" oncontextmenu=\"this.href=oauthDoc('agreement_retention')\" target=\"oauthDoc\">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    apiInstance.deleteDocuments(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#deleteDocuments");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_retention')" oncontextmenu="this.href=oauthDoc('agreement_retention')" target="oauthDoc">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAgreementInfo

AgreementInfo getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch)

Retrieves the current status of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
try {
    AgreementInfo result = apiInstance.getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAgreementInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]

Return type

AgreementInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAgreementNoteForApiUser

Note getAgreementNoteForApiUser(authorization, agreementId, xApiUser, xOnBehalfOfUser)

Retrieves the latest note associated with an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    Note result = apiInstance.getAgreementNoteForApiUser(authorization, agreementId, xApiUser, xOnBehalfOfUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAgreementNoteForApiUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

Note

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAgreementReminders

RemindersResponse getAgreementReminders(authorization, agreementId, xApiUser, xOnBehalfOfUser, status)

Retrieves the reminders of an agreement, identified by agreementId in the path.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String status = "status_example"; // String | A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE
try {
    RemindersResponse result = apiInstance.getAgreementReminders(authorization, agreementId, xApiUser, xOnBehalfOfUser, status);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAgreementReminders");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
status	String	A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE	[optional]

Return type

RemindersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAgreements

UserAgreements getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize)

Retrieves agreements for the user.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String externalId = "externalId_example"; // String | Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API
Boolean showHiddenAgreements = true; // Boolean | A query parameter to fetch all the hidden agreements along with the visible agreements.
String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page.
Integer pageSize = 56; // Integer | Number of intended items in the response page.
try {
    UserAgreements result = apiInstance.getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAgreements");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
externalId	String	Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API	[optional]
showHiddenAgreements	Boolean	A query parameter to fetch all the hidden agreements along with the visible agreements.	[optional]
cursor	String	Used to navigate through the pages. If not provided, returns the first page.	[optional]
pageSize	Integer	Number of intended items in the response page.	[optional]

Return type

UserAgreements

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAllDocuments

AgreementDocuments getAllDocuments(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, supportingDocumentContentFormat)

Retrieves the IDs of the documents of an agreement identified by agreementId.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
String versionId = "versionId_example"; // String | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used.
String participantId = "participantId_example"; // String | The participant identifier to be used to retrieve documents.
String supportingDocumentContentFormat = "supportingDocumentContentFormat_example"; // String | Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF.
try {
    AgreementDocuments result = apiInstance.getAllDocuments(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, supportingDocumentContentFormat);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAllDocuments");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]
versionId	String	The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used.	[optional]
participantId	String	The participant identifier to be used to retrieve documents.	[optional]
supportingDocumentContentFormat	String	Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF.	[optional] [enum: ORIGINAL, CONVERTED_PDF]

Return type

AgreementDocuments

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAllDocumentsImageUrls

DocumentsImageUrlsInfo getAllDocumentsImageUrls(authorization, agreementId, xApiUser, xOnBehalfOfUser, versionId, participantId, imageSizes, includeSupportingDocumentsImageUrls, showImageAvailabilityOnly)

Retrieves image urls of all visible pages of all the documents associated with an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String versionId = "versionId_example"; // String | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used.
String participantId = "participantId_example"; // String | The participant identifier to be used to retrieve documents.
String imageSizes = "imageSizes_example"; // String | A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. 
Boolean includeSupportingDocumentsImageUrls = true; // Boolean | When set to true, returns image urls of supporting documents as well. Else, returns image urls of only the original documents.
Boolean showImageAvailabilityOnly = true; // Boolean | When set to true, returns only image availability. Else, returns both image urls and its availability.
try {
    DocumentsImageUrlsInfo result = apiInstance.getAllDocumentsImageUrls(authorization, agreementId, xApiUser, xOnBehalfOfUser, versionId, participantId, imageSizes, includeSupportingDocumentsImageUrls, showImageAvailabilityOnly);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAllDocumentsImageUrls");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
versionId	String	The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used.	[optional]
participantId	String	The participant identifier to be used to retrieve documents.	[optional]
imageSizes	String	A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}.	[optional]
includeSupportingDocumentsImageUrls	Boolean	When set to true, returns image urls of supporting documents as well. Else, returns image urls of only the original documents.	[optional]
showImageAvailabilityOnly	Boolean	When set to true, returns only image availability. Else, returns both image urls and its availability.	[optional]

Return type

DocumentsImageUrlsInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAllMembers

MembersInfo getAllMembers(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, includeNextParticipantSet)

Retrieves information of members of the agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
Boolean includeNextParticipantSet = true; // Boolean | A query parameter to fetch next active participation members
try {
    MembersInfo result = apiInstance.getAllMembers(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, includeNextParticipantSet);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAllMembers");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]
includeNextParticipantSet	Boolean	A query parameter to fetch next active participation members	[optional]

Return type

MembersInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAuditTrail

byte[] getAuditTrail(authorization, agreementId, xApiUser, xOnBehalfOfUser)

Retrieves the audit trail of an agreement identified by agreementId.

PDF file stream containing audit trail information

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    byte[] result = apiInstance.getAuditTrail(authorization, agreementId, xApiUser, xOnBehalfOfUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getAuditTrail");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

byte[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/pdf;encoding=base64

getCombinedDocument

byte[] getCombinedDocument(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, attachSupportingDocuments, attachAuditReport)

Retrieves a single combined PDF document for the documents associated with an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
String versionId = "versionId_example"; // String | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used.
String participantId = "participantId_example"; // String | The participant identifier to be used to retrieve documents.
Boolean attachSupportingDocuments = true; // Boolean | When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true.
Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the signed agreement PDF. Default value is false
try {
    byte[] result = apiInstance.getCombinedDocument(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, attachSupportingDocuments, attachAuditReport);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getCombinedDocument");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]
versionId	String	The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used.	[optional]
participantId	String	The participant identifier to be used to retrieve documents.	[optional]
attachSupportingDocuments	Boolean	When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true.	[optional]
attachAuditReport	Boolean	When set to true, attach an audit report to the signed agreement PDF. Default value is false	[optional]

Return type

byte[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/pdf;encoding=base64

getCombinedDocumentPagesInfo

CombinedDocumentPagesInfo getCombinedDocumentPagesInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, includeSupportingDocumentsPagesInfo)

Retrieves info of all pages of a combined PDF document for the documents associated with an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
Boolean includeSupportingDocumentsPagesInfo = true; // Boolean | When set to true, returns info of all pages of supporting documents as well. Else, return the info of pages of only the original document.
try {
    CombinedDocumentPagesInfo result = apiInstance.getCombinedDocumentPagesInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, includeSupportingDocumentsPagesInfo);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getCombinedDocumentPagesInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]
includeSupportingDocumentsPagesInfo	Boolean	When set to true, returns info of all pages of supporting documents as well. Else, return the info of pages of only the original document.	[optional]

Return type

CombinedDocumentPagesInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDocument

byte[] getDocument(authorization, agreementId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch)

Retrieves the file stream of a document of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String documentId = "documentId_example"; // String | The document identifier, as retrieved from the API which fetches the documents of a specified agreement
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
try {
    byte[] result = apiInstance.getDocument(authorization, agreementId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getDocument");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
documentId	String	The document identifier, as retrieved from the API which fetches the documents of a specified agreement
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]

Return type

byte[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /, /;encoding=base64

getDocumentImageUrls

AgreementDocumentImageUrlsInfo getDocumentImageUrls(authorization, agreementId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, startPage, endPage)

Retrieves image urls of all visible pages of a document associated with an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String documentId = "documentId_example"; // String | The document identifier, as retrieved from the API which fetches the documents of a specified agreement
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String imageSizes = "imageSizes_example"; // String | A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. 
Boolean showImageAvailabilityOnly = true; // Boolean | When set to true, returns only image availability. Else, returns both image urls and its availability.
Integer startPage = 56; // Integer | Start of page number range for which imageUrls are requested. Starting page number should be greater than 0.
Integer endPage = 56; // Integer | End of page number range for which imageUrls are requested.
try {
    AgreementDocumentImageUrlsInfo result = apiInstance.getDocumentImageUrls(authorization, agreementId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, startPage, endPage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getDocumentImageUrls");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
documentId	String	The document identifier, as retrieved from the API which fetches the documents of a specified agreement
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
imageSizes	String	A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}.	[optional]
showImageAvailabilityOnly	Boolean	When set to true, returns only image availability. Else, returns both image urls and its availability.	[optional]
startPage	Integer	Start of page number range for which imageUrls are requested. Starting page number should be greater than 0.	[optional]
endPage	Integer	End of page number range for which imageUrls are requested.	[optional]

Return type

AgreementDocumentImageUrlsInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEvents

AgreementEventList getEvents(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch)

Retrieves the events information for an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
try {
    AgreementEventList result = apiInstance.getEvents(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getEvents");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]

Return type

AgreementEventList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getFormData

byte[] getFormData(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch)

Retrieves data entered into the interactive form fields of the agreement.

This API can only be called by the creator of the agreement

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
try {
    byte[] result = apiInstance.getFormData(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getFormData");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]

Return type

byte[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/csv

getFormFields

AgreementFormFields getFormFields(authorization, agreementId, xApiUser, participantEmail)

Retrieves details of form fields of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String participantEmail = "participantEmail_example"; // String | The email address of the participant to be used to retrieve its associated form fields.
try {
    AgreementFormFields result = apiInstance.getFormFields(authorization, agreementId, xApiUser, participantEmail);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getFormFields");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
participantEmail	String	The email address of the participant to be used to retrieve its associated form fields.	[optional]

Return type

AgreementFormFields

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getMergeInfo

FormFieldMergeInfo getMergeInfo(authorization, agreementId, xApiUser)

Retrieves the merge info stored with an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
    FormFieldMergeInfo result = apiInstance.getMergeInfo(authorization, agreementId, xApiUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getMergeInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]

Return type

FormFieldMergeInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getParticipantSet

DetailedParticipantSetInfo getParticipantSet(authorization, agreementId, participantSetId, xApiUser, xOnBehalfOfUser, ifNoneMatch)

Retrieves the participant set of an agreement identified by agreementId in the path.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String participantSetId = "participantSetId_example"; // String | The participant set identifier
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
try {
    DetailedParticipantSetInfo result = apiInstance.getParticipantSet(authorization, agreementId, participantSetId, xApiUser, xOnBehalfOfUser, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getParticipantSet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_read')" oncontextmenu="this.href=oauthDoc('agreement_read')" target="oauthDoc">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
participantSetId	String	The participant set identifier
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]

Return type

DetailedParticipantSetInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSigningUrl

SigningUrlResponse getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch)

Retrieves the URL for the e-sign page for the current signer(s) of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.
try {
    SigningUrlResponse result = apiInstance.getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#getSigningUrl");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
ifNoneMatch	String	Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed.	[optional]

Return type

SigningUrlResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

rejectAgreementForParticipation

rejectAgreementForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser)

Rejects the agreement for a participant.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String participantSetId = "participantSetId_example"; // String | The participant set identifier
String participantId = "participantId_example"; // String | The participant identifier
AgreementRejectionInfo agreementRejectionInfo = new AgreementRejectionInfo(); // AgreementRejectionInfo | Participant rejection information required for rejecting the agreement
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
    apiInstance.rejectAgreementForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#rejectAgreementForParticipation");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
participantSetId	String	The participant set identifier
participantId	String	The participant identifier
agreementRejectionInfo	AgreementRejectionInfo	Participant rejection information required for rejecting the agreement
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateAgreement

updateAgreement(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser)

Updates the agreement in draft state.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
AgreementInfo agreementInfo = new AgreementInfo(); // AgreementInfo | Information necessary to update a modifiable agreement that is presently out for signature.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    apiInstance.updateAgreement(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#updateAgreement");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
agreementInfo	AgreementInfo	Information necessary to update a modifiable agreement that is presently out for signature.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateAgreementMergeInfo

updateAgreementMergeInfo(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser)

Set the merge info for an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
FormFieldMergeInfo formFieldMergeInfo = new FormFieldMergeInfo(); // FormFieldMergeInfo | A mapping indicating the default values to set for form fields
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
    apiInstance.updateAgreementMergeInfo(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#updateAgreementMergeInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
formFieldMergeInfo	FormFieldMergeInfo	A mapping indicating the default values to set for form fields
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/pdf, text/csv

updateAgreementState

updateAgreementState(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser)

Updates the state of an agreement identified by agreementId in the path.

This endpoint can be used by originator/sender of an agreement to transition between the states of agreement. An allowed transition would follow the following sequence: DRAFT -> AUTHORING -> IN_PROCESS -> CANCELLED.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
AgreementStateInfo agreementStateInfo = new AgreementStateInfo(); // AgreementStateInfo | 
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    apiInstance.updateAgreementState(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#updateAgreementState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
agreementStateInfo	AgreementStateInfo
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateAgreementVisibility

updateAgreementVisibility(authorization, agreementId, visibilityInfo, xApiUser, xOnBehalfOfUser)

Updates the visibility of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
VisibilityInfo visibilityInfo = new VisibilityInfo(); // VisibilityInfo | Information to update visibility of agreement
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    apiInstance.updateAgreementVisibility(authorization, agreementId, visibilityInfo, xApiUser, xOnBehalfOfUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#updateAgreementVisibility");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
visibilityInfo	VisibilityInfo	Information to update visibility of agreement
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateFormFields

AgreementFormFields updateFormFields(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser)

Updates form fields of an agreement.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
FormFieldPutInfo formFieldPutInfo = new FormFieldPutInfo(); // FormFieldPutInfo | List of form fields to add or replace
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
    AgreementFormFields result = apiInstance.updateFormFields(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#updateFormFields");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
formFieldPutInfo	FormFieldPutInfo	List of form fields to add or replace
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]

Return type

AgreementFormFields

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateParticipantSet

updateParticipantSet(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser)

Updates the participant set of an agreement identified by agreementId in the path.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AgreementsApi;


AgreementsApi apiInstance = new AgreementsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
String participantSetId = "participantSetId_example"; // String | The participant set identifier
DetailedParticipantSetInfo detailedParticipantSetInfo = new DetailedParticipantSetInfo(); // DetailedParticipantSetInfo | The new participant set info.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account
try {
    apiInstance.updateParticipantSet(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser);
} catch (ApiException e) {
    System.err.println("Exception when calling AgreementsApi#updateParticipantSet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
authorization	String	An <a href="#" onclick="this.href=oauthDoc()" oncontextmenu="this.href=oauthDoc()" target="oauthDoc">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href="#" onclick="this.href=oauthDoc('agreement_write')" oncontextmenu="this.href=oauthDoc('agreement_write')" target="oauthDoc">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'.
ifMatch	String	The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
agreementId	String	The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
participantSetId	String	The participant set identifier
detailedParticipantSetInfo	DetailedParticipantSetInfo	The new participant set info.
xApiUser	String	The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.	[optional]
xOnBehalfOfUser	String	The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

AgreementsApi.md

Latest commit

History

AgreementsApi.md

File metadata and controls

AgreementsApi

addTemplateFieldsToAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

createAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

createAgreementView

Example

Parameters

Return type

Authorization

HTTP request headers

createDelegatedParticipantSets

Example

Parameters

Return type

Authorization

HTTP request headers

createReminderOnParticipant

Example

Parameters

Return type

Authorization

HTTP request headers

createShareOnAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

getAgreementInfo

Example

Parameters

Return type

Authorization

HTTP request headers

getAgreementNoteForApiUser

Example

Parameters

Return type

Authorization

HTTP request headers

getAgreementReminders

Example

Parameters

Return type

Authorization

HTTP request headers

getAgreements

Example

Parameters

Return type

Authorization

HTTP request headers

getAllDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

getAllDocumentsImageUrls