Detalhes de uma empresa (/api/admin/user_company)#

Representa uma empresa usuária, que é composta de usuários do sistema e por processos monitorados. Assim como, diversas outras entidades na API também estão atreladas a uma empresa:

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 webhook desta empresa e pode ser usado como forma de autenticação.

created_at

datetime

Este campo terá o valor da data e hora da criação. Campo somente de leitura, preenchido automaticamente na criação

enabled_modules

array de string

Lista de strings com os módulos de acesso da empresa, como por exemplo [“tribproc.localizar”,”proc.acompanhar”]

archived_at

datetime

Caso a empresa seja excluído, este campo terá o valor da data e hora da exclusão. Caso não esteja excluído, o valor é null. Campo somente de leitura

admin_email

string,null

Email do usuário admin da empresa. caso não tenha um usuário admin, o valor é null.

logo_url

string,null

trib_monitor_config

string,null

Dicionário JSON com regras de negócio para monitoramento em tribunais. Quando não informado, copiamos o valor da empresa-mãe. Verifique a tabela abaixo.

url_monitor_config

string,null

Dicionário JSON com regras de negócio para monitoramento de URLs. Quando não informado, copiamos o valor da empresa-mãe. Verifique a tabela abaixo.

protocolo_config

string,null

Dicionário JSON com regras de negócio para protocolização. Quando não informado, copiamos o valor da empresa-mãe. Verifique a tabela abaixo.

name [1]

string

Nome da empresa. Não pode se repetir.

user_company

object

Referência à empresa-mãe à qual o pedido pertence.(“UserCompany”). Campo somente-leitura, preenchido automaticamente na criação.

users

array

Lista de referencias aos usuários da empresa. Para mais informações verifique em user

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

Usuários (users)#

É a lista de usuários associados a esta empresa. Mais detalhes sobre os usuários podem ser encontrados em Usuários.

Nome

Tipo

Descrição

Exemplo

$ref

string

URL relativa na API da entidade referenciada

/api/admin/user/(id: int)

Parâmetro

Tipo

Descrição

Exemplo

$ref

string

URL relativa na API da entidade referenciada

/api/admin/user/1