PDF
Download PDF
Download page Contract APIs.
Contract APIs
{
"openapi": "3.0.1",
"info": {
"title": "Conga CLM",
"version": "v1"
},
"paths": {
"/api/clm/v1/agreements": {
"post": {
"tags": [
"Agreement"
],
"summary": "Create an agreement record",
"description": "Creates an agreement record in CLM. Name, Account, and Record Type are the required fields to create a contract.\r\nCLM auto-populates the system fields, such as Status Category and Status fields that help identify the current stage of the agreement lifecycle.\r\nStatus Category and Status are set as \"Requested\". By default, the logged-in user is added in the Owner field.\r\nIn addition to the required fields, you can also add the following additional and custom fields in the contract.\r\n\"Name\"\r\n\"Account\"\r\n\"RecordType\"\r\n\"Owner\"\r\n\"Status\"\r\n\"StatusCategory\"\r\n\"Id\"\r\n\"CreatedBy\"\r\n\"CreatedDate\"\r\n\"ModifiedBy\"\r\n\"ModifiedDate\"\r\n\"ExternalId\"\r\n\"ActivatedBy\"\r\n\"ActivatedDate\"\r\n\"AgreementCategory\"\r\n\"AgreementNumber\"\r\n\"AmendmentEffectiveDate\"\r\n\"AutoRenewConsent\"\r\n\"AutoRenewTermMonths\"\r\n\"AutoRenewalTerms\"\r\n\"AutoRenewal\"\r\n\"ContractEndDate\"\r\n\"ContractNumber\"\r\n\"ContractStartDate\"\r\n\"Description\"\r\n\"InitiationType\"\r\n\"InternalRenewalNotificationDays\"\r\n\"InternalRenewalStartDate\"\r\n\"ParentAgreement\"\r\n\"Perpetual\"\r\n\"PrimaryContact\"\r\n\"Opportunity\"\r\n\"RemainingContractedDays\"\r\n\"RenewalNoticeDate\"\r\n\"RenewalNoticeDays\"\r\n\"RetentionDate\"\r\n\"RetentionPolicyId\"\r\n\"Source\"\r\n\"SpecialTerms\"\r\n\"SubmitRequestMode\"\r\n\"TermMonths\"\r\n\"TerminationComments\"\r\n\"TerminationDate\"\r\n\"TerminationNoticeDays\"\r\n\"TerminationNoticeIssueDate\"\r\n\"TotalContractValue\"\r\n\"ExecutedDate\"\r\n\"Currency\"",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { }
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"}
}
}
},
"responses": {
"400": {
"description": "Missing required value in the request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement details of the created agreement",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.3010105Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.301011Z","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"InitiationType":null,"InternalRenewalNotificationDays":null,"InternalRenewalStartDate":null,"ParentAgreement":null,"Perpetual":null,"PrimaryContact":null,"RemainingContractedDays":null,"RenewalNoticeDate":null,"RenewalNoticeDays":null,"RetentionDate":null,"RetentionPolicyId":null,"Source":null,"SpecialTerms":null,"SubmitRequestMode":null,"TerminationComments":null,"TerminationDate":null,"TerminationNoticeDays":null,"TerminationNoticeIssueDate":null,"ExecutedDate":null,"Currency":"USD","ContractDurationDays":null,"ContractedDays":null},"Errors":null}
}
}
}
}
},
"delete": {
"tags": [
"Agreement"
],
"summary": "Delete multiple agreement records",
"description": "Deletes the agreement record of the provided agreement Ids. The API deletes the agreement permanently from the system.",
"requestBody": {
"description": "List of Agreemend Ids to be deleted",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided one or more agreement Ids are invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the list of results whether the given agreement Ids got deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringResultStatusDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"64608ac0-f8d6-482e-8585-cf7f2cdb0b7b":"Success","d2fd6dcd-c28c-44ca-9961-b01fc00cbc6a":"Success"},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}": {
"put": {
"tags": [
"Agreement"
],
"summary": "Update an agreement record",
"description": "Updates an agreement record in CLM. Name, Account, and Record Type are the required fields to update an agreement.\r\nIn addition to the required fields, you can also update the following additional and custom fields in the contract.\r\n\"Name\"\r\n\"Account\"\r\n\"RecordType\"\r\n\"Owner\"\r\n\"Status\"\r\n\"StatusCategory\"\r\n\"Id\"\r\n\"CreatedBy\"\r\n\"CreatedDate\"\r\n\"ModifiedBy\"\r\n\"ModifiedDate\"\r\n\"ExternalId\"\r\n\"ActivatedBy\"\r\n\"ActivatedDate\"\r\n\"AgreementCategory\"\r\n\"AgreementNumber\"\r\n\"AmendmentEffectiveDate\"\r\n\"AutoRenewConsent\"\r\n\"AutoRenewTermMonths\"\r\n\"AutoRenewalTerms\"\r\n\"AutoRenewal\"\r\n\"ContractEndDate\"\r\n\"ContractNumber\"\r\n\"ContractStartDate\"\r\n\"Description\"\r\n\"InitiationType\"\r\n\"InternalRenewalNotificationDays\"\r\n\"InternalRenewalStartDate\"\r\n\"ParentAgreement\"\r\n\"Perpetual\"\r\n\"PrimaryContact\"\r\n\"Opportunity\"\r\n\"RemainingContractedDays\"\r\n\"RenewalNoticeDate\"\r\n\"RenewalNoticeDays\"\r\n\"RetentionDate\"\r\n\"RetentionPolicyId\"\r\n\"Source\"\r\n\"SpecialTerms\"\r\n\"SubmitRequestMode\"\r\n\"TermMonths\"\r\n\"TerminationComments\"\r\n\"TerminationDate\"\r\n\"TerminationNoticeDays\"\r\n\"TerminationNoticeIssueDate\"\r\n\"TotalContractValue\"\r\n\"ExecutedDate\"\r\n\"Currency\"",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement to be updated",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { }
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"}
}
}
},
"responses": {
"400": {
"description": "Provided agreement Id is not valid or required values are not provided in the request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the updated agreement details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.313841Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.3138418Z","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"InitiationType":null,"InternalRenewalNotificationDays":null,"InternalRenewalStartDate":null,"ParentAgreement":null,"Perpetual":null,"PrimaryContact":null,"RemainingContractedDays":null,"RenewalNoticeDate":null,"RenewalNoticeDays":null,"RetentionDate":null,"RetentionPolicyId":null,"Source":null,"SpecialTerms":null,"SubmitRequestMode":null,"TerminationComments":null,"TerminationDate":null,"TerminationNoticeDays":null,"TerminationNoticeIssueDate":null,"ExecutedDate":null,"Currency":"USD","ContractDurationDays":null,"ContractedDays":null},"Errors":null}
}
}
}
}
},
"get": {
"tags": [
"Agreement"
],
"summary": "Get agreement details of an agreement",
"description": "Fetches agreement details of the provided agreement Id. The API returns values of all agreement fields including custom fields if configured.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement to get the agreement details",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns details of agreement of the provided agreemend id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.3177781Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.3177784Z","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"InitiationType":null,"InternalRenewalNotificationDays":null,"InternalRenewalStartDate":null,"ParentAgreement":null,"Perpetual":null,"PrimaryContact":null,"RemainingContractedDays":null,"RenewalNoticeDate":null,"RenewalNoticeDays":null,"RetentionDate":null,"RetentionPolicyId":null,"Source":null,"SpecialTerms":null,"SubmitRequestMode":null,"TerminationComments":null,"TerminationDate":null,"TerminationNoticeDays":null,"TerminationNoticeIssueDate":null,"ExecutedDate":null,"Currency":"USD","ContractDurationDays":null,"ContractedDays":null},"Errors":null}
}
}
}
}
},
"delete": {
"tags": [
"Agreement"
],
"summary": "Delete an agreement",
"description": "Deletes the agreement record of the provided agreement Id. The API deletes the agreement permanently from the system.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the agreement is deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/signstatus": {
"put": {
"tags": [
"Agreement"
],
"summary": "Update an agreement's sign status",
"description": "Updates an agreement's sign status. To be consumed from Esign Service API",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement to be updated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "signStatus",
"in": "query",
"description": "SIGNED or DECLINED or OUT FOR SIGNATURE",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided Agreement Id or Sign Status is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns whether the sign status updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Success","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/query": {
"post": {
"tags": [
"Agreement"
],
"summary": "Query agreement records",
"description": "Executes the query request against the agreement records and returns the matching records.",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomQuery"
}
}
}
},
"responses": {
"400": {
"description": "Provided query is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement records that match the query",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryQueryResponseAPIResponse"
},
"example": {"Success":true,"Data":{"RecordCount":1,"Data":[{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-01-16T11:59:24","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-01-16T11:59:24","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"Currency":"USD"}],"StatusCode":0},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/clauses": {
"get": {
"tags": [
"Agreement Clause"
],
"summary": "Get agreement clauses",
"description": "Gets agreement clauses in an agreement by Agreement ID.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of any existing Agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If the given agreement id is not valid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the list of agreement clauses which associated with given agreement id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementClauseListAPIResponse"
},
"example": {"Success":true,"Data":{"Id":"00a06a22-6b98-4583-a5c7-59abee9dfb31","Name":"Affiliate","Agreement":"4ae151a8-ba84-4e60-888e-86326c02d0db","Template":{"Id":"af72e569-9e65-4f97-a7c9-26466c02be51","Name":"SP test Clause"},"Clause":"Affiliate","Category":"Default","Subcategory":"Default","Text":"Affiliate means, with respect to a party, an entity that is directly or indirectly controlled by or is under common control with such party, where “control” means an ownership, voting or similar interest representing fifty percent (50%) or more of the total interests then outstanding of the relevant entity (but only if such person or entity meets these requirements).","Comments":"Marked clause 'Property rights'","MateriallySignificant":false,"CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.3466195Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.3466208Z"},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/clause": {
"post": {
"tags": [
"Agreement Clause"
],
"summary": "Create agreement clause",
"description": "Creates a new agreement clause",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { }
},
"example": {"Name":"Affiliate","Agreement":"4ae151a8-ba84-4e60-888e-86326c02d0db","Template":{"Id":"af72e569-9e65-4f97-a7c9-26466c02be51","Name":"SP test Clause"},"Clause":"Affiliate","Category":"Default","Subcategory":"Default","Text":"Affiliate means, with respect to a party, an entity that is directly or indirectly controlled by or is under common control with such party, where “control” means an ownership, voting or similar interest representing fifty percent (50%) or more of the total interests then outstanding of the relevant entity (but only if such person or entity meets these requirements).","Comments":"Marked clause 'Property rights'","MateriallySignificant":false}
}
}
},
"responses": {
"400": {
"description": "Missing required information in the request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns a newly created agreement clause details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Id":"fd538849-0047-4643-8beb-78f807a69617","Name":"Affiliate","Agreement":"4ae151a8-ba84-4e60-888e-86326c02d0db","Template":{"Id":"af72e569-9e65-4f97-a7c9-26466c02be51","Name":"SP test Clause"},"Clause":"Affiliate","Category":"Default","Subcategory":"Default","Text":"Affiliate means, with respect to a party, an entity that is directly or indirectly controlled by or is under common control with such party, where “control” means an ownership, voting or similar interest representing fifty percent (50%) or more of the total interests then outstanding of the relevant entity (but only if such person or entity meets these requirements).","Comments":"Marked clause 'Property rights'","MateriallySignificant":false,"CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.3523685Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.3523691Z"},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/clause/{clauseId}": {
"put": {
"tags": [
"Agreement Clause"
],
"summary": "Update an agreement clause",
"description": "Updates an agreement clause",
"parameters": [
{
"name": "clauseId",
"in": "path",
"description": "Id of the Agreement Clause to be updated",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { }
},
"example": {"Name":"Affiliate","Agreement":"4ae151a8-ba84-4e60-888e-86326c02d0db","Template":{"Id":"af72e569-9e65-4f97-a7c9-26466c02be51","Name":"SP test Clause"},"Clause":"Affiliate","Category":"Default","Subcategory":"Default","Text":"Affiliate means, with respect to a party, an entity that is directly or indirectly controlled by or is under common control with such party, where “control” means an ownership, voting or similar interest representing fifty percent (50%) or more of the total interests then outstanding of the relevant entity (but only if such person or entity meets these requirements).","Comments":"Marked clause 'Property rights'","MateriallySignificant":false}
}
}
},
"responses": {
"400": {
"description": "Invalid Clause Id or missing required information in the request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns updated agreement clause details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Id":"7b721c37-53a2-4fea-984f-25f1a59f71cd","Name":"Affiliate","Agreement":"4ae151a8-ba84-4e60-888e-86326c02d0db","Template":{"Id":"af72e569-9e65-4f97-a7c9-26466c02be51","Name":"SP test Clause"},"Clause":"Affiliate","Category":"Default","Subcategory":"Default","Text":"Affiliate means, with respect to a party, an entity that is directly or indirectly controlled by or is under common control with such party, where “control” means an ownership, voting or similar interest representing fifty percent (50%) or more of the total interests then outstanding of the relevant entity (but only if such person or entity meets these requirements).","Comments":"Marked clause 'Property rights'","MateriallySignificant":false,"CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.3565103Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.3565114Z"},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/documents": {
"post": {
"tags": [
"Agreement Documents"
],
"summary": "Create a new agreement document",
"description": "Creates a new agreement document for the provided agreement Id.\r\n\r\nOn successful creation of an agreement document, the agreement status changes to \"Author Contract\" if the agreement's previous status was \"Request\".",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the Agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"documentAttributes": {
"type": "object",
"additionalProperties": { }
}
}
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"},
"encoding": {
"file": {
"style": "form"
},
"documentAttributes": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement id or file data is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the newly created agreement document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Agreement Documents"
],
"summary": "Delete multiple documents",
"description": "Deletes provided document Ids from provided agreement Id.\r\nIf document Ids are not provided, all documents of the provided agreement Id are deleted.\r\nThe API permanently deletes the document data but document metadata is retained in the system with a flag \"IsDeleted\" as true.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement Id or document Id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the documents deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/documents/{documentId}": {
"get": {
"tags": [
"Agreement Documents"
],
"summary": "Get document by document Id",
"description": "Fetches document details of provided document Id.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the Agreement",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentId",
"in": "path",
"description": "Id of the document to be fetched",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id or document Id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns document details of provided document Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAPIResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Agreement Documents"
],
"summary": "Update agreement document",
"description": "Updates agreement document for the provided document Id. The API creates a new version Id with the same document Id and retains the previous version.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentId",
"in": "path",
"description": "Id of the document to be updated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement Id, document Id, or file data is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns updated agreement document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/documents/query": {
"post": {
"tags": [
"Agreement Documents"
],
"summary": "Query agreement documents",
"description": "Executes the query request against the document records and returns the matching records.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomQueryBase"
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement id or the query is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement documents that match the provided query",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentSearchResponseAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/documents/{documentId}/versions/{documentMetadataId}": {
"get": {
"tags": [
"Agreement Documents"
],
"summary": "Get document by document Id and version Id",
"description": "Fetches document details of given document Id and version Id",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentId",
"in": "path",
"description": "Id of the document to be fetched",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentMetadataId",
"in": "path",
"description": "Id of the document version to be fetched",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id, document Id, or version Id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns document details of provided document Id and version Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/documents/agreementrelateddocuments": {
"get": {
"tags": [
"Agreement Documents"
],
"summary": "Get all Agreement related documents",
"description": "Get all Agreement related documents of the given agreementId",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If the given agreementId is not valid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the list of documents",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentWrapperListAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/importoffline": {
"post": {
"tags": [
"Agreement Documents"
],
"summary": "Create a new agreement document",
"description": "Creates a new agreement document for provided agreement Id.\r\n\r\nOn creating a new agreement document, the agreement status changes to \"Author Contract\"",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the Agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"documentAttributes": {
"type": "object",
"additionalProperties": { }
}
}
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"},
"encoding": {
"file": {
"style": "form"
},
"documentAttributes": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement Id or file data is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the newly created agreement document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/createoffline": {
"post": {
"tags": [
"Agreement Documents"
],
"summary": "Creates an agreement and document",
"description": "Create a new agreement record and add an initial document to the agreement record.\r\n\r\nOn creating an agreement record, the status changes to \"Author Contract\"",
"parameters": [
{
"name": "agreement",
"in": "query",
"description": "",
"schema": {
"type": "object",
"additionalProperties": { }
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"documentAttributes": {
"type": "object",
"additionalProperties": { }
}
}
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"},
"encoding": {
"file": {
"style": "form"
},
"documentAttributes": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement data or file data is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the newly created agreement document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/storeexecuted": {
"post": {
"tags": [
"Agreement Documents"
],
"summary": "Creates an agreement and document",
"description": "Creates a new agreement record and adds an already executed contract document to the agreement record.\r\n\r\nThe status of the newly created agreement is set to \"Activated\"",
"parameters": [
{
"name": "agreement",
"in": "query",
"description": "",
"schema": {
"type": "object",
"additionalProperties": { }
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"documentAttributes": {
"type": "object",
"additionalProperties": { }
}
}
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"},
"encoding": {
"file": {
"style": "form"
},
"documentAttributes": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Provided agreement data or file data is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns Agreement document details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/activate": {
"post": {
"tags": [
"Agreement Lifecycle"
],
"summary": "Activate an agreement",
"description": "Activates an agreement or brings an agreement into effect after an agreement is finalized and signed by stakeholders.\r\nActivating an agreement ensures that key dates and events are monitored by the system and all in-effect agreements are included in appropriate searches and views.\r\nTo activate an agreement, the agreement status must be \"Fully signed\". \"Contract Start Date\" and \"Contract End Date\" fields of the agreement must have a valid date.\r\nOn activating an agreement, the status changes to \"Activated\".\r\nThe Activated By field is updated with the current user.\r\nThe Activated Date field is updated to the current date.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Agreement ID of the agreement to be activated",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid or the agreement is in an invalid state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the agreement is activated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Success","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/amend": {
"post": {
"tags": [
"Agreement Lifecycle"
],
"summary": "Amend an agreement",
"description": "During the term of the agreement, we may need to modify the contract. For example, the language or terms of the contract.\r\nThe Amend action is used for this functionality. The Amend action creates a new version of the agreement record. \r\nThe new, amended record shares the same base agreement number as the original with the decimal point incremented by one.\r\nAll the data from the original version is copied into the new version.\r\n\r\nTo amend an agreement, the agreement status must be \"Activated\", \"Superseded\", or \"Being Terminated\".\r\n\r\nOn successful amendment, the status of the original agreement changes to \"Being Amended\".",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Agreement ID of the agreement to be amended",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid or the agreement is in an invalid state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement ID of the newly created agreement",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"a233b523-cbdc-4d4e-9f31-dfcc1b691e8e","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/renew": {
"post": {
"tags": [
"Agreement Lifecycle"
],
"summary": "Renew an agreement",
"description": "Renews an agreement at the end of the term to a further period of time. \r\nThe renewed agreement (new agreement) shares the same base agreement number as the original with the decimal point incremented by one. All the data from the original version is copied to a new version.\r\nTo renew an agreement, the status of the agreement must be \"Activated\", \"Superseded\", or \"Being Terminated\".\r\nOn successful renewal, the status of the original agreement changes to \"Being Renewed\".\r\nContract start date of the new agreement is set to the same date as the end date of the original contract.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Agreement ID of the agreement to be renewed",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid or the agreement is in an invalid state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement ID of the newly created agreement",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"d7ad6af6-82a9-4990-b75f-976e70dc1cde","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/clone": {
"post": {
"tags": [
"Agreement Lifecycle"
],
"summary": "Clone an agreement",
"description": "Clones an existing agreement to create a copy of the agreement. Creates a new version of the agreement. All the data from the original version is copied to the new version.\r\n\r\nThe status of the original agreement does not be changed.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Agreement ID of the agreement to be cloned",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid or the agreement is in an invalid state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement ID of the newly created agreement",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"98b313f2-de92-43ad-993b-3fa585d8160d","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/terminate": {
"post": {
"tags": [
"Agreement Lifecycle"
],
"summary": "Terminate an agreement",
"description": "Terminates an executed agreement to end an agreement.\r\n\r\nTo terminate an agreement, the status of the agreement to be \"Activated\" or \"Superseded\" or \"Being Terminated\".\r\n\r\nOn successful termination, the agreement status will be changed to \"Terminated\".",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Agreement ID of the agreement to be terminated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "terminateChildren",
"in": "query",
"description": "Terminate the child agreements of the provided agreement Id",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid or the agreement is in an invalid state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns whether the agreement got terminated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Success","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/expire": {
"post": {
"tags": [
"Agreement Lifecycle"
],
"summary": "Expire an agreement",
"description": "Expires an agreement after the agreement term ends.\r\n\r\nTo mark an agreement as expired, the status of the agreement must be \"Activated\", \"Superseded\", or \"Being Terminated\".\r\n\r\nOn successful expiration, the agreement status will be changed to Expired.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Agreement ID of the agreement to be expired",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is invalid or the agreement is in an invalid state",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the agreement is expired",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Success","Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/{objectName}": {
"post": {
"tags": [
"Agreement Related List"
],
"summary": "Creates one or more records for the given {objectname}",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Identifier of an agreement record",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectName",
"in": "path",
"description": "API name of the related object",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List of fields and values to be inserted",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Agreement Related List"
],
"summary": "Deletes one or more records for the given {objectname}",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Identifier of an agreement record",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectName",
"in": "path",
"description": "API name of the related object",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List of Identifiers for the {objectname} to be deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementRelatedListDeleteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringResultStatusDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"64608ac0-f8d6-482e-8585-cf7f2cdb0b7b":"Success","d2fd6dcd-c28c-44ca-9961-b01fc00cbc6a":"Success"},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/{objectName}/{objectId}": {
"put": {
"tags": [
"Agreement Related List"
],
"summary": "Update the details for a given {objectname} {objectid} if it exists",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Identifier of an agreement record",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectName",
"in": "path",
"description": "API name of the related object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "path",
"description": "Identifier of the {objectname} record",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List of fields and values to be updated",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { }
},
"example": {"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00"}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.453478Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.4534782Z","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"InitiationType":null,"InternalRenewalNotificationDays":null,"InternalRenewalStartDate":null,"ParentAgreement":null,"Perpetual":null,"PrimaryContact":null,"RemainingContractedDays":null,"RenewalNoticeDate":null,"RenewalNoticeDays":null,"RetentionDate":null,"RetentionPolicyId":null,"Source":null,"SpecialTerms":null,"SubmitRequestMode":null,"TerminationComments":null,"TerminationDate":null,"TerminationNoticeDays":null,"TerminationNoticeIssueDate":null,"ExecutedDate":null,"Currency":"USD","ContractDurationDays":null,"ContractedDays":null},"Errors":null}
}
}
}
}
},
"get": {
"tags": [
"Agreement Related List"
],
"summary": "Retrieve the details for a given {objectname} {objectid}",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Identifier of an agreement record",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectName",
"in": "path",
"description": "API name of the related object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "path",
"description": "Identifier of the {objectname} record",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryAPIResponse"
},
"example": {"Success":true,"Data":{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-02-07T10:27:36.4560598Z","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-02-07T10:27:36.4560606Z","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"InitiationType":null,"InternalRenewalNotificationDays":null,"InternalRenewalStartDate":null,"ParentAgreement":null,"Perpetual":null,"PrimaryContact":null,"RemainingContractedDays":null,"RenewalNoticeDate":null,"RenewalNoticeDays":null,"RetentionDate":null,"RetentionPolicyId":null,"Source":null,"SpecialTerms":null,"SubmitRequestMode":null,"TerminationComments":null,"TerminationDate":null,"TerminationNoticeDays":null,"TerminationNoticeIssueDate":null,"ExecutedDate":null,"Currency":"USD","ContractDurationDays":null,"ContractedDays":null},"Errors":null}
}
}
}
}
},
"delete": {
"tags": [
"Agreement Related List"
],
"summary": "Delete the details for a given {objectname} {objectid}",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Identifier of an agreement record",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectName",
"in": "path",
"description": "API name of the related object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "path",
"description": "Identifier of the {objectname} record",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/{objectName}/query": {
"post": {
"tags": [
"Agreement Related List"
],
"summary": "Retrieves all records for {objectname} and sorts the results matching the query params",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Identifier of an agreement record",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectName",
"in": "path",
"description": "API name of the related object",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Query params to filter and sort the list of records",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomQuery"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryQueryResponseAPIResponse"
},
"example": {"Success":true,"Data":{"RecordCount":1,"Data":[{"Name":"Agreement-Demo","Account":{"Id":"0474fc7a-5914-4059-a412-e88afb581b7a","Name":"Conga"},"RecordType":{"Id":"a57e4edf-c261-42dc-9d89-37c040a8a8a3","Name":"MSA"},"AgreementCategory":"Sales","TotalContractValue":2000,"ContractStartDate":"2023-01-01T00:00:00","ContractEndDate":"2023-12-31T00:00:00","Owner":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"Status":"Request","StatusCategory":"Request","Id":"0c4dadb2-a7ee-4672-bfa3-3c9ee2ac85d1","CreatedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"CreatedDate":"2023-01-16T11:59:24","ModifiedBy":{"Id":"d717a075-9cbf-480c-b230-837e0e6dee75","Name":"user"},"ModifiedDate":"2023-01-16T11:59:24","ExternalId":null,"ActivatedBy":null,"ActivatedDate":null,"AgreementNumber":"42","AmendmentEffectiveDate":null,"AutoRenewConsent":null,"AutoRenewTermMonths":null,"AutoRenewalTerms":null,"AutoRenewal":null,"ContractNumber":42,"Description":null,"Currency":"USD"}],"StatusCode":0},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/configurations/category/{category}/name/{name}": {
"get": {
"tags": [
"Configurations"
],
"summary": "Get configuration",
"description": "Gets CLM configuration settings by category and name. All CLM-related configurations are available in the \"CLM\" category.",
"parameters": [
{
"name": "category",
"in": "path",
"description": "Category in which the setting resides",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "path",
"description": "Configuration setting name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Setting is unavailable for the provided category and configuration name",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the configuration details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/generate": {
"post": {
"tags": [
"Document Generation"
],
"summary": "Generate document",
"description": "Generate a new agreement document using an existing template. Templates can be created using X-Author for Contracts\r\n\r\nOn generating a new document, the agreement status changes to \"Author Contract\".",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Options to generate the document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocGenAttributes"
}
}
}
},
"responses": {
"400": {
"description": "Provided value is invalid or the required value is not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns details of generated document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentGenerationResultAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/regenerate": {
"post": {
"tags": [
"Document Generation"
],
"summary": "Regenerate document",
"description": "Regenerate an agreement document using an existing template. Templates can be created using X-Author for Contracts.\r\n\r\nThe agreement status does not change.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of the agreement",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Options to regenerate the document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocGenAttributes"
}
}
}
},
"responses": {
"400": {
"description": "Required values are not provided or provided values are invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns details of regenerated document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentGenerationResultAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/health/live": {
"get": {
"tags": [
"Health Check"
],
"summary": "Check for liveness",
"description": "Checks whether the CLM service is operational.",
"responses": {
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the summary of liveness of dependent services",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckSummaryAPIResponse"
}
}
}
},
"503": {
"description": "If service is unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
}
}
}
},
"/api/clm/v1/health/ready": {
"get": {
"tags": [
"Health Check"
],
"summary": "Check for readiness",
"description": "Checks whether the CLM service is ready to execute the request.",
"responses": {
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the summary of readiness of dependent services",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckSummaryAPIResponse"
}
}
}
},
"503": {
"description": "Service is unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
}
}
}
},
"/api/clm/v1/agreements/relatedagreements": {
"post": {
"tags": [
"Related Agreement"
],
"summary": "Link agreemnents",
"description": "Links an agreement with another agreement. During Amend or Renew process, the original and the new agreement are linked automatically.\r\nYou can use this endpoint to link any agreements as parent-child.",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedAgreement"
}
}
}
},
"responses": {
"400": {
"description": "Provided value is invalid or the required value is not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns the linked agreement Ids and their relationship details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedAgreementAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/relatedagreements/{relationshipId}": {
"delete": {
"tags": [
"Related Agreement"
],
"summary": "Unlink agreements",
"description": "Unlinks the relationship of an agreement with another agreement.",
"parameters": [
{
"name": "relationshipId",
"in": "path",
"description": "Relationship Id which created during Link",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided relationship Id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the agreements are unlinked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/agreementhierarchy": {
"get": {
"tags": [
"Related Agreement"
],
"summary": "Get hierarchy of an agreement",
"description": "Gets agreement hierarchy of the provided agreement Id. It fetches the agreement's child agreements and also its descendant agreements.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of an agreement whose hierarchy needs to be fetched",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id is not valid or the agreement is not in hierarchy",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns hierarchy of the given agreement Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementHierarchyListAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/agreements/{agreementId}/relatedagreements": {
"get": {
"tags": [
"Related Agreement"
],
"summary": "Get related agreement details",
"description": "Gets relationship details if any agreements are linked to the provided agreement Id",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of an agreement whose relationship details need to be fetched",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement Id for an agreement is not valid or the agreement does not have any related agreements",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns agreement relationship details for the provided agreement Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedAgreementListAPIResponse"
}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles": {
"post": {
"tags": [
"Review Cycle"
],
"summary": "Initiate a review cycle",
"description": "Sends contract documents for review and initiates a review cycle by sending contract documents to reviewers. \r\nTwo types of reviews are available in CLM — \"Simple Review\" and \"Office 365 Review\". \r\nWhen you send documents for Simple Review, all review documents and supporting documents are sent to reviewers as email attachments. Reviewers can send back the reviewed documents to the review initiator via email. \r\nWhen you send a document for Office 365 Review, the review document is shared as Office 365 document links and supporting documents are sent as email attachments. Reviewers can directly review documents via Office 365 and the reviews are imported into CLM automatically at the end of the review. \r\nWhen you send documents for Office 365 review, documents must be in DOCX format. Whereas, supporting documents can be of any format. \r\nOffice 365 Review can be initiated only for one document at a time. After completing any ongoing review, you can initiate a new review for another document from the same contract. \r\nIn both reviews, the agreement status changes to \"Other Party Review\" after sending documents for review.",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewCycleStartRequest"
},
"examples": {
"SimpleReview": {
"value": {"Name":"Simple Review for sales agreement document","ReviewCycleType":"SimpleReview","AgreementId":"6cda8455-0698-412d-af52-da8a272fccfd","PrimaryDocumentIds":["facf5aa7-5822-47ed-abb7-ac2ddab36aa5"],"SupportingDocumentIds":null,"AdditionalAttachments":null,"EmailTemplateId":null,"EmailSubject":"Sales agreement Review","EmailBody":"Please review the attached sales contract","To":[{"Name":null,"EmailId":"david@conga.com","ADMemberId":null,"RecipientType":null,"RecipientId":null},{"Name":null,"EmailId":"john@conga.com","ADMemberId":null,"RecipientType":null,"RecipientId":null}],"Cc":null,"Bcc":null}
},
"Office365Review": {
"value": {"Name":"Office 365 Review for sales agreement document","ReviewCycleType":"Office365Review","AgreementId":"f9a33c87-76c7-461b-a8e8-125ad0547938","PrimaryDocumentIds":["5874686f-cfbc-4625-8c99-57f2009804e4"],"SupportingDocumentIds":null,"AdditionalAttachments":null,"EmailTemplateId":null,"EmailSubject":"Sales agreement Review","EmailBody":"Please review the attached sales contract","To":[{"Name":"David","EmailId":"david@conga.com","ADMemberId":null,"RecipientType":"Email","RecipientId":null},{"Name":"John","EmailId":"john@conga.com","ADMemberId":null,"RecipientType":"Email","RecipientId":null}],"Cc":null,"Bcc":null}
}
}
}
}
},
"responses": {
"400": {
"description": "Provided request input is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the review cycle is initiated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/{agreementId}": {
"get": {
"tags": [
"Review Cycle"
],
"summary": "Get review details",
"description": "Gets review cycle details if there is an active Office 365 Review for provided agreement Id. \r\nYou can use review cycle details to add, delete, or end a review. \r\nYou can also use the review cycle details to end or cancel an entire review cycle for any existing Office 365 Review. \r\nThis API is not applicable for SimpleReview.",
"parameters": [
{
"name": "agreementId",
"in": "path",
"description": "Id of an agreement with an active Office 365 review cycle",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement id is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns review cycle details if there is any active Office 365 Review for the provided agreement Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewCycleResponseListAPIResponse"
},
"example": {"Success":true,"Data":{"ReviewCycleId":"7388e312-4095-45f0-a23d-ba49e4f4282d","Name":"Office 365 Review for sales agreement document","OriginalDocumentId":"f47abf8b-f595-4780-8b77-c0d15fa94df8","FinalDocumentVersionId":null,"ADDocumentId":"4a96a94c-5d09-42cb-b576-d0373972292c","ReviewStatus":"In Progress","Reviewers":[{"ReviewerId":"0b79f51a-aabd-4df7-a033-3ecdd397ede2","Name":"David","EmailId":"david@conga.com","ReviewStatus":"In Progress"},{"ReviewerId":"64d41ff0-a90e-45e8-a819-cb6e3a5a6d96","Name":"John","EmailId":"john@conga.com","ReviewStatus":"Completed"}]},"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/end": {
"put": {
"tags": [
"Review Cycle"
],
"summary": "End a review cycle",
"description": "Ends a review cycle and marks it as completed. For Simple Review, the agreement status changes to Ready for signature. \r\nFor Office 365 Review, in addition to the status change to Ready for signature, Office 365 document access is revoked for all the reviewers. \r\nThe final version of the reviewed document is available in the contract with a new version number. \r\nAn email notification is sent to all active reviewers.",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewCycleEndRequest"
},
"examples": {
"SimpleReview": {
"value": {"ReviewCycleType":"SimpleReview","ReviewCycleId":null,"AgreementId":"fa63b00b-67ac-40dc-9dac-bf1877a69ccb"}
},
"Office365Review": {
"value": {"ReviewCycleType":"Office365Review","ReviewCycleId":"b5a61082-9439-4736-8ee3-5bd169fbbc9c","AgreementId":"508b501c-590f-498b-966d-724edc823065"}
}
}
}
}
},
"responses": {
"400": {
"description": "Provided request input is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the review cycle ended",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/cancel": {
"put": {
"tags": [
"Review Cycle"
],
"summary": "Cancel a review cycle",
"description": "Cancels a review cycle and marks it as canceled. The API is not applicable for SimpleReview. \r\nFor Office 365 Review, the agreement status changes to Author Contract. \r\nOffice 365 document access is revoked for all reviewers. Email notification is sent to all active reviewers.",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewCycleCancelRequest"
},
"example": {"ReviewCycleType":"Office365Review","ReviewCycleId":"11b85d19-7b92-4ff7-8c73-64bd5915f008"}
}
}
},
"responses": {
"400": {
"description": "Provided request input is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the review cycle is canceled",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/{reviewCycleId}/reviewers": {
"post": {
"tags": [
"Review Cycle"
],
"summary": "Add reviewers",
"description": "Adds one or more reviewers to an active review cycle. You cannot add reviewers to a review cycle that was canceled or ended. \r\nWhen you add a reviewer, an email with the Office 365 document link of the Primary document is sent to newly added reviewers. \r\nThis API is not applicable for Simple Review",
"parameters": [
{
"name": "reviewCycleId",
"in": "path",
"description": "Review cycle Id of any active review cycle",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewersAddRequest"
},
"example": {"Reviewers":[{"Name":"David","EmailId":"david@conga.com","ADMemberId":null,"RecipientType":"Email","RecipientId":null},{"Name":"John","EmailId":"john@conga.com","ADMemberId":null,"RecipientType":"Email","RecipientId":null}]}
}
}
},
"responses": {
"400": {
"description": "Provided request input is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the reviewers are added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
},
"delete": {
"tags": [
"Review Cycle"
],
"summary": "Remove reviewers",
"description": "Remove one or more reviewers from an active review cycle. You cannot remove reviewers from a review cycle that was canceled or ended. \r\nWhen you remove reviewers from an active review cycle, Office 365 document access is revoked for the removed reviewers. \r\nAn email notification is sent to all removed reviewers. If any changes were made to the review document before removing the reviewer, those changes are retained. \r\nThis API is not applicable for Simple Review.",
"parameters": [
{
"name": "reviewCycleId",
"in": "path",
"description": "ReviewcycleId of any active review cycle",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewersUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Provided request input is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that reviewers are removed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/{reviewCycleId}/reviewers/end": {
"post": {
"tags": [
"Review Cycle"
],
"summary": "End review cycle of reviewers",
"description": "Ends review cycle for one or more reviewers. You cannot end a review of a review cycle that was canceled or the review cycle has ended. \r\nAn email notification is sent to all reviewers after the review cycle ends. \r\nIf any changes were made to the review document before ending the review, those changes are retained. \r\nThis API is not applicable for Simple Review.",
"parameters": [
{
"name": "reviewCycleId",
"in": "path",
"description": "ReviewcycleId of any active review cycle",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewersUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Provided request input is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns confirmation that the review cycle has ended",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanAPIResponse"
},
"example": {"Success":true,"Data":true,"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/usersearch/{searchString}": {
"get": {
"tags": [
"Review Cycle"
],
"summary": "Search users",
"description": "Searches users by name or email id. For \"SimpleReview\", the endpoint searches users and contact data sources. \r\nFor \"Office365Review\", the endpoint searches users, contact data sources, and active directory users.",
"parameters": [
{
"name": "searchString",
"in": "path",
"description": "Search keyword. It can be user name or user email id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "agreementId",
"in": "query",
"description": "Id of any existing agreement",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reviewCycleType",
"in": "query",
"description": "Review cycle type is either \"SimpleReview\" or \"Office365Review\"",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Provided agreement id or review cycle type is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns a list of users that matches provided keyword",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipientListAPIResponse"
},
"example": {"Success":true,"Data":[{"Id":"7bc8ec35-a8be-4913-9180-04c402ffce9d","Name":"David","EmailId":"david@conga.com","RecipientType":"Email"},{"Id":"d78be293-6370-4d56-be6f-62def04563cc","Name":"John","EmailId":"john@conga.com","RecipientType":"User"}],"Errors":null}
}
}
}
}
}
},
"/api/clm/v1/reviewcycles/token": {
"post": {
"tags": [
"Review Cycle"
],
"summary": "Get Active Directory access token",
"description": "Get an active directory access token for Office 365 Review to test Office 365 SharePoint configurations",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessTokenRequest"
}
}
}
},
"responses": {
"400": {
"description": "Provided URL or authentication details are invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Error Message"}]}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponseError"
},
"example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]}
}
}
},
"200": {
"description": "Returns access token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Success","Errors":null}
}
}
}
}
}
}
},
"components": {
"schemas": {
"APIResponseError": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "string",
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"AccessTokenRequest": {
"type": "object",
"properties": {
"LoginUrl": {
"type": "string",
"description": "Login URL for Office 365 authentication",
"nullable": true
},
"Scope": {
"type": "string",
"description": "Scope for Office 365 authentication",
"nullable": true
},
"ClientId": {
"type": "string",
"description": "Client Id for Office 365 authentication",
"nullable": true
},
"ClientSecret": {
"type": "string",
"description": "Client Secret for Office 365 authentication",
"nullable": true
},
"Code": {
"type": "string",
"description": "Authentication code provided by Microsoft for Office 365 delegate authentication",
"nullable": true
}
},
"additionalProperties": false,
"description": "Microsoft O365 Authentication details"
},
"AgreementClause": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"Agreement": {
"type": "string",
"description": "Agreement associated with the Clause",
"nullable": true
},
"Template": {
"$ref": "#/components/schemas/LookupObject"
},
"Clause": {
"type": "string",
"description": "Clause Name",
"nullable": true
},
"Category": {
"type": "string",
"description": "Category of the Clause",
"nullable": true
},
"Text": {
"type": "string",
"description": "Clause Text",
"nullable": true
},
"Comments": {
"type": "string",
"description": "Comments",
"nullable": true
},
"MateriallySignificant": {
"type": "boolean",
"description": "Whether the clause is materially significant",
"nullable": true
}
},
"additionalProperties": { }
},
"AgreementClauseListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementClause"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"AgreementHierarchy": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"Account": {
"$ref": "#/components/schemas/LookupObject"
},
"ActivatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ActivatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"AgreementCategory": {
"type": "string",
"nullable": true
},
"AgreementNumber": {
"type": "string",
"nullable": true
},
"AmendmentEffectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"AutoRenewConsent": {
"type": "boolean",
"nullable": true
},
"AutoRenewTermMonths": {
"type": "number",
"format": "double",
"nullable": true
},
"AutoRenewalTerms": {
"type": "string",
"nullable": true
},
"AutoRenewal": {
"type": "boolean",
"nullable": true
},
"ContractDurationDays": {
"type": "number",
"format": "double",
"nullable": true
},
"ContractEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ContractNumber": {
"type": "integer",
"format": "int64"
},
"ContractStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ContractedDays": {
"type": "number",
"format": "double",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"InitiationType": {
"type": "string",
"nullable": true
},
"InternalRenewalNotificationDays": {
"type": "number",
"format": "double",
"nullable": true
},
"InternalRenewalStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"OtherPartyReturnedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"OtherPartySentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"OutstandingDays": {
"type": "string",
"nullable": true
},
"OwnerExpirationNotice": {
"type": "string",
"nullable": true
},
"Owner": {
"$ref": "#/components/schemas/LookupObject"
},
"ParentAgreement": {
"$ref": "#/components/schemas/LookupObject"
},
"Perpetual": {
"type": "boolean",
"nullable": true
},
"PrimaryContact": {
"$ref": "#/components/schemas/LookupObject"
},
"RelatedOpportunity": {
"$ref": "#/components/schemas/LookupObject"
},
"RemainingContractedDays": {
"type": "string",
"nullable": true
},
"RenewalNoticeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RenewalNoticeDays": {
"type": "number",
"format": "double",
"nullable": true
},
"RetentionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RetentionPolicyId": {
"$ref": "#/components/schemas/LookupObject"
},
"Source": {
"type": "string",
"nullable": true
},
"SpecialTerms": {
"type": "string",
"nullable": true
},
"StatusCategory": {
"type": "string",
"nullable": true
},
"Status": {
"type": "string",
"nullable": true
},
"SubmitRequestMode": {
"type": "string",
"nullable": true
},
"TermMonths": {
"type": "number",
"format": "double",
"nullable": true
},
"TerminationComments": {
"type": "string",
"nullable": true
},
"TerminationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"TerminationNoticeDays": {
"type": "number",
"format": "double",
"nullable": true
},
"TerminationNoticeIssueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"TotalContractValue": {
"$ref": "#/components/schemas/CurrencyField"
},
"ExecutedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RecordType": {
"$ref": "#/components/schemas/LookupObject"
},
"RelatedAgreement": {
"$ref": "#/components/schemas/RelatedAgreement"
},
"Children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementHierarchy"
},
"nullable": true
}
},
"additionalProperties": { }
},
"AgreementHierarchyListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementHierarchy"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"AgreementRelatedListDeleteRequest": {
"type": "object",
"properties": {
"DeleteAll": {
"type": "boolean",
"description": "Flag to determine if all records under the provided Agreement Id to be deleted"
},
"ObjectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ObjectIds to be deleted",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"BooleanAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "boolean"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ComponentHealthCheckSummary": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": true
},
"Status": {
"type": "string",
"nullable": true
},
"Error": {
"type": "string",
"nullable": true
},
"Duration": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Configuration": {
"type": "object",
"properties": {
"Category": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"Value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/Configuration"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ContentType": {
"type": "object",
"properties": {
"Boundary": {
"type": "string",
"nullable": true
},
"CharSet": {
"type": "string",
"nullable": true
},
"MediaType": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"Parameters": {
"type": "array",
"items": { },
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"CurrencyField": {
"type": "object",
"properties": {
"Value": {
"type": "number",
"format": "double"
},
"DisplayValue": {
"type": "number",
"format": "double",
"readOnly": true
},
"CurrencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"CurrencySymbol": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"CustomQuery": {
"type": "object",
"properties": {
"Limit": {
"type": "integer",
"description": "Number of the records to be fetched",
"format": "int32",
"nullable": true
},
"Skip": {
"type": "integer",
"description": "Number of the records to be skipped",
"format": "int32",
"nullable": true
},
"SortInfo": {
"$ref": "#/components/schemas/SortInfo"
},
"CriteriaExpression": {
"type": "string",
"description": "Criteria Expression to filter the records",
"nullable": true
},
"Distinct": {
"type": "boolean",
"description": "Whether to fetch only distinct records"
},
"Fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of fields to be fetched",
"nullable": true
},
"GroupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Group Field name if the result to be grouped",
"nullable": true
}
},
"additionalProperties": false
},
"CustomQueryBase": {
"type": "object",
"properties": {
"Limit": {
"type": "integer",
"description": "Number of the records to be fetched",
"format": "int32",
"nullable": true
},
"Skip": {
"type": "integer",
"description": "Number of the records to be skipped",
"format": "int32",
"nullable": true
},
"SortInfo": {
"$ref": "#/components/schemas/SortInfo"
},
"CriteriaExpression": {
"type": "string",
"description": "Criteria Expression to filter the records",
"nullable": true
}
},
"additionalProperties": false
},
"DocGenAttributes": {
"required": [
"TemplateId"
],
"type": "object",
"properties": {
"TemplateId": {
"minLength": 1,
"type": "string",
"description": "Template Id"
},
"IncludeWatermark": {
"type": "boolean",
"description": "Include Wathermark or not"
},
"Action": {
"type": "string",
"description": "Action. i.e. Generate, Regenerate",
"nullable": true
},
"OutputFormat": {
"$ref": "#/components/schemas/DocumentFormat"
},
"OutputFileName": {
"type": "string",
"description": "Generated file name",
"nullable": true
},
"WatermarkText": {
"type": "string",
"description": "Set WatermarkText",
"nullable": true
},
"ProtectionType": {
"$ref": "#/components/schemas/ProtectionType"
}
},
"additionalProperties": false,
"description": "Document Generation model"
},
"Document": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"DocumentMetadata": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"BlobData": {
"type": "string",
"format": "byte",
"nullable": true
}
},
"additionalProperties": { }
},
"DocumentAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/Document"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentFormat": {
"enum": [
"DOCX",
"DOC",
"PDF",
"RTF"
],
"type": "string",
"description": "Document format support for different file"
},
"DocumentGenerationResult": {
"type": "object",
"properties": {
"DocumentVersionId": {
"type": "string",
"nullable": true
},
"Status": {
"type": "boolean"
},
"Message": {
"type": "string",
"nullable": true
},
"DocumentId": {
"type": "string",
"nullable": true
},
"DocumentParentId": {
"type": "string",
"nullable": true
},
"Document": {
"type": "string",
"format": "byte",
"nullable": true
},
"DocumentType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response of Document Generation"
},
"DocumentGenerationResultAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/DocumentGenerationResult"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentMetadata": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"Extension": {
"type": "string",
"nullable": true
},
"Tags": {
"type": "string",
"nullable": true
},
"ObjectType": {
"type": "string",
"nullable": true
},
"ObjectId": {
"type": "string",
"nullable": true
},
"DocumentId": {
"type": "string",
"nullable": true
},
"DocumentVersion": {
"type": "integer",
"format": "int32"
},
"IsDeleted": {
"type": "boolean"
},
"CheckoutBy": {
"type": "string",
"nullable": true
},
"CheckoutDate": {
"type": "string",
"format": "date-time"
},
"FileSize": {
"type": "integer",
"format": "int64"
},
"FileType": {
"type": "string",
"nullable": true
},
"IsLatest": {
"type": "boolean"
}
},
"additionalProperties": { }
},
"DocumentMetadataAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentSearchResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"nullable": true
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentSearchResponseAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/DocumentSearchResponse"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentWrapper": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"DocumentMetadata": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"BlobData": {
"type": "string",
"format": "byte",
"nullable": true
},
"RelationshipType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"DocumentWrapperListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentWrapper"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"EmailAttachment": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": true
},
"ContentType": {
"$ref": "#/components/schemas/ContentType"
},
"FileData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ErrorDetail": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HealthCheckSummary": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Status": {
"type": "string",
"nullable": true
},
"ServiceVersion": {
"type": "string",
"nullable": true
},
"ComponentHealthSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponentHealthCheckSummary"
},
"nullable": true
},
"Duration": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"HealthCheckSummaryAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/HealthCheckSummary"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"HttpStatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"Processing",
"EarlyHints",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultiStatus",
"AlreadyReported",
"IMUsed",
"MultipleChoices",
"MovedPermanently",
"Found",
"SeeOther",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"PermanentRedirect",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"MisdirectedRequest",
"UnprocessableEntity",
"Locked",
"FailedDependency",
"UpgradeRequired",
"PreconditionRequired",
"TooManyRequests",
"RequestHeaderFieldsTooLarge",
"UnavailableForLegalReasons",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported",
"VariantAlsoNegotiates",
"InsufficientStorage",
"LoopDetected",
"NotExtended",
"NetworkAuthenticationRequired"
],
"type": "string"
},
"LookupObject": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProtectionType": {
"enum": [
"AllowOnlyRevisions",
"AllowOnlyComments",
"AllowOnlyFormFields",
"AllowOnlyReading",
"NoProtection"
],
"type": "string",
"description": "Protection Level. i.e. Full Access, Insert and Comment changes etc."
},
"Recipient": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"EmailId": {
"type": "string",
"nullable": true
},
"RecipientType": {
"$ref": "#/components/schemas/RecipientType"
}
},
"additionalProperties": false
},
"RecipientListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"RecipientType": {
"enum": [
"Contact",
"Email",
"User"
],
"type": "string"
},
"RelatedAgreement": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"ContractFrom": {
"$ref": "#/components/schemas/LookupObject"
},
"ContractTo": {
"$ref": "#/components/schemas/LookupObject"
},
"RelationshipFromType": {
"type": "string",
"nullable": true
},
"RelationshipToType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"RelatedAgreementAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/RelatedAgreement"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedAgreementListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedAgreement"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ResultStatus": {
"enum": [
"Success",
"Fail",
"NotFound",
"Invalid",
"Conflict"
],
"type": "string"
},
"ReviewCycleCancelRequest": {
"required": [
"ReviewCycleId",
"ReviewCycleType"
],
"type": "object",
"properties": {
"ReviewCycleType": {
"minLength": 1,
"type": "string",
"description": "Review Cycle Type (\"Simple Review\" or \"Office 365 Review\")"
},
"ReviewCycleId": {
"minLength": 1,
"type": "string",
"description": "Review Cycle Id"
}
},
"additionalProperties": false
},
"ReviewCycleEndRequest": {
"required": [
"ReviewCycleType"
],
"type": "object",
"properties": {
"ReviewCycleType": {
"minLength": 1,
"type": "string",
"description": "Review Cycle Type (\"Simple Review\" or \"Office 365 Review\")"
},
"ReviewCycleId": {
"type": "string",
"description": "Review Cycle Id",
"nullable": true
},
"AgreementId": {
"type": "string",
"description": "Agreement Id",
"nullable": true
}
},
"additionalProperties": false
},
"ReviewCycleResponse": {
"type": "object",
"properties": {
"ReviewCycleId": {
"type": "string",
"description": "Review Cycle Id",
"nullable": true
},
"Name": {
"type": "string",
"description": "Review Cycle Name",
"nullable": true
},
"OriginalDocumentId": {
"type": "string",
"description": "Document Id of the document sent for review",
"nullable": true
},
"FinalDocumentVersionId": {
"type": "string",
"description": "Version Id of the document that is uploaded to CLM after a review ends.",
"nullable": true
},
"ADDocumentId": {
"type": "string",
"description": "Active Directory document Id",
"nullable": true
},
"ReviewStatus": {
"type": "string",
"description": "Review cycle status (\"Initiated\", \"In Progress\", \"Completed\", or \"Canceled\")",
"nullable": true
},
"Reviewers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewerResponse"
},
"description": "Reviewers List",
"nullable": true
}
},
"additionalProperties": false
},
"ReviewCycleResponseListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewCycleResponse"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReviewCycleStartRequest": {
"required": [
"AgreementId",
"EmailBody",
"EmailSubject",
"Name",
"PrimaryDocumentIds",
"ReviewCycleType",
"To"
],
"type": "object",
"properties": {
"Name": {
"minLength": 1,
"type": "string",
"description": "Name of the review cycle"
},
"ReviewCycleType": {
"minLength": 1,
"type": "string",
"description": "Review Cycle Type (\"Simple Review\" or \"Office 365 Review\")"
},
"AgreementId": {
"minLength": 1,
"type": "string",
"description": "Agreement Id of an agreement for which the review needs to be initiated"
},
"PrimaryDocumentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Document Id of a document for which the review needs to be initiated"
},
"SupportingDocumentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Document Ids of supporting documents to be considered during the review",
"nullable": true
},
"AdditionalAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAttachment"
},
"description": "Additional Attachments",
"nullable": true
},
"EmailTemplateId": {
"type": "string",
"description": "Email Template Id",
"nullable": true
},
"EmailSubject": {
"minLength": 1,
"type": "string",
"description": "Email subject of the review email to be sent to reviewers"
},
"EmailBody": {
"minLength": 1,
"type": "string",
"description": "Email Body of the review email to be sent to reviewers"
},
"To": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewerInfo"
},
"description": "List of reviewers' information"
},
"Cc": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewerInfo"
},
"description": "Carbon Copy",
"nullable": true
},
"Bcc": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewerInfo"
},
"description": "Blind Carbon Copy",
"nullable": true
}
},
"additionalProperties": false
},
"ReviewerInfo": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Reviewer Name",
"nullable": true
},
"EmailId": {
"type": "string",
"description": "Reviewer Email",
"nullable": true
},
"ADMemberId": {
"type": "string",
"description": "Active directory member Id if a reviewer has active directory access",
"nullable": true
},
"RecipientType": {
"type": "string",
"description": "Recipient type (\"Email\", \"User\", or \"Contact\")\r\nEmail - Reviewer is an external user or has active directory access \r\nUser - Reviewer is an internal user\r\nContact - Reviewer is an external user but is in contacts",
"nullable": true
},
"RecipientId": {
"type": "string",
"description": "Recipient Id\r\nWhen Recipient Type is User, then Id in the User Object.\r\nWhen Recipient Type is Contact, then Id in the Contact Object.\r\nWhen Recipient Type is Email, leave it empty/blank/null.",
"nullable": true
}
},
"additionalProperties": false
},
"ReviewerResponse": {
"type": "object",
"properties": {
"ReviewerId": {
"type": "string",
"description": "Reviewer Id",
"nullable": true
},
"Name": {
"type": "string",
"description": "Reviewer Name",
"nullable": true
},
"EmailId": {
"type": "string",
"description": "Email Id",
"nullable": true
},
"ReviewStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ReviewersAddRequest": {
"type": "object",
"properties": {
"Reviewers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewerInfo"
},
"description": "List of Reviewers",
"nullable": true
}
},
"additionalProperties": false
},
"ReviewersUpdateRequest": {
"type": "object",
"properties": {
"ReviewerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Reviewer Ids",
"nullable": true
}
},
"additionalProperties": false
},
"SortDirection": {
"enum": [
"Ascending",
"Descending"
],
"type": "string"
},
"SortInfo": {
"type": "object",
"properties": {
"FieldName": {
"type": "string",
"nullable": true
},
"Direction": {
"$ref": "#/components/schemas/SortDirection"
}
},
"additionalProperties": false
},
"StringAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "string",
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"StringObjectDictionaryAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"StringObjectDictionaryListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"StringObjectDictionaryQueryResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
},
"nullable": true
}
},
"additionalProperties": false
},
"StringObjectDictionaryQueryResponseAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"$ref": "#/components/schemas/StringObjectDictionaryQueryResponse"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"StringResultStatusDictionaryAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"Data": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ResultStatus"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}