Preparando o Upload

URN

/documento/arquivo/preparaUpload

Método:

POST

Headers:

{
    "Content-Type": "application/json",
    "Authorization": "Token XXXXXXXXXXXXXXXX"
}

Body:

{
    "arquivo": {
        "nome": "teste.png",
        "tamanho": "9195",
        "pasta": "Documentos",
        "checklist": "RG"
    },
    "modelo": {
        "nome": "Contratos de licitações"
    },
    "filtros": [
        {
            "Nome": "João da Silva"
        },
        {
            "Contrato": "123456"
        }
    ],
    "documento": {
        "criar-novo": true,
        "seguir-fluxo": true
    },
    "projeto": {
        "nome": "Contratos"
    }
}

Retorno:

Retorna uma hash que será utilizada para o upload do arquivo com as demais informações.

{
    "msg": "Nova url de upload criada!",
    "status": "sucesso",
    "data": {
        "url_hash": "60758c7d821fc",
        "ch_criado_novo": false,
        "sr_id": 35293089,
        "it_protocolo": 1772218,
    }
}

Chave "modelo" (Obrigatório)

Pode conter as subchaves "id" ou "nome". Caso as duas subchaves estejem no objeto JSON, será utilizada somente a subchave "id".

Exemplo 1:

{
    "modelo": {
        "nome": "Contrato de licitações"
    }
}

Exemplo 2:

{
    "modelo": {
        "id": "101217"
    }
}

Chave "projeto" (Opcional)

Essa chave é obrigatória caso o parâmetro de criação de dossiê esteje habilitado. Consulte a chave "documento" para mais informações.

Pode conter as subchaves "id" ou "nome". Caso as duas subchaves estejem no objeto JSON, será utilizada somente a subchave "id".

Exemplo 1:

{
    "projeto": {
        "nome": "Contratos"
    }
}

Exemplo 2:

{
    "projeto": {
        "id": "123"
    }
}

Chave "filtros" (Obrigatório)

Esta chave aceita dois padrões diferentes:

• Pode ser um array de objetos, contendo o nome do campo do documento e o valor.

{
    "filtros": [
        {
            "Nome": "João da Silva"
        },
        {
            "Contrato": "123456"
        },
        {
            "Cpf": "123.456.789-12"
        }
    ]
}

• Como também pode ser um único objeto com todos os campos desejados.

{
    "filtros": {
        "Nome": "João da Silva",
        "Contrato": "123456",
        "Cpf": "123.456.789-12"
    }
}

A busca é realizada com a comparação por igualdade.

Chave "documento" (Opcional)

Pode conter a subchave criar-novo com o valor true ou false. Indicando que deve ser criado ou não um novo documento caso os campos de busca não retornem nenhum documento. Os dados utilizados no filtro preencherão os campos do novo dossiê.

O valor padrão da chave criar-novo é false.

{
    "documento": {
        "criar-novo": true
    }
}

Também pode conter a subchave seguir-fluxo com o valor true ou false que indica que, caso um novo documento seja criado, este deverá ser enviado para a primeira fase do fluxo configurado e seja disponível na caixa de entrada de todos os participantes da mesma. Caso a opção não seja informada ou possua o valor false, o documento será atribuído ao usuário da API na primeira fase.

Para utilizar este recurso, o fluxo deverá ser configurado também na aba "Dados Adicionais" no campo "Workflow" do modelo em questão.

O valor padrão da chave seguir-fluxo é false.

{
    "documento": {
        "seguir-fluxo": true
    }
}

Também pode conter a subchave sempre-criar com o valor true ou false, que será responsável por criar um novo documento independetemente se encontrar algum documento com os filtros informados.

{
    "documento": {
        "sempre-criar": true
    }
}

Outra subchave que pode ser informada é a criar-pasta com o valor true ou false, que criará uma nova pasta com o nome informado na subchave pasta da chave arquivo, e enviará o arquivo para ela.

{
    "documento": {
        "criar-pasta": true
    }
}