{ "x-generator": "NSwag v13.15.5.0 (NJsonSchema v10.6.6.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "", "version": "1.0.0" }, "servers": [ { "url": "https://coreapps-rlsstg.congacloud.io/api/ingress" } ], "paths": { "/v1/Merge": { "post": { "tags": [ "Merge" ], "summary": "Initiate the merge workflow", "description": "Translates your merge request into data sets and then initiates the merge. For more information, see [Conga Composer API Use Cases.](https://documentation.conga.com/composer/latest/conga-composer-api-use-cases-203496246.html)", "operationId": "Merge_Post", "requestBody": { "x-name": "composerMergeRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposerMergeRequest" } } }, "required": true, "x-position": 1 }, "responses": { "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposerMergeResponseModel" } } } } }, "security": [ { "JWT": [] } ] } } }, "components": { "schemas": { "ProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "extensions": { "type": "object", "additionalProperties": {} } } }, "HttpResponse": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "bodyWriter": { "$ref": "#/components/schemas/PipeWriter" } } }, "PipeWriter": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "canGetUnflushedBytes": { "type": "boolean" }, "unflushedBytes": { "type": "integer", "format": "int64" } } }, "FileRetrievalRequest": { "type": "object", "description": "FileRetrievalRequest.", "additionalProperties": false, "properties": { "fileId": { "type": "string", "description": "File Id" }, "includeMetadata": { "type": "boolean", "description": "Include Metadata" }, "orgId": { "type": "string", "description": "Org Id" } } }, "ComposerMergeResponseModel": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "status": { "type": "string" }, "result": { "$ref": "#/components/schemas/Result" } } }, "Result": { "type": "object", "additionalProperties": false, "properties": { "statusCode": { "$ref": "#/components/schemas/StatusCodes" }, "statusMessage": { "type": "array", "items": { "$ref": "#/components/schemas/StatusMessage" } } } }, "StatusCodes": { "type": "string", "description": "", "x-enumNames": [ "Success", "InternalHostError", "NotFound", "BusinessRuleViolation", "FailedValidation", "SecurityException", "InvalidRequestdata", "ServiceUnavailable" ], "enum": [ "Success", "InternalHostError", "NotFound", "BusinessRuleViolation", "FailedValidation", "SecurityException", "InvalidRequestdata", "ServiceUnavailable" ] }, "StatusMessage": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "ComposerMergeRequest": { "type": "object", "additionalProperties": false, "properties": { "salesforceRequest": { "$ref": "#/components/schemas/SalesforceRequest" }, "activity": { "$ref": "#/components/schemas/Activity" }, "adaptation": { "$ref": "#/components/schemas/Adaptation" }, "signCommands": { "$ref": "#/components/schemas/SignCommands" }, "saveCopy": { "$ref": "#/components/schemas/SaveCopy" }, "legacyOptions": { "type": "object", "description": "Control the behavior of document generation by including parameter name and value. For more information on supported parameters for API, click [here](https://documentation.conga.com/composer/latest/supported-parameters-for-composer-api-195691044.html).", "additionalProperties": { "type": "string" } }, "templateSources": { "type": "array", "description": "Template source details to get the template from your cloud storage provider.", "items": { "$ref": "#/components/schemas/TemplateSourceRequest" } }, "jsonData": { "type": "string", "description": "JSON payload. For more information on JSON payload use case, click [here](https://documentation.conga.com/composer/latest/generate-document-using-json-data-203491745.html)" }, "destinations": { "type": "array", "description": "Destination details to send the generated document to your cloud storage provider.", "items": { "$ref": "#/components/schemas/DestinationRequest" } }, "output": { "$ref": "#/components/schemas/OutputRequest" } } }, "SalesforceRequest": { "type": "object", "additionalProperties": false, "properties": { "sessionId": { "type": "string", "description": "Salesforce access token." }, "templateId": { "type": "string", "description": "Salesforce template ID." }, "masterId": { "type": "string", "description": "Salesforce master object record ID." }, "queryId": { "type": "string", "description": "Salesforce query ID." }, "emailTemplateId": { "type": "string", "description": "Salesforce email template ID." }, "instanceUrl": { "type": "string", "description": "Salesforce instance URL. You can get this while retiriving Salesforce access token." }, "serverUrl": { "type": "string", "description": "Salesforce server URL. For example: *{{instanceUrl}}/services/Soap/50.0/{{Salesforce org ID}}*." }, "targetOrigin": { "type": "string" }, "relatedContactId": { "type": "string" } } }, "Activity": { "type": "object", "additionalProperties": false, "properties": { "attachOperation": { "type": "string" }, "enabled": { "type": "boolean" }, "followUpDate": { "type": "string", "format": "date-time" }, "saveText": { "type": "string" }, "subject": { "type": "string" } } }, "Adaptation": { "type": "object", "additionalProperties": false, "properties": { "pdfCommands": { "type": "boolean" }, "convertToPDF": { "type": "boolean" } } }, "SignCommands": { "type": "object", "additionalProperties": false, "properties": { "provider": { "type": "string" }, "payload": { "type": "string" } } }, "SaveCopy": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "nullable": true }, "saveTo": { "type": "string" } } }, "TemplateSourceRequest": { "type": "object", "additionalProperties": false, "properties": { "integrationName": { "type": "string" }, "fileId": { "type": "string" } } }, "DestinationRequest": { "type": "object", "additionalProperties": false, "properties": { "integrationName": { "type": "string", "description": "gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce." }, "folderId": { "type": "string", "description": "Folder ID that correspond to the cloud service provider's actual folder ID. For more information on how to get the folder ID, click [here](https://documentation.conga.com/composer/latest/how-to-get-file-id-for-composer-api-request-193698978.html)" }, "options": { "$ref": "#/components/schemas/DestinationOptionsRequest" } } }, "DestinationOptionsRequest": { "type": "object", "additionalProperties": false, "properties": { "generateLink": { "type": "boolean", "nullable": true }, "notificationEmailTemplateId": { "type": "string" }, "salesforceContentWorkspaceId": { "type": "string" } } }, "OutputRequest": { "type": "object", "additionalProperties": false, "properties": { "generateDocumentDownload": { "type": "boolean", "description": "Set this to **true** to enable document download for the merged document." } } }, "InitiateMultiPartResponse": { "type": "object", "description": "Defines the response from a MultiPart file upload initiation.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "key": { "type": "string", "description": "Key." }, "dataObjectInitiateMultiPartResponse": { "description": "Data Object Initiate Multi Part Response.", "oneOf": [ { "$ref": "#/components/schemas/DataObjectInitiateMultiPartResponse" } ] } } }, "DataObjectInitiateMultiPartResponse": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "uploadId": { "type": "string", "nullable": true }, "uri": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } } }, "UploadPartResponse": { "type": "object", "description": "Defines the response object for a single part of a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "dataObjectUploadMultiPartResponse": { "description": "Data Object Upload Multi Part Response", "oneOf": [ { "$ref": "#/components/schemas/DataObjectUploadMultiPartResponse" } ] } } }, "DataObjectUploadMultiPartResponse": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "part": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Part" } ] }, "message": { "type": "string", "nullable": true } } }, "Part": { "type": "object", "additionalProperties": false, "properties": { "partNumber": { "type": "integer", "format": "int32" }, "tag": { "type": "string", "nullable": true } } }, "CompleteMultiPartResponse": { "type": "object", "description": "Defines the response object for completing a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "dataObjectCompleteMultiPartResponse": { "description": "Data Object Upload Multi Part Response", "oneOf": [ { "$ref": "#/components/schemas/DataObjectCompleteMultiPartResponse" } ] } } }, "DataObjectCompleteMultiPartResponse": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "uri": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "sharedUri": { "type": "string", "nullable": true } } }, "CompleteMultiFileRequest": { "type": "object", "description": "Defines the request object for completing a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "uploadInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/UploadInfo" } } } }, "UploadInfo": { "type": "object", "description": "UploadInfo", "additionalProperties": false, "properties": { "filename": { "type": "string" }, "key": { "type": "string" }, "uploadId": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/Part2" } }, "label": { "type": "string", "nullable": true } } }, "Part2": { "type": "object", "description": "Part.", "additionalProperties": false, "properties": { "partNumber": { "type": "integer", "description": "PartNumber", "format": "int32" }, "tag": { "type": "string", "description": "Tag." } } }, "AbortMultiFileRequest": { "type": "object", "description": "Defines the request object for abort a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "abortFileInfoList": { "type": "array", "description": "List of Filename/Key/UploadId info", "items": { "$ref": "#/components/schemas/AbortFileInfo" } } } }, "AbortFileInfo": { "type": "object", "description": "AbortFileInfo.", "additionalProperties": false, "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" } } }, "CompleteMultiPartRequest": { "type": "object", "description": "Defines the request object for completing a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "batchId": { "type": "string", "description": "Final filename for file" }, "key": { "type": "string", "description": "The location in the underlying storing mechanism where the file will be stored." }, "uploadId": { "type": "string", "description": "Identifies an upload." }, "parts": { "type": "array", "description": "A list of ETags ordered by each part.", "items": { "$ref": "#/components/schemas/Part2" } } } }, "AbortMultiPartRequest": { "type": "object", "description": "Defines the request object for abort a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "batchId": { "type": "string", "description": "Storage Prefix" }, "key": { "type": "string", "description": "The location in the underlying storing mechanism where the file will be stored." }, "uploadId": { "type": "string", "description": "Identifies an upload." } } }, "GrabModel": { "type": "object", "additionalProperties": false, "properties": { "congaOrgId": { "type": "string", "description": "Organizational identifier that is found when you deserialize your JWT token." }, "externalLoginGuid": { "type": "string", "description": "Added in support for document delivery 2. It is not required if you are using the Conga token." }, "serviceName": { "type": "string", "description": "gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce." }, "fileIds": { "type": "array", "description": "An array of file IDs that correspond to the cloud service provider's actual file IDs. For more information on how to get the file ID, click [here](https://documentation.conga.com/composer/latest/how-to-get-file-id-for-composer-api-request-193698978.html)", "items": { "type": "string" } } } }, "DocGenResponseModel": { "type": "object", "description": "DocGenResponseModel", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "CorrelationId" }, "status": { "type": "string", "description": "Status" }, "result": { "description": "Result", "oneOf": [ { "$ref": "#/components/schemas/Result" } ] } } }, "DocumentWorkflowRequest": { "type": "object", "additionalProperties": false, "properties": { "dataSource": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DataSource" } }, "templateSource": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/TemplateSource" } }, "documentSource": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DocumentSource" } }, "destination": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DocumentDestination" } }, "outputFormat": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentOutputOptions" } ] }, "hasSource": { "type": "boolean" }, "hasData": { "type": "boolean" }, "hasTemplate": { "type": "boolean" }, "hasDocument": { "type": "boolean" }, "isMergeAction": { "type": "boolean" }, "hasMultipleSources": { "type": "boolean" }, "documentActionType": { "type": "string", "nullable": true } } }, "DataSource": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false } ] }, "BaseRequestMetaData": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "type": { "type": "string", "nullable": true }, "details": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } } } }, "TemplateSource": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false } ] }, "DocumentSource": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false } ] }, "DocumentDestination": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false, "properties": { "uris": { "type": "array", "nullable": true, "items": { "type": "string" } } } } ] }, "DocumentOutputOptions": { "type": "object", "additionalProperties": false, "properties": { "fileName": { "type": "string", "nullable": true }, "convertToPdf": { "type": "boolean" }, "customDocumentId": { "type": "string", "nullable": true }, "documentPassword": { "type": "string", "nullable": true }, "pdfProtection": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PdfProtectionOptions" } ] }, "wordProtection": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WordProtectionOptions" } ] }, "joinDocumentOptions": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JoinDocumentOptions" } ] }, "watermarkText": { "type": "string", "nullable": true }, "removeWatermark": { "type": "boolean" }, "headerFooter": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/HeaderFooterOptions" } ] }, "customDocumentMetadata": { "type": "object", "nullable": true, "additionalProperties": {} }, "pdfOutputCompliance": { "type": "integer", "format": "int32" } } }, "PdfProtectionOptions": { "type": "object", "additionalProperties": false, "properties": { "allowPrinting": { "type": "boolean" }, "allowCopying": { "type": "boolean" }, "allowCommenting": { "type": "boolean" }, "allowFormFilling": { "type": "boolean" }, "allowAssembling": { "type": "boolean" }, "allowChangingContent": { "type": "boolean" } } }, "WordProtectionOptions": { "type": "object", "additionalProperties": false, "properties": { "protectionLevel": { "type": "integer" }, "protectionLevelPassword": { "type": "string", "nullable": true } } }, "JoinDocumentOptions": { "type": "object", "additionalProperties": false, "properties": { "retainSectionBreak": { "type": "boolean" } } }, "HeaderFooterOptions": { "type": "object", "additionalProperties": false, "properties": { "headerStyle": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/HeaderFooterStyle" } ] }, "footerStyle": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/HeaderFooterStyle" } ] }, "headerText": { "type": "string", "nullable": true }, "footerText": { "type": "string", "nullable": true }, "isOverWrite": { "type": "boolean" }, "retainHeaderFooter": { "type": "boolean" } } }, "HeaderFooterStyle": { "type": "object", "additionalProperties": false, "properties": { "fontFamily": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true }, "isBold": { "type": "boolean" }, "isItalic": { "type": "boolean" }, "fontSize": { "type": "number", "format": "double" }, "textAlignment": { "type": "string", "nullable": true } } } }, "securitySchemes": { "JWT": { "type": "apiKey", "description": "Provide oauth authentication", "name": "Authorization", "in": "header" } } }, "security": [ { "JWT": [] } ], "tags": [ { "name": "Merge", "description": "Initiate merge workflow" }, ] }