Criando um documento

URN

/documento/preparaDossie

Método:

POST

Headers

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

Body:

{
    "modelo": {
        "nome": "Contratos de licitações"
    },
    "filtros": [
        {
            "Nome": "João da Silva"
        },
        {
            "Contrato": "123456"
        }
    ],
    "documento": {
        "criar-novo": true
    },
    "projeto": {
        "nome": "Contratos"
    }
}

Retorno:

{
    "msg": "Operação realizada com sucesso",
    "status": "sucesso",
    "data": {
        "ch_criado_novo": "true",
        "sr_id": "35293068",
        "it_protocolo": "1772197"
    }
}

Caso o modelo seja configurado para executar o Script Personalizado Após via WS, o retorno do mesmo será adicionado à chave Data

{
    "msg": "Operação realizada com sucesso",
    "status": "sucesso",
    "data": {
        "ch_criado_novo": "true",
        "sr_id": "35293068",
        "it_protocolo": "1772197",
        "script-pos": {
            "abortar": false,
            "logs": []
        }
    }
}

Chave "modelo" (Obrigatório)

Pode conter as subchaves "id" ou "nome". Caso as duas subchaves existam 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ê esteja habilitado. Consulte a chave "documento" para mais informações.

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

Exemplo 1:

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

Exemplo 2:

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

Também pode conter a subchave "atualizar-projeto" com o valor true ou false, que será responsável por alterar o projeto do documento encontrado pelos filtros informados. É necessário informar o nome ou id do novo projeto.

{
    "projeto": {
        "nome": "Nome do novo projeto",
        "atualizar-projeto": true
    }
}

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 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.

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

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

Nota: Filtros avançados

Existe uma opção no GED para configurar os campos do modelo que serão utilizados como filtros.

Funcionamento: Supondo que tenho um modelo contendo os campos "Nome", "Estado Civil" com os valores "João" e "Solteiro", respectivamente , ao utilizar o método preparaDossie e informar "Nome":"João", "Estado Civil":"Casado", será criado um novo documento, pois a função não encontrou um documento com todos os campos idênticos, mas, se no GED for configurado o campo "Nome" para servir de filtro, o sistema irá encontrar os documentos onde o campo "Nome" correspondam a "João" e substituir o campo "Estado Civil" para casado, sem criar um novo documento.