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: schema: $ref: '#/components/schemas/Response' 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: schema: $ref: '#/components/schemas/Response' 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: schema: $ref: '#/components/schemas/Response' 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: schema: $ref: '#/components/schemas/Response' example: title: success status: 200 data: true deprecated: false components: schemas: activaterequest: title: Request(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: Request(publishtodocumentrepository) required: - FileIdToPublish type: object properties: FileIdToPublish: type: string example: FileIdToPublish: 06911000001jBE9AAM publishtochatterrepositoryrequest: title: Request(publishtochatterrepository) required: - FileIdToPublish type: object properties: FileIdToPublish: type: string example: FileIdToPublish: 06911000001jBEDAA2 sendForReviewRequest: title: Request(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 Response: title: Response required: - title - status - data type: object properties: title: type: string status: type: integer format: int32 data: type: boolean example: title: success status: 200 data: true securitySchemes: oauth2: type: oauth2 flows: implicit: authorizationUrl: 'http://example.com/auth' scopes: {} security: - oauth2: [] tags: - name: Agreement Rest API Services description: ''