PDF
Download PDF
Download page Agreement REST API Services Version 1.
Agreement REST API Services Version 1
openapi: 3.0.0
info:
title: Agreement Rest API Services
contact: {}
version: '1.0'
paths:
/agreements/:agreementId/activate:
post:
tags:
- Agreement Rest API Services
summary: activate
description: This API will activate the Agreement.
operationId: activate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/activaterequest'
example:
SelectedDocumentIds:
- 06911000001jBE9AAM
- 06911000001jBEDAA2
RemovableDocumentIds:
- 06911000001jBEIAA2
required: true
responses:
'200':
description: 'OK'
content:
application/json:
example:
title: success
status: 200
data: true
deprecated: false
/agreements/:agreementId/publishtodocumentrepository:
post:
tags:
- Agreement Rest API Services
summary: publishtodocumentrepository
description: This API will publish a document to document repository.
operationId: publishtodocumentrepository
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/publishtodocumentrepositoryrequest'
example:
FileIdToPublish: 06911000001jBE9AAM
required: true
responses:
'200':
description: 'OK'
content:
application/json:
example:
title: success
status: 200
data: true
deprecated: false
/agreements/:agreementId/publishtochatterrepository:
post:
tags:
- Agreement Rest API Services
summary: publishtochatterrepository
description: This API will publish a document to chatter repository.
operationId: publishtochatterrepository
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/publishtochatterrepositoryrequest'
example:
FileIdToPublish: 06911000001jBEDAA2
required: true
responses:
'200':
description: 'OK'
content:
application/json:
example:
title: success
status: 200
data: true
deprecated: false
/agreements/:agreementId/sendForReview:
post:
tags:
- Agreement Rest API Services
summary: sendForReview
description: This API will send document for review
operationId: sendForReview
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/sendForReviewRequest'
example:
EmailTemplateId: 00X11000002NRSuEAO
EmailTo:
- prabkumar@conga.com
EmailCc:
- ansharma@conga.com
EmailBcc:
- test@gmail.com
FileIds:
- 06911000001jBKBAA2
Protect: false
ProtectionLevel: Full Access
required: true
responses:
'200':
description: 'OK'
content:
application/json:
example:
title: success
status: 200
data: true
deprecated: false
/agreements/:agreementId/finalizeClausesForSendForSignature:
post:
tags:
- Agreement Rest API Services
summary: finalizeClausesForSendForSignature
description: >-
API to mark the clauses as final for the agreement.
It takes DocumentVersionIds as an optional parameter (list of ids).
If this parameter is passed as null, then it will mark clauses as final
for all the documents whose version details have flag
IsSentForManualSignature__c set to true.
If this parameter is passed, then only the respective document version’s
clauses will be marked as final.
operationId: finalizeClausesForSendForSignature
parameters: []
requestBody:
description: >-
It takes DocumentVersionIds as an optional parameter (list of ids). If
this parameter is passed as null, then it will mark clauses as final
for all the documents whose version details have flag
IsSentForManualSignature__c set to true. If this parameter is passed,
then only the respective document version’s clauses will be marked as
final.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/finalizeClausesForSendForSignatureRequest'
description: >-
It takes DocumentVersionIds as an optional parameter (list of
ids). If this parameter is passed as null, then it will mark
clauses as final for all the documents whose version details
have flag IsSentForManualSignature__c set to true. If this
parameter is passed, then only the respective document version’s
clauses will be marked as final.
required: false
responses:
'200':
description: 'Clauses for the agreement are marked as final'
headers: {}
deprecated: false
components:
schemas:
activaterequest:
title: activate
required:
- SelectedDocumentIds
- RemovableDocumentIds
type: object
properties:
SelectedDocumentIds:
type: array
items:
type: string
description: ''
RemovableDocumentIds:
type: array
items:
type: string
description: ''
example:
SelectedDocumentIds:
- 06911000001jBE9AAM
- 06911000001jBEDAA2
RemovableDocumentIds:
- 06911000001jBEIAA2
publishtodocumentrepositoryrequest:
title: publishtodocumentrepository
required:
- FileIdToPublish
type: object
properties:
FileIdToPublish:
type: string
example:
FileIdToPublish: 06911000001jBE9AAM
publishtochatterrepositoryrequest:
title: publishtochatterrepository
required:
- FileIdToPublish
type: object
properties:
FileIdToPublish:
type: string
example:
FileIdToPublish: 06911000001jBEDAA2
sendForReviewRequest:
title: sendForReview
required:
- EmailTemplateId
- EmailTo
- EmailCc
- EmailBcc
- FileIds
- Protect
- ProtectionLevel
type: object
properties:
EmailTemplateId:
type: string
EmailTo:
type: array
items:
type: string
description: ''
EmailCc:
type: array
items:
type: string
description: ''
EmailBcc:
type: array
items:
type: string
description: ''
FileIds:
type: array
items:
type: string
description: ''
Protect:
type: boolean
ProtectionLevel:
type: string
example:
EmailTemplateId: 00X11000002NRSuEAO
EmailTo:
- prabkumar@conga.com
EmailCc:
- ansharma@conga.com
EmailBcc:
- test@gmail.com
FileIds:
- 06911000001jBKBAA2
Protect: false
ProtectionLevel: Full Access
finalizeClausesForSendForSignature:
title: finalizeClausesForSendForSignature
required:
- DocumentVersionIds
type: object
properties:
DocumentVersionIds:
type: array
items:
type: string
description: ''
example:
DocumentVersionIds:
- a0f3h000001gMao
securitySchemes:
oauth2:
type: oauth2
flows:
implicit:
authorizationUrl: 'http://example.com/auth'
scopes: {}
security:
- oauth2: []
tags:
- name: Agreement Rest API Services
description: ''