{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi/docmanager-reference/v1/","result":{"data":{"contentItem":{"type":"redoc-info","link":"/openapi/docmanager-reference/v1/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"API REST – Document Manager\",\"description\":\"The REST Document Manager API is a web service that allows the administration, indexing, consultation, compression and download of document files associated with a record of a contact list and also makes it possible to later activate a conversation flow in DANAConnect using said data. \\n### The Document Manager API is used for: \\n- Consult documents stored in the repository using filters and file types, previously configured from the Document Manager interface on the DANAConnect platform. \\n- Integration with shipments from the DANAConnect platform by activating a conversation. \\n- Get historical download logs. \\n- Perform compression of a folder in the Document Storage, or several folders or several files. \\n- Get Short URLs or Long URLs to be able to download documents safely.\\n\\n# Considerations prior to using the API \\n- The company that is going to use the API must have a valid `username` and `password` in the DANAConnect platform.\\n- For security reasons, the user who is going to use the API must have a special permission. Your DANAConnect Account Manager must ensure that this permission is enabled.\\n- This API works on Conversations (flows) that have previously been created and are active in the platform. This means that you must have the Conversation ID (conversationID) for this flow. \\nWhat is the Conversation identification number (`conversationID`)? \\nThe conversation identification number in DANAConnect can be found on the activation reports page for each flow inside the Conversation Manager. It is important to mention that every time a conversation is reactivated, a new Conversation ID will be generated. \\n- You must have previously configured the file types for indexing and filtering the search criteria of your documents in the Document Manager of the DANAConnect platform.- You must have an account with an active Document Storage document repository on DANAConnect.\\n# How to find the Conversation ID \\nFor most DANAConnect API requests, you will need to send the Conversation ID as a parameter.\\nThis conversation ID refers to the number assigned to the activation of the flow and can be found by logging into the DANAConnect platform and looking in the activation report for the conversation you need to refer to.\\\\\\nIt is important to mention that every time a conversation is reactivated, a new Conversation ID will be generated.\\\\\\nHere is a video explaining how to find the conversation ID:\",\"contact\":{\"name\":\"DANAConnect\",\"url\":\"https://www.danaconnect.com\",\"email\":\"support@dannaconnect.com\"},\"license\":{\"name\":\"Apache 2.0\",\"url\":\"http://www.apache.org/licenses/LICENSE-2.0\"},\"version\":\"1.0\"},\"servers\":[{\"url\":\"https://api.danaconnect.com/document/1.0\",\"description\":\"Production\",\"variables\":{}},{\"url\":\"https://api.danaconnect-qa.com/document/1.0\",\"description\":\"QA\",\"variables\":{}}],\"tags\":[{\"name\":\"Document Sign\",\"description\":\"Operations involved in signing documents\"},{\"name\":\"Document Download\",\"description\":\"Operations involved in document downloads\"},{\"name\":\"Document IA\",\"description\":\"Operations Involved in AI and OCR Document Processing\"}],\"paths\":{\"/searchText\":{\"post\":{\"tags\":[\"Document IA\"],\"summary\":\"Search Text in PDF/Images\",\"description\":\"This service allows searching text in PDF/Images and perform specific counts and extractions.\",\"operationId\":\"searchText\",\"requestBody\":{\"description\":\"JSON with the data required to search for text within documents\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RequestSearchTextDTO\"},\"examples\":{\"Search for text in a single document\":{\"summary\":\"Search for 'example' in a single document\",\"description\":\"Search for text in a single document\",\"value\":{\"file_reference\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\",\"queries\":[{\"queryParameters\":{\"text_count\":\"example\"},\"keyResponse\":\"CODE_RESPONSE_CUSTOM_1\"}]}},\"Search for text in multiple documents\":{\"summary\":\"Search for 'term1' and 'dd/MM/yyyy' in multiple documents\",\"description\":\"Search for text in multiple documents\",\"value\":{\"file_reference\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\",\"queries\":[{\"queryParameters\":{\"text_count\":\"term1\"},\"keyResponse\":\"CODE_RESPONSE_CUSTOM_1\"},{\"queryParameters\":{\"min_date\":\"dd/MM/yyyy\"},\"keyResponse\":\"CODE_RESPONSE_CUSTOM_2\"}]}},\"Search for text with custom response keys\":{\"summary\":\"Search for 'keyword' and return the result under the 'custom_key' response\",\"description\":\"Search for text with custom response keys\",\"value\":{\"file_reference\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\",\"queries\":[{\"queryParameters\":{\"min_number\":\"\"},\"keyResponse\":\"CODE_RESPONSE_CUSTOM_3\"}]}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The request was processed successfully\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseSearchTextDTO\"},\"examples\":{\"Successful search\":{\"summary\":\"Successful search result\",\"description\":\"Successful search\",\"value\":{\"code_response\":\"00\",\"page_count\":1,\"results\":{\"CODE_RESPONSE_CUSTOM_1\":1,\"CODE_RESPONSE_CUSTOM_2\":1,\"CODE_RESPONSE_CUSTOM_3\":1,\"CODE_RESPONSE_CUSTOM_4\":\"18/02/1983\",\"CODE_RESPONSE_CUSTOM_51\":1}}}}}}},\"400\":{\"description\":\"Incorrect request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseSearchTextDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"code_response\":\"02\",\"description\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication error\"}},\"security\":[{\"basicAuth\":[]}]}},\"/getdocumentsign\":{\"post\":{\"tags\":[\"Document Sign\"],\"summary\":\"Request a signed PDF\",\"description\":\"This service provides a signed PDF\",\"operationId\":\"getdocumentsign\",\"requestBody\":{\"description\":\"JSON with the data required to sign a document\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RequestDocumentSignDTO\"},\"examples\":{\"Request with unexpected page type\":{\"summary\":\"Unexpected page type\",\"description\":\"Request with unexpected page type\",\"value\":{\"url\":\"s3://demos/ArchivoFactura1.pdf\",\"isQR\":true,\"idTypeHashAlignW\":2,\"idTypeHashAlignH\":3,\"idTypeQRAlignW\":1,\"idTypeQRAlignH\":3,\"idTypePage\":5,\"info\":\"Documento enviado a DEMO\"}},\"Request with unexpected alignment\":{\"summary\":\"Unexpected alignment\",\"description\":\"Request with unexpected alignment\",\"value\":{\"url\":\"s3://demos/ArchivoFactura1.pdf\",\"isQR\":true,\"idTypeHashAlignW\":8,\"idTypeHashAlignH\":3,\"idTypeQRAlignW\":8,\"idTypeQRAlignH\":3,\"idTypePage\":3,\"info\":\"Documento enviado a DEMO\"}},\"Request a signed PDF\":{\"summary\":\"Request without any warnings\",\"description\":\"Request a signed PDF\",\"value\":{\"url\":\"s3://demos/ArchivoFactura1.pdf\",\"isQR\":true,\"idTypeHashAlignW\":2,\"idTypeHashAlignH\":3,\"idTypeQRAlignW\":1,\"idTypeQRAlignH\":3,\"idTypePage\":3,\"info\":\"Documento enviado a DEMO , numero de Factura Demo No: F00055555, monto de pago:1.000\"}},\"Request with unexpected JSON structure\":{\"summary\":\"Unexpected JSON structure\",\"description\":\"Request with unexpected JSON structure\",\"value\":{\"urlss\":\"s3://demos/ArchivoFactura1.pdf\",\"isQR\":true,\"idTypeHashAlignW\":2,\"idTypeHashAlignH\":3,\"idTypeQRAlignW\":1,\"idTypeQRAlignH\":3,\"idTypePage\":3,\"info\":\"Documento enviado a DEMO\"}},\"Request with nonexistent document\":{\"summary\":\"Nonexistent document\",\"description\":\"Request with nonexistent document\",\"value\":{\"url\":\"s3://not/ArchivoFactura1.pdf\",\"isQR\":true,\"idTypeHashAlignW\":2,\"idTypeHashAlignH\":3,\"idTypeQRAlignW\":1,\"idTypeQRAlignH\":3,\"idTypePage\":3,\"info\":\"Documento enviado a DEMO\"}},\"Request with unexpected document type\":{\"summary\":\"Wrong document type\",\"description\":\"Request with unexpected document type\",\"value\":{\"url\":\"s3://demos/ArchivoFactura1.jpg\",\"isQR\":true,\"idTypeHashAlignW\":2,\"idTypeHashAlignH\":3,\"idTypeQRAlignW\":1,\"idTypeQRAlignH\":3,\"idTypePage\":3,\"info\":\"Documento enviado a DEMO\"}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The server successfully processed the request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseDocumentSignDTO\"},\"examples\":{\"Response when the document is not a pdf\":{\"summary\":\"Unexpected document type\",\"description\":\"Response when the document is not a pdf\",\"value\":{\"responseCode\":\"16\",\"responseDescription\":\"Wrong document type\"}},\"Response when the document could not be found\":{\"summary\":\"Document not found\",\"description\":\"Response when the document could not be found\",\"value\":{\"responseCode\":\"04\",\"responseDescription\":\"Document not found\"}},\"Response when either the height or width alignment values are unexpected\":{\"summary\":\"Unexpected alignment value\",\"description\":\"Response when either the height or width alignment values are unexpected\",\"value\":{\"responseCode\":\"17\",\"responseDescription\":\"Unexpected alignment value. Allowable values are: (alignment_W: 1(Left) - 2(Center) - 3(Right) | alignment_H: 1(Up) - 2(Center) - 3(Down) )\"}},\"Response when the page type value is unexpected\":{\"summary\":\"Unexpected page type\",\"description\":\"Response when the page type value is unexpected\",\"value\":{\"responseCode\":\"18\",\"responseDescription\":\"Unexpected page type value, Allowable values are: ( 1 (First) - 2 (Last) - 3 (All))\"}},\"Response when the certificate has any problems, or if it is expired \":{\"summary\":\"File security error\",\"description\":\"Response when the certificate has any problems, or if it is expired \",\"value\":{\"responseCode\":\"19\",\"responseDescription\":\"File Security error\"}},\"Response when info field has more than 255 characters\":{\"summary\":\"Maximum character limit exceeded\",\"description\":\"Response when info field has more than 255 characters\",\"value\":{\"responseCode\":\"20\",\"responseDescription\":\"Maximum number of characters exceeded in the info field (should be less than 255)\"}},\"Successful Request without any warnings\":{\"summary\":\"Successful request result\",\"description\":\"Successful Request without any warnings\",\"value\":{\"responseCode\":\"00\",\"responseDescription\":\"OK.\",\"url\":\"s3://sign/2020/8/ArchivoFactura1.pdf\"}}}}}},\"400\":{\"description\":\"Incorrect Request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseDocumentSignDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"responseCode\":\"02\",\"responseDescription\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication Error\"}},\"security\":[{\"basicAuth\":[]}]}},\"/geturldownload\":{\"post\":{\"tags\":[\"Document Download\"],\"summary\":\"Request the download url of a document(s)\",\"description\":\"This service provides a URL to download a document\",\"operationId\":\"getURLDownload\",\"requestBody\":{\"description\":\"JSON with the data required to get the download URL of a document(s)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/URLDownloadDTO\"},\"examples\":{\"Exceeded the maximum number of files to be compressed (folder with more than 100 documents) (default value is 100)\":{\"summary\":\"Exceeded the maximum number of files to be compressed\",\"description\":\"Exceeded the maximum number of files to be compressed (folder with more than 100 documents) (default value is 100)\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":true,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/MoreThan100DocumentsInThisFolder/\"}],\"filter1\":\"88\",\"filter2\":\"Demo\",\"filter3\":\"2021\"}},\"Request the url of a document to be downloaded\":{\"summary\":\"Request without any warnings\",\"description\":\"Request the url of a document to be downloaded\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":false,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"}],\"filter1\":\"88\",\"filter2\":\"Demo\",\"filter3\":\"2021\"}},\"Exceeded the maximum number of documents allowed (default value is 10)\":{\"summary\":\"Exceeded the maximum number of documents allowed\",\"description\":\"Exceeded the maximum number of documents allowed (default value is 10)\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":false,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654322.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654323.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654324.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654325.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654326.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654327.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654328.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654329.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654330.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654331.pdf\"}],\"filter1\":\"88\",\"filter2\":\"Demo\",\"filter3\":\"2021\"}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The server successfully processed the request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ListURLDownloadSimpleDTO\"},\"examples\":{\"Exceeded the maximum number of files to be compressed (default value is 100)\":{\"summary\":\"Exceeded the maximum number of files to be compressed\",\"description\":\"Exceeded the maximum number of files to be compressed (default value is 100)\",\"value\":{\"codResponse\":\"09\",\"desResponse\":\"Exceeded the maximum number of files to be compressed\"}},\"Successful Request without any warnings\":{\"summary\":\"Successful request result\",\"description\":\"Successful Request without any warnings\",\"value\":{\"codResponse\":\"00\",\"desResponse\":\"OK.\",\"result\":[{\"isObjectExist\":true,\"urllong\":\"null\",\"urlshort\":\"https://api.danaconnect.com/document/download?id=1501af6f4096\",\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"}]}},\"Exceeded the maximum number of documents allowed (default value is 10)\":{\"summary\":\"Exceeded the maximum number of documents allowed\",\"description\":\"Exceeded the maximum number of documents allowed (default value is 10)\",\"value\":{\"codResponse\":\"03\",\"desResponse\":\"Exceeded the maximum number of documents allowed\"}}}}}},\"400\":{\"description\":\"Incorrect Request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultErrorDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"responseCode\":\"02\",\"responseDescription\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication Error\"}},\"security\":[{\"basicAuth\":[]}]}},\"/geturldownloadinfo\":{\"post\":{\"tags\":[\"Document Download\"],\"summary\":\"Request the download url of a document(s)\",\"description\":\"This service provides a URL to download a document\",\"operationId\":\"getURLDownloadInfo\",\"requestBody\":{\"description\":\"JSON with the data required to get the download URL of a document(s)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/URLDownloadInfoDTO\"},\"examples\":{\"Exceeded the maximum number of files to be compressed (folder with more than 100 documents) (default value is 100)\":{\"summary\":\"Exceeded the maximum number of files to be compressed\",\"description\":\"Exceeded the maximum number of files to be compressed (folder with more than 100 documents) (default value is 100)\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":true,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/MoreThan100DocumentsInThisFolder/\"}],\"filter1\":\"88\",\"filter2\":\"Demo\",\"filter3\":\"2021\"}},\"Request the url of a document to be downloaded\":{\"summary\":\"Request without any warnings\",\"description\":\"Request the url of a document to be downloaded\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":false,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"}],\"filter1\":\"88\",\"filter2\":\"Demo\",\"filter3\":\"2021\"}},\"Exceeded the maximum number of documents allowed (default value is 10)\":{\"summary\":\"Exceeded the maximum number of documents allowed\",\"description\":\"Exceeded the maximum number of documents allowed (default value is 10)\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":false,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654322.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654323.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654324.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654325.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654326.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654327.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654328.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654329.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654330.pdf\"},{\"urls\":\"s3://demos/SolicitudDocs/Poliza10-987654331.pdf\"}],\"filter1\":\"88\",\"filter2\":\"Demo\",\"filter3\":\"2021\"}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The server successfully processed the request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ListURLDownloadSimpleDTO\"},\"examples\":{\"Exceeded the maximum number of files to be compressed (default value is 100)\":{\"summary\":\"Exceeded the maximum number of files to be compressed\",\"description\":\"Exceeded the maximum number of files to be compressed (default value is 100)\",\"value\":{\"codResponse\":\"09\",\"desResponse\":\"Exceeded the maximum number of files to be compressed\"}},\"Successful Request without any warnings\":{\"summary\":\"Successful request result\",\"description\":\"Successful Request without any warnings\",\"value\":{\"codResponse\":\"00\",\"desResponse\":\"OK.\",\"result\":[{\"isObjectExist\":true,\"urllong\":\"null\",\"urlshort\":\"https://api.danaconnect.com/document/download?id=1501af6f4096\",\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"}]}},\"Exceeded the maximum number of documents allowed (default value is 10)\":{\"summary\":\"Exceeded the maximum number of documents allowed\",\"description\":\"Exceeded the maximum number of documents allowed (default value is 10)\",\"value\":{\"codResponse\":\"03\",\"desResponse\":\"Exceeded the maximum number of documents allowed\"}}}}}},\"400\":{\"description\":\"Incorrect Request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultErrorDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"responseCode\":\"02\",\"responseDescription\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication Error\"}},\"security\":[{\"basicAuth\":[]}]}},\"/geturldownloadwithconversation\":{\"post\":{\"tags\":[\"Document Download\"],\"summary\":\"Request the download url of a document(s) and starts a conversation\",\"description\":\"This service provides a URL to download a document and starts a conversation. The urls are sent through the conversation (They are not returned in the service response)\",\"operationId\":\"getURLDownloadWithStartConversation\",\"requestBody\":{\"description\":\"JSON with the data required to get the download URL of a document(s) and to start a conversation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/URLDownloadConversationDTO\"},\"examples\":{\"Request the url of a document to be downloaded\":{\"summary\":\"Request without any warnings\",\"description\":\"Request the url of a document to be downloaded\",\"value\":{\"configServiceType\":1,\"isStrict\":false,\"isZip\":false,\"urlType\":1,\"documentList\":[{\"url\":\"s3://demos/SolicitudDocs/Poliza10-987654321.pdf\"}],\"idConversation\":\"165245\",\"values\":{\"MYDB_FIRST_NAME\":\"John\",\"MYDB_LASTNAME\":\"Doe\",\"MYDB_EMAIL\":\"johndoe@dominio.com\",\"MYDB_URLSHORT\":\"$f{URLSHORT}\"}}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The server successfully processed the request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ListURLDownloadValidStorageDTO\"},\"examples\":{\"Successful Response without any warnings\":{\"summary\":\"Successful Response\",\"description\":\"Successful Response without any warnings\",\"value\":{\"codResponse\":\"00\",\"desResponse\":\"OK.\"}}}}}},\"400\":{\"description\":\"Incorrect Request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultErrorDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"responseCode\":\"02\",\"responseDescription\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication Error\"}},\"security\":[{\"basicAuth\":[]}]}},\"/getdocumentbyfilters\":{\"post\":{\"tags\":[\"Document Download\"],\"summary\":\"Request the download url of documents that match given filters\",\"description\":\"This service provides URLs to download documents matching the given filters\",\"operationId\":\"getDocumentByFilters\",\"requestBody\":{\"description\":\"JSON with the data required to get the download URL of a document(s)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RequestGetDocumentDTO\"},\"examples\":{\"Request with unexpected conditional value\":{\"summary\":\"Request with unexpected conditional\",\"description\":\"Request with unexpected conditional value\",\"value\":{\"id_document_type\":0,\"type_filter_1\":\"none\",\"filter_1\":\"Test Name\",\"type_filter_2\":\"none\",\"filter_2\":\"Test Lastname\",\"type_filter_3\":\"none\",\"filter_3\":\"Test Lastname\",\"conditional\":\"zzz\"}},\"Request in which no filter was selected\":{\"summary\":\"Request without filters \",\"description\":\"Request in which no filter was selected\",\"value\":{\"id_document_type\":0,\"type_filter_1\":\"none\",\"filter_1\":\"Test Name\",\"type_filter_2\":\"none\",\"filter_2\":\"Test Lastname\",\"type_filter_3\":\"none\",\"filter_3\":\"Test Lastname\",\"conditional\":\"or\"}},\"Request the url of a document to be downloaded\":{\"summary\":\"Request without any warnings\",\"description\":\"Request the url of a document to be downloaded\",\"value\":{\"id_document_type\":0,\"type_filter_1\":\"equal\",\"filter_1\":\"Test Name\",\"type_filter_2\":\"equal\",\"filter_2\":\"Test Lastname\",\"type_filter_3\":\"equal\",\"filter_3\":\"Test Lastname\",\"conditional\":\"or\"}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The server successfully processed the request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseGetDocumentListDTO\"},\"examples\":{\"At least one filter is expected\":{\"summary\":\"No filter was selected\",\"description\":\"At least one filter is expected\",\"value\":{\"responseCode\":\"00\",\"responseDescription\":\"You must choose at least one option as a filter\"}},\"Successful Request without any warnings\":{\"summary\":\"Successful request result\",\"description\":\"Successful Request without any warnings\",\"value\":{\"responseCode\":\"00\",\"responseDescription\":\"OK.\",\"documentList\":[{\"id_document\":2,\"document_type\":\"TestAPIs\",\"path_document_storage\":\"s3://zip/3e365257.zip/P\",\"url_short\":\"https://doc.danaconnect.com/document/download?id=1501af6f4096\",\"url_long\":\" \",\"url_valid_until_date\":\"2020-07-27\",\"iszip\":false,\"filter_1\":\"Test Lastname\",\"filter_2\":\"Test Name\",\"filter_3\":\"test@test.com\",\"create_date\":\"2019-08-13\"}]}},\"Unexpected conditional type Allowable values are: (and | or)\":{\"summary\":\"Unexpected conditional type\",\"description\":\"Unexpected conditional type Allowable values are: (and | or)\",\"value\":{\"responseCode\":\"15\",\"responseDescription\":\"Unexpected conditional type. Allowable values are: (and | or)\"}}}}}},\"400\":{\"description\":\"Incorrect Request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultErrorDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"responseCode\":\"02\",\"responseDescription\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication Error\"}},\"security\":[{\"basicAuth\":[]}]}},\"/getdocumentbyfiltersinfo\":{\"post\":{\"tags\":[\"Document Download\"],\"summary\":\"Request the download url of documents that match given filters\",\"description\":\"This service provides URLs to download documents matching the given filters\",\"operationId\":\"getDocumentByFiltersInfo\",\"requestBody\":{\"description\":\"JSON with the data required to get the download URL of a document(s)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseGetDocumentListDTO\"},\"examples\":{\"Request with unexpected conditional value\":{\"summary\":\"Request with unexpected conditional\",\"description\":\"Request with unexpected conditional value\",\"value\":{\"id_document_type\":0,\"type_filter_1\":\"none\",\"filter_1\":\"Test Name\",\"type_filter_2\":\"none\",\"filter_2\":\"Test Lastname\",\"type_filter_3\":\"none\",\"filter_3\":\"Test Lastname\",\"conditional\":\"zzz\"}},\"Request in which no filter was selected\":{\"summary\":\"Request without filters \",\"description\":\"Request in which no filter was selected\",\"value\":{\"id_document_type\":0,\"type_filter_1\":\"none\",\"filter_1\":\"Test Name\",\"type_filter_2\":\"none\",\"filter_2\":\"Test Lastname\",\"type_filter_3\":\"none\",\"filter_3\":\"Test Lastname\",\"conditional\":\"or\"}},\"Request the url of a document to be downloaded\":{\"summary\":\"Request without any warnings\",\"description\":\"Request the url of a document to be downloaded\",\"value\":{\"id_document_type\":0,\"type_filter_1\":\"equal\",\"filter_1\":\"Test Name\",\"type_filter_2\":\"equal\",\"filter_2\":\"Test Lastname\",\"type_filter_3\":\"equal\",\"filter_3\":\"Test Lastname\",\"conditional\":\"or\"}}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The server successfully processed the request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResponseGetDocumentListDTO\"},\"examples\":{\"At least one filter is expected\":{\"summary\":\"No filter was selected\",\"description\":\"At least one filter is expected\",\"value\":{\"responseCode\":\"00\",\"responseDescription\":\"You must choose at least one option as a filter\"}},\"Successful Request without any warnings\":{\"summary\":\"Successful request result\",\"description\":\"Successful Request without any warnings\",\"value\":{\"responseCode\":\"00\",\"responseDescription\":\"OK.\",\"documentList\":[{\"id_document\":2,\"document_type\":\"TestAPIs\",\"path_document_storage\":\"s3://zip/3e365257.zip/P\",\"url_short\":\"https://doc.danaconnect.com/document/download?id=1501af6f4096\",\"url_long\":\" \",\"url_valid_until_date\":\"2020-07-27\",\"iszip\":false,\"filter_1\":\"Test Lastname\",\"filter_2\":\"Test Name\",\"filter_3\":\"test@test.com\",\"create_date\":\"2019-08-13\"}]}},\"Unexpected conditional type Allowable values are: (and | or)\":{\"summary\":\"Unexpected conditional type\",\"description\":\"Unexpected conditional type Allowable values are: (and | or)\",\"value\":{\"responseCode\":\"15\",\"responseDescription\":\"Unexpected conditional type. Allowable values are: (and | or)\"}}}}}},\"400\":{\"description\":\"Incorrect Request. The request did not match the expected format\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultErrorDTO\"},\"examples\":{\"Unexpected format in the request\":{\"summary\":\"Incorrect request\",\"description\":\"Unexpected format in the request\",\"value\":{\"responseCode\":\"02\",\"responseDescription\":\"Bad parameter\"}}}}}},\"401\":{\"description\":\"Authentication Error\"}},\"security\":[{\"basicAuth\":[]}]}}},\"components\":{\"schemas\":{\"URLDownloadInfoDTO\":{\"required\":[\"configServiceType\",\"isStrict\",\"isZip\",\"urlType\"],\"type\":\"object\",\"properties\":{\"configServiceType\":{\"type\":\"integer\",\"description\":\"Identifier indicating Document Manager's service configuration type in DANAConnect platform\",\"format\":\"int32\"},\"isStrict\":{\"type\":\"boolean\",\"description\":\" If set to `true`, then the search will be strict, and will abort the process if no result is found for the document url. If `false`, every document found will be processed, and those not found will be indicated. \"},\"isZip\":{\"type\":\"boolean\",\"description\":\"If set to `true`, all found files will be provided as a zip file, otherwise only the individual list download URL is generated\"},\"urlType\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"\\n\\n| Value | Type |\\n|-------|--------------------|\\n| 1 | Short URL |\\n| 2 | Long URL |\\n| 3 | Short and Long URL |\\n\\n\\n\",\"format\":\"int32\"},\"filter1\":{\"type\":\"string\",\"description\":\"Value that will find the files that were added to the document manager with that keyword in filter1\"},\"filter2\":{\"type\":\"string\",\"description\":\"Value that will find the files that were added to the document manager with that keyword in filter2\"},\"filter3\":{\"type\":\"string\",\"description\":\"Value that will find the files that were added to the document manager with that keyword in filter3\"},\"info\":{\"type\":\"string\",\"description\":\"Value that contains additional information about the files that were added to the document manager\"},\"documentList\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DocumentDTO\"}}},\"description\":\"Contains the information needed to request the download URL of a document\"},\"RequestDocumentSignDTO\":{\"required\":[\"idTypeHashAlignH\",\"idTypeHashAlignW\",\"idTypePage\",\"idTypeQRAlignH\",\"idTypeQRAlignW\",\"info\",\"isQR\",\"url\"],\"type\":\"object\",\"properties\":{\"url\":{\"minLength\":1,\"type\":\"string\",\"description\":\"Document address inside DANAConnect Storage\"},\"isQR\":{\"type\":\"boolean\",\"description\":\"Indicate `true` or `false`, if QR code needs to be added\"},\"idTypeHashAlignW\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"Hash horizontal alignment Width \\n\\n| Value | Alignment |\\n|-------|-----------|\\n| 1 | Left |\\n| 2 | Center |\\n| 3 | Right |\\n\\n\\n\",\"format\":\"int32\"},\"idTypeHashAlignH\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"Hash horizontal alignment Height \\n\\n| Value | Alignment |\\n|-------|-----------|\\n| 1 | Up |\\n| 2 | Center |\\n| 3 | Down |\\n\\n\\n\",\"format\":\"int32\"},\"idTypeQRAlignW\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"QR horizontal alignment Width \\n\\n| Value | Alignment |\\n|-------|-----------|\\n| 1 | Left |\\n| 2 | Center |\\n| 3 | Right |\\n\\n\\n\",\"format\":\"int32\"},\"idTypeQRAlignH\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"QR horizontal alignment Height \\n\\n| Value | Alignment |\\n|-------|-----------|\\n| 1 | Up |\\n| 2 | Center |\\n| 3 | Down |\\n\\n\\n\",\"format\":\"int32\"},\"idTypePage\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"Page insertion type \\n\\n| Value | Type |\\n|-------|-------|\\n| 1 | First |\\n| 2 | Last |\\n| 3 | All |\\n\\n\\n\",\"format\":\"int32\"},\"info\":{\"maxLength\":255,\"minLength\":3,\"type\":\"string\",\"description\":\"Text up to 255 characters, that will show up in hash validation. Words written here can be used to validate the document\"}}},\"resultErrorDTO\":{\"required\":[\"responseCode\",\"responseDescription\"],\"type\":\"object\",\"properties\":{\"responseCode\":{\"type\":\"string\",\"description\":\"Message Code\",\"enum\":[\"00 - OK\",\"000 - OK with warning\",\"01 - Unauthorized user. Access denied.\",\"02 - Bad parameter\",\"03 - Exceeded the maximum number of documents allowed\",\"04 - Document not found\",\"05 - URL type not found\",\"06 - Unknown error\",\"07 - Duplicated URL on document list\",\"08 - A special tag associated with the urlType ($f{URLSHORT} or $f{URLLONG}) was not send\",\"09 - Exceeded the maximum number of files to be compressed\",\"10 - The configuration service type (configServiceType) is incorrect or is not assigned\",\"11 - The configuration service type is not complete (code Filter)\",\"12 - Required labels are missing\",\"13 - Error: You must choose at least one option as a filter\",\"14 - Unexpected filter type. Allowable values are: (none | equal | contains | begins | ends)\",\"15 - Unexpected conditional type. Allowable values are: (and | or)\",\"16 - Error: Wrong document type\",\"17 - Error: Unexpected alignment value. Allowable values are: (alignment_W: 1(Left) - 2(Center) - 3(Right) | alignment_H: 1(Up) - 2(Center) - 3(Down) )\",\"18 - Unexpected page type value, Allowable values are: ( 1 (First) - 2 (Last) - 3 (All))\",\"19 - File Security error\",\"20 - Maximum number of characters exceeded in the info field (less than 255\"]},\"responseDescription\":{\"type\":\"string\",\"description\":\"Response Description\"}}},\"ResponseSearchTextDTO\":{\"required\":[\"code_response\",\"page_count\",\"results\"],\"type\":\"object\",\"properties\":{\"code_response\":{\"type\":\"string\",\"description\":\"Response code of the service.\"},\"page_count\":{\"type\":\"integer\",\"description\":\"Number of pages in the document\",\"format\":\"int32\"},\"results\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"description\":\"An object containing the query results, where the keys correspond to the keyResponse specified in the request.\"},\"description\":\"An object containing the query results, where the keys correspond to the keyResponse specified in the request.\"}},\"description\":\"Json structure to search for documents by given filters\"},\"QueryDTO\":{\"required\":[\"keyResponse\",\"queryParameters\"],\"type\":\"object\",\"properties\":{\"queryParameters\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"Query parameters [code, textSearch]: The maximum number of query parameters is 10. This is used to identify text within a PDF document or images\\n\\n| Code | Description | Cardinality |\\n|--------------|---------------------------------------|---------------------------------------|\\n| text_count | Count text in text Search document | Can be used more than once |\\n| number_count | Count number in text Search document | Can be used more than once |\\n| min_number | Min number in text Search document | Can only be used once |\\n| max_number | Max number in text Search document | Can only be used once |\\n| dates_count | Count dates in text Search document | Can be used more than once |\\n| min_date | Min date in text Search document | Can only be used once |\\n| max_date | Max date in text Search document | Can only be used once |\\n\\n\\n\",\"enum\":[\"text_count\",\"number_count\",\"min_number\",\"max_number\",\"dates_count\",\"min_date\",\"max_date\"]},\"description\":\"Query parameters [code, textSearch]: The maximum number of query parameters is 10. This is used to identify text within a PDF document or images\\n\\n| Code | Description | Cardinality |\\n|--------------|---------------------------------------|---------------------------------------|\\n| text_count | Count text in text Search document | Can be used more than once |\\n| number_count | Count number in text Search document | Can be used more than once |\\n| min_number | Min number in text Search document | Can only be used once |\\n| max_number | Max number in text Search document | Can only be used once |\\n| dates_count | Count dates in text Search document | Can be used more than once |\\n| min_date | Min date in text Search document | Can only be used once |\\n| max_date | Max date in text Search document | Can only be used once |\\n\\n\\n\",\"enum\":[\"text_count\",\"number_count\",\"min_number\",\"max_number\",\"dates_count\",\"min_date\",\"max_date\"]},\"keyResponse\":{\"type\":\"string\",\"description\":\"Key Custom Response: This parameter allows you to specify a custom key field. The idea is to use this field to locate the search query sent in the request and retrieve the result in the JSON response using the designated keyword.\"}},\"description\":\"Search Text AI Parameters for PDF/Image References\"},\"URLDownloadConversationDTO\":{\"required\":[\"configServiceType\",\"idConversation\",\"isStrict\",\"isZip\",\"urlType\",\"values\"],\"type\":\"object\",\"properties\":{\"configServiceType\":{\"type\":\"integer\",\"description\":\"Identifier indicating Document Manager's service configuration type in DANAConnect platform\",\"format\":\"int32\"},\"isStrict\":{\"type\":\"boolean\",\"description\":\"If set to `true`, then the search will be strict, and will abort the process if no result is found for document url. If `false`, every document found will be processed, and those not found will be indicated. \"},\"isZip\":{\"type\":\"boolean\",\"description\":\"If set to `true`, all found files will be zipped, otherwise only the individual list download URL is generated\"},\"urlType\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"\\n\\n| Value | Type |\\n|-------|--------------------|\\n| 1 | Short URL |\\n| 2 | Long URL |\\n| 3 | Short and Long URL |\\n\\n\\n\",\"format\":\"int32\"},\"idConversation\":{\"minimum\":1,\"type\":\"integer\",\"description\":\"Conversation id\",\"format\":\"int32\"},\"values\":{\"type\":\"string\",\"description\":\"This should be a JSON object in which keys are the field identifier inside that the contact list that is related to the conversation. And as values the content that will be inserted in that field.\\\\\\n **EXAMPLE:**\\n```\\n{\\\"FIELD_1\\\":\\\"VALUE_1\\\",\\n\\\"FIELD_2\\\":\\\"VALUE_2\\\",\\n...}\\n```\\n\"},\"documentList\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DocumentDTO\"}}},\"description\":\"Json structure to request the download URL of a document and to start a conversation\"},\"DocumentDTO\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"}},\"description\":\"Contains the document's repository URL in DANAConnect's platform, where the document is stored\"},\"URLDownloadDTO\":{\"required\":[\"configServiceType\",\"isStrict\",\"isZip\",\"urlType\"],\"type\":\"object\",\"properties\":{\"configServiceType\":{\"type\":\"integer\",\"description\":\"Identifier indicating Document Manager's service configuration type in DANAConnect platform\",\"format\":\"int32\"},\"isStrict\":{\"type\":\"boolean\",\"description\":\" If set to `true`, then the search will be strict, and will abort the process if no result is found for the document url. If `false`, every document found will be processed, and those not found will be indicated. \"},\"isZip\":{\"type\":\"boolean\",\"description\":\"If set to `true`, all found files will be provided as a zip file, otherwise only the individual list download URL is generated\"},\"urlType\":{\"maximum\":3,\"minimum\":1,\"type\":\"integer\",\"description\":\"\\n\\n| Value | Type |\\n|-------|--------------------|\\n| 1 | Short URL |\\n| 2 | Long URL |\\n| 3 | Short and Long URL |\\n\\n\\n\",\"format\":\"int32\"},\"filter1\":{\"type\":\"string\",\"description\":\"Value that will find the files that were added to the document manager with that keyword in filter1\"},\"filter2\":{\"type\":\"string\",\"description\":\"Value that will find the files that were added to the document manager with that keyword in filter2\"},\"filter3\":{\"type\":\"string\",\"description\":\"Value that will find the files that were added to the document manager with that keyword in filter3\"},\"documentList\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DocumentDTO\"}}},\"description\":\"Contains the information needed to request the download URL of a document\"},\"ResponseDocumentSignDTO\":{\"required\":[\"responseCode\",\"responseDescription\"],\"type\":\"object\",\"properties\":{\"responseCode\":{\"type\":\"string\",\"description\":\"Message Code\\n\\n| Code | Description |\\n|------|--------------------------------------------------------------------------------------------------------------------------------------------------|\\n| 00 | OK |\\n| 000 | OK with warning |\\n| 01 | Unauthorized user. Access denied |\\n| 02 | Bad parameter |\\n| 03 | Exceeded the maximum number of documents allowed |\\n| 04 | Document not found |\\n| 05 | URL type not found |\\n| 06 | Unknown error |\\n| 07 | Duplicated URL on document list |\\n| 08 | A special tag associated with the urlType ($f{URLSHORT} or $f{URLLONG}) was not sent) |\\n| 09 | Exceeded the maximum number of files to be compressed |\\n| 10 | The configuration service type (configServiceType) is incorrect or is not assigned |\\n| 11 | The configuration service type is not complete (code Filter) |\\n| 12 | Required labels are missing |\\n| 13 | Error: You must choose at least one option as a filter |\\n| 14 | Unexpected filter type. Allowable values: (none \\\\| equal \\\\| contains \\\\| begins \\\\| ends) |\\n| 15 | Unexpected conditional type. Allowable values are: (and \\\\| or) |\\n| 16 | Error: Wrong document type |\\n| 17 | Error: Unexpected alignment value. Allowable values: (alignment_W: 1(Left) - 2(Center) - 3(Right) \\\\| alignment_H: 1(Up) - 2(Center) - 3(Down) ) |\\n| 18 | Unexpected page type value, Allowable values: ( 1 (First) - 2 (Last) - 3 (All) ) |\\n| 19 | File Security error |\\n| 20 | Maximum number of characters exceeded in the info field (less than 255) |\\n\\n\\n\",\"enum\":[\"00\",\"000\",\"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\",\"13\",\"14\",\"15\",\"16\",\"17\",\"18\",\"19\",\"20\"]},\"responseDescription\":{\"type\":\"string\",\"description\":\"Response Description\"},\"url\":{\"type\":\"string\",\"description\":\"Signed file location in DANAConnect's Storage\"}}},\"ListURLDownloadSimpleDTO\":{\"required\":[\"codResponse\",\"desResponse\"],\"type\":\"object\",\"properties\":{\"codResponse\":{\"type\":\"string\",\"description\":\"Message Code\\n\\n| Code | Description |\\n|------|---------------------------------------------------------------------------------------|\\n| 00 | OK |\\n| 000 | OK with warning |\\n| 01 | Unauthorized user. Access denied |\\n| 02 | Bad parameter |\\n| 03 | Exceeded the maximum number of documents allowed |\\n| 04 | Document not found |\\n| 05 | URL type not found |\\n| 06 | Unknown error |\\n| 07 | Duplicated URL on document list |\\n| 08 | A special tag associated with the urlType ($f{URLSHORT} or $f{URLLONG}) was not sent) |\\n| 09 | Exceeded the maximum number of files to be compressed |\\n| 10 | The configuration service type (configServiceType) is incorrect or is not assigned |\\n| 11 | The configuration service type is not complete (code Filter) |\\n| 12 | Required labels are missing |\\n\\n\\n\",\"enum\":[\"00\",\"000\",\"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\"]},\"desResponse\":{\"type\":\"string\",\"description\":\"Response Description\"},\"result\":{\"type\":\"array\",\"description\":\"Request result, containing the urls for the documents to be downloaded\",\"items\":{\"$ref\":\"#/components/schemas/GetURLDownloadSimpleDTO\"}}}},\"URLDownloadValidStorageDTO\":{\"type\":\"object\",\"properties\":{\"isObjectExist\":{\"type\":\"boolean\",\"description\":\"Indicates if the document exists\"},\"url\":{\"type\":\"string\"}},\"description\":\"Request result, only present when an unexpected path was sent, otherwise urls are sent through the conversation\"},\"RequestSearchTextDTO\":{\"required\":[\"file_reference\",\"queries\"],\"type\":\"object\",\"properties\":{\"file_reference\":{\"type\":\"string\",\"description\":\"This field should contain the physical path where the PDF or image file is located. It is used to analyze the intelligent text search specified in the query parameters. Example: URL for S3 references to PDFs/Images.\"},\"queries\":{\"type\":\"array\",\"description\":\"Search Text AI Parameters for PDF/Image References\",\"items\":{\"$ref\":\"#/components/schemas/QueryDTO\"}}},\"description\":\"JSON structure for requesting searchText AI in PDFs/Images.\"},\"ListURLDownloadValidStorageDTO\":{\"required\":[\"codResponse\",\"desResponse\"],\"type\":\"object\",\"properties\":{\"codResponse\":{\"type\":\"string\",\"description\":\"Message Code\\n\\n| Code | Description |\\n|------|---------------------------------------------------------------------------------------|\\n| 00 | OK |\\n| 000 | OK with warning |\\n| 01 | Unauthorized user. Access denied |\\n| 02 | Bad parameter |\\n| 03 | Exceeded the maximum number of documents allowed |\\n| 04 | Document not found |\\n| 05 | URL type not found |\\n| 06 | Unknown error |\\n| 07 | Duplicated URL on document list |\\n| 08 | A special tag associated with the urlType ($f{URLSHORT} or $f{URLLONG}) was not sent) |\\n| 09 | Exceeded the maximum number of files to be compressed |\\n| 10 | The configuration service type (configServiceType) is incorrect or is not assigned |\\n| 11 | The configuration service type is not complete (code Filter) |\\n| 12 | Required labels are missing |\\n\\n\\n\",\"enum\":[\"00\",\"000\",\"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\"]},\"desResponse\":{\"type\":\"string\",\"description\":\"Response Description\"},\"result\":{\"type\":\"array\",\"description\":\"Request result, only present when an unexpected path was sent, otherwise urls are sent through the conversation\",\"items\":{\"$ref\":\"#/components/schemas/URLDownloadValidStorageDTO\"}}}},\"RequestGetDocumentDTO\":{\"type\":\"object\",\"properties\":{\"id_document_type\":{\"type\":\"integer\",\"description\":\"Document Manager Service's configuration Unique ID number in DANAConnect platform\",\"format\":\"int32\"},\"type_filter_1\":{\"type\":\"string\",\"description\":\"Filter method that will be used for filter_1\",\"enum\":[\"none\",\"equals\",\"contains\",\"ends\",\"begins\"]},\"filter_1\":{\"type\":\"string\",\"description\":\"First filter applied when searching for documents\"},\"type_filter_2\":{\"type\":\"string\",\"description\":\"Filter method that will be used for filter_2\",\"enum\":[\"none\",\"equals\",\"contains\",\"ends\",\"begins\"]},\"filter_2\":{\"type\":\"string\",\"description\":\"Second filter applied when searching for documents\"},\"type_filter_3\":{\"type\":\"string\",\"description\":\"Filter method that will be used for filter_3\",\"enum\":[\"none\",\"equals\",\"contains\",\"ends\",\"begins\"]},\"filter_3\":{\"type\":\"string\",\"description\":\"Third filter applied when searching for documents\"},\"conditional\":{\"type\":\"string\",\"description\":\"Indicates if filters will be inclusive or exclusive\",\"enum\":[\"and\",\"or\"]}},\"description\":\"Json structure to search for documents by given filters\"},\"ResponseGetDocumentDTO\":{\"type\":\"object\",\"properties\":{\"id_document\":{\"type\":\"integer\",\"description\":\"Document Identifier\",\"format\":\"int32\"},\"document_type\":{\"type\":\"string\",\"description\":\"Identifies document configuration type\"},\"path_document_storage\":{\"type\":\"string\",\"description\":\"Path where the document is stored\"},\"url_short\":{\"type\":\"string\",\"description\":\"Short URL used to download the document\"},\"url_long\":{\"type\":\"string\",\"description\":\"Long URL used to download the document\"},\"url_valid_until_date\":{\"type\":\"string\",\"description\":\"Expiration date of both URLs\"},\"iszip\":{\"type\":\"boolean\",\"description\":\"Indicates if the document is a .zip file\"},\"filter_1\":{\"type\":\"string\",\"description\":\"Filter used to search the document\"},\"filter_2\":{\"type\":\"string\",\"description\":\"Filter used to search the document\"},\"filter_3\":{\"type\":\"string\",\"description\":\"Filter used to search the document\"},\"create_date\":{\"type\":\"string\",\"description\":\"Document's creation date in the system\"}},\"description\":\"Contains the list of documents that were found\"},\"GetURLDownloadSimpleDTO\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\",\"description\":\"Document URL\"},\"urlshort\":{\"type\":\"string\",\"description\":\"If urlType was set to 1 or 3 in the request, it will show the short url, otherwise will be null\"},\"urllong\":{\"type\":\"string\",\"description\":\"If urlType was set to 2 or 3 in the request, it will show the long url, otherwise will be null\"},\"isObjectExist\":{\"type\":\"boolean\",\"description\":\"Indicates if the document exists\"}},\"description\":\"Request result, containing the urls for the documents to be downloaded\"},\"ResponseGetDocumentListDTO\":{\"type\":\"object\",\"properties\":{\"responseCode\":{\"type\":\"string\",\"description\":\"Message Code\\n\\n| Code | Description |\\n|------|--------------------------------------------------------------------------------------------------------------------------------------------------|\\n| 00 | OK |\\n| 000 | OK with warning |\\n| 01 | Unauthorized user. Access denied |\\n| 02 | Bad parameter |\\n| 03 | Exceeded the maximum number of documents allowed |\\n| 04 | Document not found |\\n| 05 | URL type not found |\\n| 06 | Unknown error |\\n| 07 | Duplicated URL on document list |\\n| 08 | A special tag associated with the urlType ($f{URLSHORT} or $f{URLLONG}) was not sent) |\\n| 09 | Exceeded the maximum number of files to be compressed |\\n| 10 | The configuration service type (configServiceType) is incorrect or is not assigned |\\n| 11 | The configuration service type is not complete (code Filter) |\\n| 12 | Required labels are missing |\\n| 13 | Error: You must choose at least one option as a filter |\\n| 14 | Unexpected filter type. Allowable values: (none \\\\| equal \\\\| contains \\\\| begins \\\\| ends) |\\n| 15 | Unexpected conditional type. Allowable values are: (and \\\\| or) |\\n\\n\\n\",\"enum\":[\"00\",\"000\",\"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\",\"13\",\"14\",\"15\"]},\"responseDescription\":{\"type\":\"string\",\"description\":\"Response Description\"},\"documentlist\":{\"type\":\"array\",\"description\":\"Contains the list of documents that were found\",\"items\":{\"$ref\":\"#/components/schemas/ResponseGetDocumentDTO\"}}},\"description\":\"Response containing a list of documents\"}},\"securitySchemes\":{\"basicAuth\":{\"type\":\"http\",\"description\":\"The API uses the same user credential system that is used to enter the DANAConnect platform. \\nThe method used for all DANAConnect APIs is HTTP BASIC AUTH, which is based on login and password authentication. \\n**Login**: The login consists of the username concatenated with an @ and followed by the company code. \\nLogin example: \\n \\n- **Platform username**: myuser \\n- **Company code for the platform**: mycompanycode \\n- **Login for DANAConnect API**: myuser@mycompanycode \\n- **Password**: The password you should use for API authentication is the same as you use for login to the DANAConnect platform\",\"scheme\":\"basic\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"none\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"JavaScript\",\"label\":\"JS\"},{\"lang\":\"C#\"},{\"lang\":\"Java\"},{\"lang\":\"curl\"},{\"lang\":\"Node.js\"},{\"lang\":\"Python\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"","redocItemId":"overview","redocHasInfoPage":true,"settings":{"pagination":"none","corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"JavaScript","label":"JS"},{"lang":"C#"},{"lang":"Java"},{"lang":"curl"},{"lang":"Node.js"},{"lang":"Python"}]}},"requestLogin":false,"lastModified":"2026-06-01T21:05:14.000Z"},"seo":{"title":"API REST – Document Manager"}}},"pageContext":{"id":"923f24c6-226a-57ef-b121-9ca78b1f8779overview__redocly content/openapi/docmanager-reference/v1/overview/","seo":{"title":"API REST – Document Manager","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/docmanager-reference.page.yaml#overview@v1","pageBaseUrl":"/openapi/docmanager-reference","type":"redoc-info","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/docmanager-reference/v1/","sidebarName":"DANAConnectAPIs","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"docmanager","id":"v1","title":"v1.0","isDefault":false,"apiId":null},{"definitionId":"docmanager-v2","id":"v2.0","title":"v2.0 (latest)","isDefault":true,"apiId":null}],"apiVersionId":"v1","isDefaultApiVersion":false}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}