{ "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://services.congamerge.com/api/v1/ingress" } ], "paths": { "/Merge": { "post": { "tags": [ "Merge" ], "summary": "Initiate the merge workflow", "description": "Translates the users' merge request inputs into data sets and initiate 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": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposerMergeResponseModel" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/multipart/MultiFile/initiate": { "post": { "tags": [ "MultiFile" ], "summary": "Initiate the multifile upload", "description": "This is the preferred method of transferring a multiple files to the underlying storage mechanism. It initiates the multifile upload.", "operationId": "MultiFile_initiateMultiFile", "parameters": [ { "name": "fileCount", "in": "query", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Details of multi part upload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateMultiPartResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "" } }, "security": [ { "JWT": [] } ] } }, "/multipart/MultiFile/{correlationId}/{transactionId}/{key}/{uploadId}/{partNumber}/{batchId}": { "put": { "tags": [ "MultiFile" ], "summary": "Upload a single file to the file repository", "description": "This is the second step in the process of transferring multiple files to the underlying storage mechanism. It uploads a single file based on the input. Except for the final part, all parts should be at least 5 MB in size.", "operationId": "MultiFile_UploadPart", "parameters": [ { "name": "correlationId", "in": "path", "required": true, "description": "It is defined in the multifile initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "transactionId", "in": "path", "required": true, "description": "It is defined in the multifile initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "key", "in": "path", "required": true, "description": "The key that identifies the file location in the underlying storage mechanism. It is defined in the multifile initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "uploadId", "in": "path", "required": true, "description": "It is defined in the multifile initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "partNumber", "in": "path", "required": true, "description": "A part number uniquely identifies a part and its position in the object you are uploading.", "schema": { "type": "integer", "format": "int32" }, "x-position": 5 }, { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true }, "x-position": 6 } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPartResponse" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/multipart/MultiFile/complete": { "post": { "tags": [ "MultiFile" ], "summary": "Complete the multifile upload", "description": "This is the final step in the process of transferring multiple files to the underlying storage mechanism. It completes the multifile upload request.", "operationId": "MultiFile_CompleteMultiFile", "requestBody": { "x-name": "request", "description": "It should include the following information: correlationId, transactionId, upload informations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteMultiFileRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteMultiPartResponse" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/multipart/MultiFile/abort": { "post": { "tags": [ "MultiFile" ], "summary": "Abort an ongoing multifile upload", "description": "This is the preferred method to abort an ongoing multifile upload.", "operationId": "MultiFile_AbortMultiFile", "requestBody": { "x-name": "request", "description": "It should include the following information: correlationId, transactionId, and a list of <key, uploadId>.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbortMultiFileRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Is successful.", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "" } }, "security": [ { "JWT": [] } ] } }, "/MultiPart/initiate": { "post": { "tags": [ "MultiPart" ], "summary": "Initiate the multipart upload", "description": "This is the first step in the process of transferring a large file to the underlying storage mechanism. It initiates the multipart (large file in multiple parts) upload.", "operationId": "MultiPart_InitiateMultiPart", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateMultiPartResponse" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/MultiPart/{correlationId}/{transactionId}/{key}/{uploadId}/{partNumber}": { "put": { "tags": [ "MultiPart" ], "summary": "Upload a single part of a file to the file repository", "description": "This is the second step in the process of transferring a large file to the underlying storage mechanism. It uploads a single part of a file. Except for the final part, all parts should be at least 5 MB in size", "operationId": "MultiPart_UploadPart", "parameters": [ { "name": "correlationId", "in": "path", "required": true, "description": "It is defined in the multipart initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "transactionId", "in": "path", "required": true, "description": "It is defined in the multipart initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "key", "in": "path", "required": true, "description": "The key that identifies the file location in the underlying storage mechanism. It is defined in the multipart initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "uploadId", "in": "path", "required": true, "description": "It is defined in the multipart initiate response.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "partNumber", "in": "path", "required": true, "description": "A part number uniquely identifies a part and its position in the object you are uploading.", "schema": { "type": "integer", "format": "int32" }, "x-position": 5 } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPartResponse" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/MultiPart/complete": { "post": { "tags": [ "MultiPart" ], "summary": "Complete the multipart upload", "description": "This is the final step in the process of transferring a large file to the underlying storage mechanism. It completes the multipart upload request", "operationId": "MultiPart_CompleteMultiPart", "requestBody": { "x-name": "request", "description": "It should include the following information: correlationId, transactionId, key, uploadId, and parts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteMultiPartRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteMultiPartResponse" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/MultiPart/abort": { "post": { "tags": [ "MultiPart" ], "summary": "Abort an ongoing multipart upload", "description": "This is the preferred method to abort an ongoing multipart upload.", "operationId": "MultiPart_AbortMultiPart", "requestBody": { "x-name": "request", "description": "It should include the following information: correlationId, transactionId, key, and uploadId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbortMultiPartRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } }, "/Grab/v1/file/contents": { "post": { "tags": [ "Grab" ], "summary": "Grab a list of templates or files", "description": "Grabs a list of templates or files from the specified cloud service provider. For more information, see [Conga Composer API Use Case.](https://documentation.conga.com/composer/latest/generate-document-using-json-data-203491745.html)", "operationId": "Grab_GetFiles", "requestBody": { "x-name": "grabFileListModel", "description": "**CongaOrgId**: Organizational Identifier that is found when you deserialize your JWT token,\n**Service Name**: gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce,\n**FileIds**: An array of file IDs that correspond to the cloud service provider's actual file IDs. _Note: It can currently only be called with a single FileId._,\n**External login Guid**: It is not required if you are using the Conga token.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrabModel" } } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Returned list of templates or files", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "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", "nullable": true, "additionalProperties": {} } } }, "HttpResponse": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "bodyWriter": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PipeWriter" } ] } } }, "PipeWriter": { "type": "object", "x-abstract": true, "additionalProperties": false }, "ComposerMergeResponseModel": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "result": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Result" } ] } } }, "Result": { "type": "object", "additionalProperties": false, "properties": { "statusCode": { "$ref": "#/components/schemas/StatusCodes" }, "statusMessage": { "type": "array", "nullable": true, "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", "nullable": true }, "description": { "type": "string", "nullable": true } } }, "ComposerMergeRequest": { "type": "object", "additionalProperties": false, "properties": { "salesforceRequest": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SalesforceRequest" } ] }, "activity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Activity" } ] }, "adaptation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Adaptation" } ] }, "signCommands": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SignCommands" } ] }, "saveCopy": { "nullable": true, "oneOf": [ { "$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)", "nullable": true, "additionalProperties": { "type": "string" } }, "templateSources": { "type": "array", "description": "Template source details to grab the template from your cloud storage provider.", "nullable": true, "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)", "nullable": true }, "destinations": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DestinationRequest" } }, "output": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OutputRequest" } ] } } }, "SalesforceRequest": { "type": "object", "additionalProperties": false, "properties": { "sessionId": { "type": "string", "description": "Salesforce access token", "nullable": true }, "templateId": { "type": "string", "description": "Salesforce template ID", "nullable": true }, "masterId": { "type": "string", "description": "Salesforce master object record ID", "nullable": true }, "queryId": { "type": "string", "description": "Salesforce query ID", "nullable": true }, "emailTemplateId": { "type": "string", "description": "Salesforce email template ID", "nullable": true }, "instanceUrl": { "type": "string", "description": "Salesforce instance URL. You can get this while retiriving Salesforce access token.", "nullable": true }, "serverUrl": { "type": "string", "description": "Salesforce server URL. For example: *{{instanceUrl}}/services/Soap/50.0/{{Salesforce org ID}}*", "nullable": true }, "targetOrigin": { "type": "string", "nullable": true }, "relatedContactId": { "type": "string", "nullable": true } } }, "Activity": { "type": "object", "additionalProperties": false, "properties": { "attachOperation": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "followUpDate": { "type": "string", "format": "date-time" }, "saveText": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true } } }, "Adaptation": { "type": "object", "additionalProperties": false, "properties": { "pdfCommands": { "type": "boolean" }, "convertToPDF": { "type": "boolean" } } }, "SignCommands": { "type": "object", "additionalProperties": false, "properties": { "provider": { "type": "string", "nullable": true }, "sendTo": { "type": "string", "nullable": true }, "signOrder": { "type": "string", "nullable": true } } }, "SaveCopy": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "nullable": true }, "saveTo": { "type": "string", "nullable": true } } }, "TemplateSourceRequest": { "type": "object", "additionalProperties": false, "properties": { "integrationName": { "type": "string", "description": "gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce.", "example": "sharepoint", "nullable": true }, "fileId": { "type": "string", "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)", "nullable": true } } }, "DestinationRequest": { "type": "object", "description": "Destination details to send the generated document to your cloud storage provider.", "additionalProperties": false, "properties": { "integrationName": { "type": "string", "description": "gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce.", "example": "sharepoint", "nullable": true }, "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)", "nullable": true }, "options": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DestinationOptionsRequest" } ] } } }, "DestinationOptionsRequest": { "type": "object", "additionalProperties": false, "properties": { "generateLink": { "type": "boolean", "nullable": true }, "notificationEmailTemplateId": { "type": "string", "nullable": true }, "salesforceContentWorkspaceId": { "type": "string", "nullable": true } } }, "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", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "key": { "type": "string" }, "dataObjectInitiateMultiPartResponse": { "$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", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "dataObjectUploadMultiPartResponse": { "$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", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "dataObjectCompleteMultiPartResponse": { "$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 } } }, "CompleteMultiFileRequest": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "uploadInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/UploadInfo" } } } }, "UploadInfo": { "type": "object", "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", "additionalProperties": false, "properties": { "partNumber": { "type": "integer", "format": "int32" }, "tag": { "type": "string" } } }, "AbortMultiFileRequest": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "abortFileInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/AbortFileInfo" } } } }, "AbortFileInfo": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" } } }, "CompleteMultiPartRequest": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "batchId": { "type": "string" }, "key": { "type": "string" }, "uploadId": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/Part2" } } } }, "AbortMultiPartRequest": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "transactionId": { "type": "string" }, "batchId": { "type": "string" }, "key": { "type": "string" }, "uploadId": { "type": "string" } } }, "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": "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) \n\n_Note: It can currently only be called with a single File ID._", "items": { "type": "string" } } } } }, "securitySchemes": { "JWT": { "type": "http", "description": "Enter a bearer token as your authorization. In your requests, the headers will be set as the following <br><code>Authorization: Bearer YourTokenValue</code>", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "JWT": [] } ], "tags": [ { "name": "Merge", "description": "Initiate merge workflow" }, { "name": "MultiFile", "description": "Upload multiple large files" }, { "name": "MultiPart", "description": "Transfer a large file to the underlying storage mechanism" }, { "name": "Grab", "description": "Grab templates or files" } ] }