{ "x-generator": "NSwag v13.15.0.0 (NJsonSchema v10.6.2.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "", "description": "This service downloads the merged documents as part of the Composer flow.", "version": "1.0.0" }, "servers": [ { "url": "https://coreapps-rlsstg.congacloud.io/api/presigned" } ], "paths": { "/v1/PreSignedService/{lookupId}": { "get": { "tags": [ "PreSigned Service" ], "summary": "Download a single file", "description": "Downloads the file indicated by the correlationId(s)", "operationId": "PreSignedService_GetBatchInfo", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "description": "The correlationId for the merge document.", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "200": { "description": "Successful operation", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "JWT": [] } ] } }, "/v1/PreSignedService/{lookupId1}/{lookupId2}": { "get": { "tags": [ "PreSigned Service" ], "summary": "Download multiple files", "description": "Downloads files by passing the correlationIds of the merged documents.", "operationId": "PreSignedService_GetFile", "parameters": [ { "name": "lookupId1", "in": "path", "required": true, "description": "The correlationIds for the merge documents", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "lookupId2", "in": "path", "required": true, "description": "The correlationIds for the merge documents", "schema": { "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "200": { "description": "Successful operation", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "JWT": [] } ] } }, "/v1/PreSignedService/{lookupId1}/{lookupId2}/{fileName}": { "get": { "tags": [ "PreSigned Service" ], "summary": "Download a file with the custom filename", "description": "Downloads the file and gives a custom file name by passing the correlationIds and the file name.\n\n**For example**, if you generate a PDF document with Composer merge flow and run this API with the fileName parameter set to **Final Proposal.pdf**, the file will be downloaded as **Final Proposal.pdf** to the user's machine.", "operationId": "PreSignedService_GetFileWithCustomFileName", "parameters": [ { "name": "lookupId1", "in": "path", "required": true, "description": "The correlationIds for the merge documents", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "lookupId2", "in": "path", "required": true, "description": "The correlationIds for the merge documents", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "fileName", "in": "path", "required": true, "description": "File name", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "200": { "description": "Successful operation", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "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": {} } } }, "CreateResponseModel": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "preSignedCreateResponseModel": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PreSignedCreateResponseModel" } ] } } }, "PreSignedCreateResponseModel": { "type": "object", "description": "PreSignedCreateResponseModel", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Status Code" }, "fileInfoDetailsList": { "type": "array", "description": "Message", "nullable": true, "items": { "$ref": "#/components/schemas/FileInfoDetails" } } } }, "FileInfoDetails": { "type": "object", "additionalProperties": false, "properties": { "transactionId": { "type": "string" }, "url": { "type": "string" }, "fileName": { "type": "string", "nullable": true }, "tags": { "type": "object", "nullable": true, "additionalProperties": {} } } }, "CreatePayloadModel": { "type": "object", "additionalProperties": false, "properties": { "preSignedUrl": { "type": "string", "nullable": true }, "expirationSeconds": { "type": "integer", "format": "int32" }, "fileName": { "type": "string", "nullable": true }, "tags": { "type": "object", "nullable": true, "additionalProperties": {} } } }, "BatchGenerateExternalUrlRequestModel": { "type": "object", "additionalProperties": false, "properties": { "preSignedFileInfos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PreSignedFileInfo" } }, "expirationSeconds": { "type": "integer", "format": "int32" }, "tags": { "type": "object", "nullable": true, "additionalProperties": {} } } }, "PreSignedFileInfo": { "type": "object", "additionalProperties": false, "properties": { "preSignedUrl": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } } }, "DeleteResponseModel": { "type": "object", "additionalProperties": false, "properties": { "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } } }, "securitySchemes": { "JWT": { "type": "apiKey", "description": "Provide oauth authentication", "name": "Authorization", "in": "header" } } }, "security": [ { "JWT": [] } ], "tags": [ { "name": "PreSigned Service", "description": "Provide access to files" } ] }