Detalhes de uma empresa (/api/user_company
)¶
Representa uma empresa usuária do Digesto Operações. Uma empresa é composta de usuários do sistema e por processos monitorados.
Diversas outras entidades na API também estão atreladas a uma user_company:
- schemas/proc
- schemas/proc_set
- schemas/cadastro
- schemas/monitored_person
- schemas/monitored_event
- schemas/user
Inclusive uma user_company
pode ser atrelada à user_company
mãe dela.
Uma user_company
é representada por um dicionário JSON com os seguintes campos:
Nome | Tipo | Descrição |
---|---|---|
$uri | string | |
api_name | string,null | Campo livre de até 150 caracteres. Quando fornecido, este texto é enviado em todas as chamadas web-hook desta empresa. Pode ser usado como forma de autenticação. |
created_at | object,null | |
enabled_modules | array<string> | |
archived_at | datetime | Se foi excluido (nullable=True). Caso entidade tenha sido excluída, este campo tem o
valor da datahora da última exclusão. Caso não esteja excluído, o valor é null .
Campo somente-leitura. |
admin_email | string,null | |
logo_url | string,null | |
trib_monitor_config | string,null | Dicionário JSON com regras de negócio para monitoramento em tribunais. Ver tabela abaixo. Quando não informado, copiamos o valor da empresa-mãe. |
url_monitor_config | string,null | Dicionário JSON com regras de negócio para monitoramento de URLs. Ver tabela abaixo. Quando não informado, copiamos o valor da empresa-mãe. |
protocolo_config | string,null | Dicionário JSON com regras de negócio para protocolização. Ver tabela abaixo. Quando não informado, copiamos o valor da empresa-mãe. |
name [1] | string | Nome da empresa. Não pode se repetir. |
user_company | object | Referência à empresa à qual o pedido pertence. (“UserCompany”). Campo somente-leitura, preenchido automaticamente na criação. |
users | array | Lista de referencias aos usuários da empresa. |
[1] | Obrigatório na criação de entidades. |
trib_monitor_config¶
Dicionário JSON com regras de negócio para monitoramento de processos e partes.
Nome | Tipo | Descrição |
---|---|---|
create_cadastro_on_distrib | boolean | Cria cadastro agendado para cada nova distribuição |
create_event_on_distrib | boolean | Cria evento para cada nova distribuição |
create_event_on_movs | boolean | Cria evento para cada nova movimentação nos processos |
create_event_on_publ | boolean | Cria evento para cada nova publicação nos processos |
all_movs_on_first_day | boolean | Ao cadastrar um novo processo, o primeiro evento gerado possui todos os movimentos conhecidos do processo. No dia seguinte passamos a enviar só os novos movimentos. Default = false. |
url_monitor_config¶
Dicionário JSON com regras de negócio para monitoramento de processos e partes.
Nome | Tipo | Descrição |
---|---|---|
send_emails | boolean | Envia email apos mudanças detectadas em URLs monitoradas |
dest_emails | array | Lista de strings com endereços de emails |
dest_emails_bcc | array | Lista de strings com endereços de emails (cópia oculta) |
protocolo_config¶
Dicionário JSON com regras de negócio para monitoramento de processos e partes.
Nome | Tipo | Descrição |
---|---|---|
protocolo_publish_finished_to | array | Lista de e-mails avisados após cada protocolação |
protocolo_publish_finished_bcc | array | Lista de e-mails avisados em BCC |
users¶
É a lista de usuários associados a esta empresa.
Nome | Tipo | Descrição | Exemplo |
---|---|---|---|
$ref | string | URL relativa na API da entidade referenciada | /api/user/3 |