Consultar documentos

O objetivo dessa API é realizar a consulta de documentos no sistema a partir de um requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/document/search

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name	Type	Description
documentId	Array de integer	Este parâmetro está em desuso e pode ser passado vazio
establishmentIds	Array de integer	Array de integer que passa os IDs dos estabelecimentos
processTypeIds	Array de integer	Array de integer que passa os códigos dos tipos de processos
documentTypeIds	Array de integer	Array de integer que passa os códigos dos tipos de documentos
initialDate	String	Consulta por data inicial. Deve ser no formato "03/11/2021 10:37:28"
finalDate	String	Consulta por data final. Deve ser no formato "03/11/2021 10:37:28"
searchFor	String	É o equivalente a busca geral no sistema

200: OK Requisição de sucesso

{
    "hits": 1,
    "time": 4,
    "documents": [
        {
            "idDocument": 279236533,
            "idUser": 50102188,
            "createDate": "03/11/2021 13:30:56",
            "idProcessType": 50029958,
            "processTypeDescription": "PROCESSO DE NOTAS VIA INTEGRAÇÃO",
            "idProcess": null,
            "documentTypeDescription": "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO",
            "idDocumentType": 70033766,
            "idMimeType": 5,
            "establishmentName": "INTEGRAÇÕES",
            "userName": "INTEGRACAO",
            "idSituationCheck": "C",
            "flagDocumentCheck": "S",
            "idCheck": null,
            "mimeType": "image/jpeg",
            "idEstablishment": 50102182,
            "documentAssigned": "https://cdn.vianuvem.com.br/d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202c76eb3e5d/ff77a46969b064b97a44426bc557ce28.original.jpg?Expires=1636317756&Signature=izIDgSlV1SAko4gx1MdVoYFXPQtqA4LMLH7roy~Cx5sW5ZvSx5bA7C7~Cli7k23BbHvfyaMY3KQL7RFqxHY~2AYHQRJhg1v6L2DJN9KRMUzYmivod5nC5R2t~2GuxMKsb9FeF645H-NZPuUb6nDJCh2it0wI-QkWMZQSk6MApxX0s5SGM2M21nboozVR99h~50pHBL2NjrqaHRu6r~IyjZF8vjEoV3GeS0Htcz2F0DcRzMNdf64s~H1WvDPNotf9QsQ3VX34hvSqIsPDEhKqmpNgmUNpUuTQUJmVoKsYkDSplOXrHEfMsfkTXQPkbkzoOdssfgAh5KfQW99Ljc0fmA__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA",
            "documentThumbSmallAssigned": "https://cdn.vianuvem.com.br/d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202c76eb3e5d/ff77a46969b064b97a44426bc557ce28.thumb-small.jpg?Expires=1636317756&Signature=iX4CKPAeKNVXxHSlCpQejodzC2LgQp2UiCWUu67Kp2GykfrGcmlrhXo5W~Xc1bg~i6hXn0yrkqwOoQCBEjlPqZeQrmsJB3JDWBCwgMNFW6jCEyuevrvG9Ugzv9iAJraxGSK8jlHZgsc3~HPdGaUvdlEBV1g7Lhn3bj9CaO8iuvidpAa6qWMMvL-QpJyMSzpyM0Dap9vs0CewyNPIps2yPF7GaFqdA5hfdY8pk6wMLuRVDFb7nAVF6XthLHiJOxORjXz6pKypLrf5a-pL8O-DGfTQH5jGdpMvF2Pvx33kOHL-FpD3kvkPh3~G1Rwe8xH7WjSy2mZxaFZZTb1vTOK8NQ__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA",
            "indexers": [
                {
                    "indexerNumber": 1,
                    "indexerType": "I",
                    "indexerLabel": "INTEIRO",
                    "indexerValue": "1234",
                    "indexerDetails": [],
                    "indexerFieldName": "INTEIRO",
                    "alert": null,
                    "id": 577186245,
                    "parentId": 50047879,
                    "form": false,
                    "stageId": null,
                    "uniqueId": null
                },
                {
                    "indexerNumber": 2,
                    "indexerType": "S",
                    "indexerLabel": "TEXTO",
                    "indexerValue": "TESTE",
                    "indexerDetails": [],
                    "indexerFieldName": "TEXTO",
                    "alert": null,
                    "id": 577186246,
                    "parentId": 50047880,
                    "form": false,
                    "stageId": null,
                    "uniqueId": null
                }
            ],
            "documentAttachments": [],
            "documentRestrict": null,
            "documentLastComment": "Inserido via integração",
            "signatures": null,
            "selfCaptureId": null,
            "capturedBy": null,
            "downloadUrl": "https://cdn.vianuvem.com.br/d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202c76eb3e5d/ff77a46969b064b97a44426bc557ce28.original.jpg?Expires=1636317756&Signature=izIDgSlV1SAko4gx1MdVoYFXPQtqA4LMLH7roy~Cx5sW5ZvSx5bA7C7~Cli7k23BbHvfyaMY3KQL7RFqxHY~2AYHQRJhg1v6L2DJN9KRMUzYmivod5nC5R2t~2GuxMKsb9FeF645H-NZPuUb6nDJCh2it0wI-QkWMZQSk6MApxX0s5SGM2M21nboozVR99h~50pHBL2NjrqaHRu6r~IyjZF8vjEoV3GeS0Htcz2F0DcRzMNdf64s~H1WvDPNotf9QsQ3VX34hvSqIsPDEhKqmpNgmUNpUuTQUJmVoKsYkDSplOXrHEfMsfkTXQPkbkzoOdssfgAh5KfQW99Ljc0fmA__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA",
            "processCreateDate": null,
            "processSituation": null,
            "processSituationId": null,
            "processOwnerId": null,
            "processUserReservedId": null,
            "processUserName": null,
            "processReservedDate": null,
            "processReservedUserName": null,
            "customerId": 6921,
            "relatedDocuments": [],
            "requiredInProcess": false,
            "checkNext": [],
            "checkPrev": [],
            "currentCheck": null,
            "situation": "Conferido",
            "currentCheckPosition": null,
            "checklist": [],
            "lastSituationProgressDate": null,
            "indexersDynamic": [],
            "establishmentCnpj": "73386365000170",
            "workflow": false,
            "processStageId": null,
            "transitionsTree": [],
            "swimlaneRoleName": null,
            "breadCrumbs": [],
            "establishmentGroupName": [
                "INTEGRAÇÕES"
            ],
            "hasAllRequiredDocuments": false,
            "processFinalSituation": false,
            "processEventNameInCurrentTransition": null,
            "processEstablishmentBreadCrumb": null,
            "processOwnerBreadCrumb": null,
            "attachedForms": null,
            "documentInviteStatus": null,
            "documentInvites": [],
            "hasCollaboration": false,
            "processDelay": null,
            "hasSignature": false,
            "lastConferenceDate": null,
            "documentCheckDelayDate": null,
            "formSnapshotId": null,
            "parentProcessId": null,
            "childProcessIds": null,
            "waitingChildProcessIds": null,
            "form": false,
            "my": true
        }
    ],
    "filters": [
        {
            "name": "process_progress_checklist_concat",
            "values": {}
        },
        {
            "name": "process_situation",
            "values": {}
        },
        {
            "name": "indexers_labels",
            "values": {
                "INTEIRO": 1,
                "TEXTO": 1
            }
        },
        {
            "name": "user_name",
            "values": {
                "INTEGRACAO": 1
            }
        },
        {
            "name": "check_label_prev_text",
            "values": {}
        },
        {
            "name": "check_label_prev",
            "values": {}
        },
        {
            "name": "check_label_next_text",
            "values": {}
        },
        {
            "name": "indexers_labels_types_names",
            "values": {
                "INTEIRO|I|INTEIRO": 1,
                "TEXTO|S|TEXTO": 1
            }
        },
        {
            "name": "establishment",
            "values": {
                "INTEGRAÇÕES": 1
            }
        },
        {
            "name": "process_type",
            "values": {
                "PROCESSO DE NOTAS VIA INTEGRAÇÃO": 1
            }
        },
        {
            "name": "situation",
            "values": {
                "Conferido": 1
            }
        },
        {
            "name": "establishment_group",
            "values": {
                "INTEGRAÇÕES": 1
            }
        },
        {
            "name": "document_type",
            "values": {
                "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO": 1
            }
        }
    ]
}

500: Internal Server Error Erro de autenticação

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
	"documentId": [],
	"establishmentIds": [],
	"processTypeIds": [],
	"documentTypeIds": [],
	"initialDate": "",
	"finalDate": "",
	"searchFor": "1234"
}