Pular para conteúdo

Migrando Arquivos

URN:

/documento/pasta/checklist/migrarArquivos

Método:

POST

Headers:

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

Body:

{
    "origem": {
        "modelo": {
            "nome": "CONTA"
        },
        "pasta": "Documentos",
        "checklist": "RG",
        "filtros": [
            {
                "Id": "CODIGO"
            }   
        ]
    },
    "destino": {
        "modelo": {
            "nome": "CONTRATO"
        },
        "pasta": "Documentos",
        "checklist": "RG",
        "filtros": [
            {
                "Id": "CODIGO"
            }   
        ]
    }
}

Retorno:

{
    "msg": "Arquivos migrados com sucesso!",
    "status": "sucesso",
    "data": {
        "origem": [
            {
                "it_documento": 123456,
                "vc_nome": "CONTA",
                "ts_cadastro": "2018-09-05 15:50:12.770415",
                "it_pasta": 454645645,
                "it_checklist": 7897889
            }
        ],
        "destino": [
            {
                "it_documento": 1234567,
                "vc_nome": "CONTRATO",
                "ts_cadastro": "2018-09-05 15:50:12.770415",
                "it_pasta": 112123,
                "it_checklist": 54546978
            }
        ]
    }
}

Chaves "origem" e "destino" (Obrigatório)

As chaves deverão ser informadas com as seguintes subchaves: "modelo", "pasta", "checklist" e "filtros".

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"
    }
}

Exemplo 2:

{
    "modelo": {
        "id": "9999999"
    }
}

Chave "pasta" (Obrigatório)

Deve ser informado o nome da pasta que possui o checklist onde está localizado o arquivo.

{
    "pasta": "Nome da pasta"
}

Chave "checklist" (Obrigatório)

Deve ser informado o nome do checklist onde o arquivo está localizado.

{
    "checklist": "Nome do checklist"
}

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.