Excluindo recursos#

A maioria dos recursos disponibilizados pela API (proc, proc_set, cadastro, monitored_person, user, user_company) possui exclusão lógica. Ou seja, podem ser excluídas e depois recuperadas. Para excluir um recurso, faça uma requisição HTTP DELETE para o endpoint correspondente.

curl -X DELETE 'https://op.digesto.com.br/api/monitoramento/monitored_person/<id>'

Parâmetro

Tipo

Descrição

recurso

string

Nome do recurso a ser deletado.

id

integer

Identificador numérico do recurso a ser excluído.

Exemplo da chamada

cURL

curl -X DELETE 'https://op.digesto.com.br/api/monitoramento/monitored_person/2' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Resposta

HTTP/1.0 204 NO CONTENT

Também é possível listar, filtrar e paginar recursos já excluídos, usando as mesmas operações da seção acima. Para listar todos os recursos excluídos de um tipo, basta fazer um HTTP GET com o sufixo archive.

curl -X GET 'op.digesto.com.br/api/monitoramento/monitored_person/archive/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
  • Irá retornar um JSON com a lista do recurso excluído.

Para desfazer a exclusão, basta um HTTP POST com o conteúdo vazio, para a URL com prefixo archive e sufixo restore no endereço anterior da entidade excluída.

curl -X POST 'https://op.digesto.com.br/api/monitoramento/monitored_person/archive/<id>/restore'

Parâmetro

Tipo

Descrição

recurso

string

Nome do recurso a ser restaurado.

id

integer

Identificador numérico do recurso a ser restaurado.

Exemplo da chamada

cURL

curl -X POST 'https://op.digesto.com.br/api/monitoramento/monitored_person/archive/2/restore' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Resposta

{
    "$uri": "/api/admin/user_company/8",
    "api_name": null,
    "created_at": {
        "$date": 1467718058000
    },
    "enabled_modules": [
        "tribproc.bi",
        "tribproc",
        "cad"
    ],
    "is_archived": false,
    "logo_url": null,
    "name": "legalnote filha",
    "trib_monitor_config": {
        "a": 1
    },
    "user_company": {
        "$ref": "/api/admin/user_company/6"
    },
    "users": []
}