API Reference · Gestão do núcleo
Convenções
As rotas recebem Authorization: Bearer <credencial>. O corpo de erro, a paginação por cursor (cursor; limit de 1 a 200, padrão 50) e os erros transversais seguem as convenções da API Reference da Área de Trabalho. Toda operação pode responder 401 UNAUTHORIZED sem credencial válida e 500 INTERNAL em falha não tratada.
Situação das operações. As operações desta página estão implementadas na API, no ramo development. O documento da ata e da resolução é gerado no próprio Hub, em HTML, a partir de GET /v1/meeting-minutes/{id} e GET /v1/resolutions/{id}; a API não gera nem guarda arquivo desses documentos. A leitura das reuniões, a remarcação, o cancelamento e o adiamento usam as operações da Área de Trabalho, listadas no sitemap. Os núcleos legíveis, os membros e o catálogo de tipos de reunião estão na API Reference da Organização.
Ata — campos de saída
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da ata. |
workItemId | string | Reunião de origem; no máximo uma ata por reunião. |
nucleusId | string | Núcleo responsável pela reunião. |
content | string | Texto da ata. |
agenda | array de strings | Itens da pauta. |
attendees | array | Presentes. |
attendees[].name | string | Nome. |
attendees[].role | string | Papel na reunião. |
absentees | array | Ausentes, com name e role. |
status | draft ou registered | Situação da ata. |
version | number | Versão atual; aumenta a cada salvamento. |
authorUserId | string | Quem criou a ata. |
registeredAt | data-hora ou null | Instante do registro. |
registeredBy | string ou null | Quem registrou. |
createdAt, updatedAt | data-hora | Criação e último salvamento. |
transcriptAvailable | boolean | Em GET /v1/meeting-minutes e GET /v1/meeting-minutes/{id}: true só quando quem lê pode abrir a transcrição e a reunião tem sala do Google Meet e horário; indica que o botão da transcrição aparece, não que a transcrição já exista (nead-hub-api#162). |
Resolução — campos de saída
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da resolução. |
nucleusId | string | Núcleo que resolve. |
number | number | Número na sequência do núcleo no ano; exibido com dois dígitos. |
year | number | Ano do registro. |
ementa | string | Linha curta que resume a decisão. |
considerando | string | O problema que a resolução enfrenta. |
comando | string | A decisão, em parágrafos corridos. |
effectiveFrom | data YYYY-MM-DD | Início de vigência. |
status | vigente, revogada ou cumprida | Situação. |
revokesId | string ou null | Resolução revogada por esta. |
meetingMinutesId | string ou null | Ata de origem. |
authorUserId | string | Quem registrou; é o signatário mostrado no documento da resolução. |
createdAt, updatedAt | data-hora | Registro e última alteração. |
Reunião do núcleo
POST /v1/work-items
Cria um Trabalho, conforme a API Reference da Área de Trabalho. Esta seção descreve os campos da reunião do núcleo.
Autenticação e autorização: as da criação de Trabalho. Com nucleusSigla, exige também a liderança do núcleo indicado (RN-ORGANIZACAO-001); a recusa vem antes de qualquer leitura do núcleo.
Entrada — acréscimo
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Corpo | nucleusSigla | string | Não | Núcleo que agenda. Na mesma transação, o núcleo é designado como responsável (assignee, alvo org_unit). Não é alterável depois. |
| Corpo | meetingKind | ordinaria ou extraordinaria | Não | Só com nucleusSigla e category meeting; ausente vale extraordinaria. |
| Corpo | meetingTypeCode | string | Na ordinária | Tipo do catálogo aplicável ao núcleo; proibido na extraordinária. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 201 | corpo | Trabalho | O Compromisso criado, com a sigla do núcleo em nucleos. O número da reunião é lido em GET /v1/nucleus-meetings. |
Erros — acréscimo
| HTTP | errorCode | Condição |
|---|---|---|
| 403 | FORBIDDEN | nucleusSigla informado por quem não exerce a liderança do núcleo; nada é gravado. |
| 404 | NOT_FOUND | Núcleo sem versão vigente. |
| 422 | RULE_VIOLATION | meetingKind ou meetingTypeCode sem nucleusSigla ou fora da categoria meeting; ordinária sem meetingTypeCode; tipo inexistente ou que o núcleo não agenda; extraordinária com tipo. |
Condições: a criação com nucleusSigla avisa os participantes e os membros ativos do núcleo (RN-GESTAO-004). Na reunião do núcleo, PATCH /v1/work-items/{id} avisa os mesmos destinatários quando muda scheduledAt, location ou meetingUrl ou quando leva a cancelled, e POST /v1/work-items/{id}/postpone também avisa; remarcar, adiar e cancelar são da liderança do núcleo, do Acesso Global ou superior e dos membros dos núcleos da área de Alta Gestão (ALTG: Presidência e Assessoria) (RN-GESTAO-028). Compromisso sem número, inclusive o que recebe um núcleo designado depois, não avisa o núcleo. Na categoria meeting, a criação gera o número da reunião na mesma transação.
GET /v1/nucleus-meetings
Lista as reuniões numeradas de um núcleo.
Autenticação e autorização: quem pode ver o núcleo (RN-ORGANIZACAO-002).
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Query | nucleusSigla | string, 2 a 16 letras ou dígitos | Sim | Núcleo. |
| Query | workItemId | UUID | Não | Só a reunião deste Compromisso. |
| Query | cursor | string | Não | Cursor da página anterior. |
| Query | limit | número de 1 a 200, padrão 50 | Sim | Tamanho da página. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | items[].id | string | Identificador do número da reunião. |
| 200 | items[].workItemId | string | O Compromisso da reunião. |
| 200 | items[].nucleusSigla | string | Sigla do núcleo. |
| 200 | items[].kind | ordinaria ou extraordinaria | Natureza. |
| 200 | items[].typeCode | string ou null | Tipo do catálogo; null na extraordinária. |
| 200 | items[].typeName | string ou null | Nome do tipo; null na extraordinária. |
| 200 | items[].number | number | Número na série. |
| 200 | items[].year | number | Ano da data marcada. |
| 200 | items[].code | string | Número NN/AAAA-SÉRIE, que é também o da ata. |
| 200 | items[].createdAt | data-hora | Criação. |
| 200 | nextCursor | string ou null | Cursor da próxima página. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Filtro fora do contrato ou cursor ilegível. |
| 404 | NOT_FOUND | Núcleo inexistente ou fora do alcance. |
Ata
POST /v1/meeting-minutes
Abre a ata de uma reunião do núcleo, em rascunho.
Autenticação e autorização: participante da reunião ou liderança do núcleo (RN-GESTAO-006).
Entrada — JSON
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Corpo | workItemId | UUID | Sim | Reunião do núcleo. |
| Corpo | content | string | Não | Texto inicial; um parágrafo por deliberação. |
| Corpo | agenda | array de strings | Não | Itens da pauta. |
| Corpo | attendees | array de {name, role} | Não | Presentes; name e role de 1 a 255 caracteres. |
| Corpo | absentees | array de {name, role} | Não | Ausentes; mesmas regras. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 201 | corpo | Ata | A ata criada, em draft. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Corpo fora do contrato. |
| 403 | FORBIDDEN | Quem cria não é participante da reunião nem liderança do núcleo. |
| 404 | NOT_FOUND | Reunião inexistente ou fora do alcance. |
| 409 | CONFLICT | A reunião já tem ata (RN-GESTAO-020). |
| 422 | RULE_VIOLATION | O Compromisso não é reunião ou não tem núcleo designado. |
GET /v1/meeting-minutes
Lista a ata de uma reunião; a página tem no máximo um item.
Autenticação e autorização: quem alcança a reunião (RN-GESTAO-022).
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Query | workItemId | UUID | Sim | Reunião de origem. |
| Query | cursor | string | Não | Cursor da página anterior. |
| Query | limit | número de 1 a 200, padrão 50 | Sim | Tamanho da página. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | items | array de Ata | Ata da reunião. |
| 200 | nextCursor | string ou null | Cursor da próxima página. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | workItemId ausente ou cursor ilegível. |
| 404 | NOT_FOUND | Reunião inexistente ou fora do alcance. |
GET /v1/meeting-minutes/{id}
Consulta uma ata com a versão atual.
Autenticação e autorização: quem alcança a reunião.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | UUID | Sim | Ata. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | corpo | Ata | A ata, com version atual. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Identificador inválido. |
| 404 | NOT_FOUND | Ata inexistente ou reunião fora do alcance. |
PATCH /v1/meeting-minutes/{id}
Salva a ata em rascunho, informando a versão lida. Esta operação é substituída pela edição simultânea (RN-GESTAO-043) quando o canal existir.
Autenticação e autorização: participante da reunião ou liderança do núcleo.
Entrada — JSON
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | UUID | Sim | Ata. |
| Corpo | content | string | Sim | Texto da ata. |
| Corpo | expectedVersion | inteiro, mínimo 1 | Sim | Versão lida antes da edição. |
| Corpo | agenda | array de strings | Não | Substitui a pauta. |
| Corpo | attendees | array de {name, role} | Não | Substitui os presentes. |
| Corpo | absentees | array de {name, role} | Não | Substitui os ausentes. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | corpo | Ata | A ata salva, com a nova version. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Identificador inválido ou corpo fora do contrato. |
| 403 | FORBIDDEN | Quem salva não é participante da reunião nem liderança do núcleo. |
| 404 | NOT_FOUND | Ata inexistente ou reunião fora do alcance. |
| 409 | CONFLICT | Outra pessoa já salvou uma versão mais nova. Contrato vigente até existir o canal de edição simultânea; a RN-GESTAO-043 substitui a RN-GESTAO-007. |
| 422 | RULE_VIOLATION | Ata registrada é só leitura. |
POST /v1/meeting-minutes/{id}/register
Registra a ata; daí em diante ela é só leitura e aparece nos documentos do núcleo.
Autenticação e autorização: liderança do núcleo (RN-GESTAO-008).
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | UUID | Sim | Ata em rascunho. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | corpo | Ata | A ata em registered. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Identificador inválido. |
| 403 | FORBIDDEN | Quem registra não exerce a liderança do núcleo. |
| 404 | NOT_FOUND | Ata inexistente ou reunião fora do alcance. |
| 422 | RULE_VIOLATION | Ata já registrada. |
Resolução
POST /v1/resolutions
Registra a resolução com o número seguinte do núcleo no ano do registro; ela passa a aparecer nos documentos do núcleo.
Autenticação e autorização: liderança do núcleo (RN-GESTAO-014).
Entrada — JSON
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Corpo | nucleusSigla | string | Sim | Núcleo que resolve. |
| Corpo | ementa | string, 1 a 160 caracteres | Sim | Linha curta que resume a decisão. |
| Corpo | considerando | string, mínimo 1 caractere | Sim | O problema, em um ou mais parágrafos. |
| Corpo | comando | string, mínimo 1 caractere | Sim | A decisão em parágrafos corridos, sem dispositivos numerados. |
| Corpo | effectiveFrom | data YYYY-MM-DD | Não | Início de vigência; ausente, a data do registro no fuso do escritório. |
| Corpo | revokesId | UUID | Não | Resolução vigente do mesmo núcleo que esta revoga (RN-GESTAO-013). |
| Corpo | meetingMinutesId | UUID | Não | Ata registrada do mesmo núcleo de que a resolução nasceu. |
O signatário não é campo de entrada: o documento da resolução mostra quem registra, com a função “Liderança do Núcleo <nome do núcleo>”.
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 201 | corpo | Resolução | A resolução em vigente, com number e year. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Corpo fora do contrato. |
| 403 | FORBIDDEN | Quem registra não exerce a liderança do núcleo. |
| 404 | NOT_FOUND | Núcleo inexistente. |
| 422 | RULE_VIOLATION | Resolução indicada em revokesId não vigente ou de outro núcleo; ata de origem de outro núcleo ou não registrada. |
GET /v1/resolutions
Lista as resoluções de um núcleo.
Autenticação e autorização: quem pode ver o núcleo.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Query | nucleusSigla | string, 2 a 16 letras ou dígitos | Sim | Núcleo. |
| Query | status | vigente, revogada ou cumprida | Não | Filtra pela situação. |
| Query | q | string, até 200 caracteres | Não | Trecho procurado na ementa, no considerando ou no comando, sem distinguir maiúsculas. |
| Query | cursor | string | Não | Cursor da página anterior. |
| Query | limit | número de 1 a 200, padrão 50 | Sim | Tamanho da página. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | items | array de Resolução | Resoluções do núcleo. |
| 200 | nextCursor | string ou null | Cursor da próxima página. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Filtro fora do contrato ou cursor ilegível. |
| 404 | NOT_FOUND | Núcleo inexistente ou fora do alcance. |
GET /v1/resolutions/{id}
Consulta uma resolução.
Autenticação e autorização: quem pode ver o núcleo da resolução.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | UUID | Sim | Resolução. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | corpo | Resolução | A resolução. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Identificador inválido. |
| 404 | NOT_FOUND | Resolução inexistente ou fora do alcance. |
POST /v1/resolutions/{id}/revoke
Revoga a resolução vigente.
Autenticação e autorização: liderança do núcleo.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | UUID | Sim | Resolução. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | corpo | Resolução | A resolução em revogada. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Identificador inválido. |
| 403 | FORBIDDEN | Quem revoga não exerce a liderança do núcleo. |
| 404 | NOT_FOUND | Resolução inexistente ou fora do alcance. |
| 422 | RULE_VIOLATION | Resolução não está vigente. |
POST /v1/resolutions/{id}/fulfill
Marca a resolução vigente como cumprida.
Autenticação e autorização: liderança do núcleo.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | UUID | Sim | Resolução. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | corpo | Resolução | A resolução em cumprida. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | VALIDATION_FAILED | Identificador inválido. |
| 403 | FORBIDDEN | Quem marca não exerce a liderança do núcleo. |
| 404 | NOT_FOUND | Resolução inexistente ou fora do alcance. |
| 422 | RULE_VIOLATION | Resolução não está vigente. |
Reunião fora do núcleo
As operações desta seção estão em development (nead-hub-api#163). Remarcar, adiar e cancelar a reunião fora do núcleo usam PATCH /v1/work-items/{id} e POST /v1/work-items/{id}/postpone, da Área de Trabalho, restritos à Alta Gestão e ao Acesso Global (RN-GESTAO-031).
Tipo de reunião — campos acrescentados em GET /v1/meeting-types
| Campo | Tipo | Descrição |
|---|---|---|
displayName | string | Nome de exibição; o código nunca aparece na tela (RN-GESTAO-023). |
pages | array | Páginas em que a reunião aparece (RN-GESTAO-032). |
pages[].page | nucleus, area ou presidency | Página. |
pages[].siglas | array de strings ou null | Núcleos ou áreas que exibem o tipo; null para qualquer um. Na Conversa individual com a Presidência, o núcleo é o indicado no agendamento. |
audience | nucleus, everyone, leaders, participants_and_high_management ou participants | Quem vê a reunião além do dono e dos participantes. |
confidentialByDefault | boolean | A reunião nasce sigilosa (RN-GESTAO-036). |
hasMinutes | boolean | false quando a reunião não tem ata (RN-GESTAO-035). |
requiresNucleus | boolean | O agendamento exige nucleusSigla (Conversa individual com a Presidência). |
Na ata (GET /v1/meeting-minutes/{id}), nucleusId passa a aceitar null, valor da ata de reunião fora do núcleo.
POST /v1/institutional-meetings
Agenda a reunião fora do núcleo com o número seguinte do tipo no ano (RN-GESTAO-037) e liga os participantes do catálogo (RN-GESTAO-039).
Autenticação e autorização: membros dos núcleos da área de Alta Gestão (ALTG: PRES e AESP) e Acesso Global (RN-GESTAO-031).
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Corpo | typeCode | string, 2 a 16 letras ou dígitos | Sim | Tipo do catálogo que não é ordinário do núcleo. |
| Corpo | title | string, 1 a 255 caracteres | Sim | Título da reunião. |
| Corpo | nucleusSigla | string, 2 a 16 letras ou dígitos | Na Conversa individual com a Presidência | Núcleo cuja liderança participa; proibido nos demais tipos. |
| Corpo | notifyUserIds | array de UUID | Não | Usuários avisados ao agendar, remarcar, adiar e cancelar; cada um precisa poder ver a reunião (RN-GESTAO-038). |
| Corpo | confidential | boolean | Não | Sigilo da reunião. |
| Corpo | scheduledAt | data-hora | Não | Hora marcada. |
| Corpo | durationMin | número, mínimo 1 | Não | Duração prevista, em minutos. |
| Corpo | location | string, até 255 caracteres | Não | Local. |
| Corpo | meetingFormat | in_person, remote ou hybrid | Não | Formato do encontro. |
| Corpo | meetingUrl | string, até 300 caracteres | Não | Endereço do encontro remoto. |
| Corpo | body | string | Não | Pauta. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 201 | corpo | Reunião fora do núcleo | A reunião agendada, com os campos descritos em GET /v1/institutional-meetings. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | Pendente | Corpo fora do contrato. |
| 403 | Pendente | Quem agenda não é da Alta Gestão nem tem Acesso Global. |
| 404 | Pendente | Núcleo indicado inexistente. |
| 422 | Pendente | Tipo inexistente ou ordinário do núcleo; nucleusSigla faltando ou indevido; usuário avisado que não pode ver a reunião. |
GET /v1/institutional-meetings
Lista as reuniões que o catálogo destina à página e que quem consulta pode ver (RN-GESTAO-032).
Autenticação e autorização: qualquer identidade autenticada; cada reunião aparece só para quem pode vê-la (RN-GESTAO-029 e RN-GESTAO-036).
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Query | page | nucleus, area ou presidency | Sim | Página que lista as reuniões. |
| Query | sigla | string, 2 a 16 letras ou dígitos | Na página do núcleo e na da área | Sigla do núcleo ou da área; ignorada na Presidência. |
| Query | workItemId | UUID | Não | Só a reunião deste Compromisso. |
| Query | cursor | string | Não | Cursor da página anterior. |
| Query | limit | número de 1 a 200, padrão 50 | Sim | Tamanho da página. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | items[].id | string | Identificador da reunião fora do núcleo. |
| 200 | items[].workItemId | string | O Compromisso da reunião; detalhes em GET /v1/work-items/{id}. |
| 200 | items[].typeCode | string | Código do tipo; só na API. |
| 200 | items[].typeName | string | Nome de exibição do tipo. |
| 200 | items[].number | number | Número na sequência do tipo no ano. |
| 200 | items[].year | number | Ano. |
| 200 | items[].code | string | Número NN/AAAA-TIPO; a tela mostra só “Ata NN/AAAA”. |
| 200 | items[].nucleusSigla | string ou null | Núcleo indicado no agendamento (Conversa individual com a Presidência). |
| 200 | items[].confidential | boolean | Sigilo. |
| 200 | items[].hasMinutes | boolean | false quando o tipo não tem ata. |
| 200 | items[].title | string | Título. |
| 200 | items[].scheduledAt | data-hora ou null | Hora marcada. |
| 200 | items[].status | pending, in_progress, completed, cancelled, postponed, no_show ou overdue | Situação do Compromisso; overdue é derivado da hora marcada. |
| 200 | items[].createdAt | data-hora | Criação. |
| 200 | nextCursor | string ou null | Cursor da próxima página. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | Pendente | Filtro fora do contrato ou cursor ilegível. |
| 404 | Pendente | Núcleo inexistente ou fora do alcance. |
Transcrição
GET /v1/meeting-minutes/{id}/transcript
Espelha, na janela da ata, a transcrição do Google Meet da reunião (RN-GESTAO-033). A operação e o campo transcriptAvailable estão em development (nead-hub-api#162, com a folga de 15 minutos e a recusa de reuniões sobrepostas em #166). Quando duas reuniões da mesma sala se sobrepõem, nenhuma recebe a transcrição e o Meet não é consultado. A leitura real da transcrição depende de rota nova no serviço do Meet (lsa-messenger).
Autenticação e autorização: a liderança do núcleo e a Alta Gestão; na reunião sigilosa, só os participantes. Sem permissão, a resposta é 404.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | id | string | Sim | Ata da reunião. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | minuteId | UUID | Ata. |
| 200 | workItemId | UUID | Compromisso da reunião. |
| 200 | transcript | objeto ou null | A transcrição como o Meet a devolve, com a situação em estado; null quando a reunião não tem sala do Google Meet ou horário marcado, ou quando nenhuma conferência da sala começou entre 15 minutos antes do início marcado e o fim previsto (início somado à duração; sem duração informada, 1 hora). A conferência ligada vale inteira, mesmo depois do fim previsto, enquanto houver alguém na sala. Os demais campos internos seguem o Meet. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | Pendente | Identificador inválido ou resposta recusada pelo Meet. |
| 404 | Pendente | Ata inexistente, reunião fora do alcance ou transcrição não liberada a quem pede. |
| 502 | Pendente | Resposta inválida ou falha no Meet. |
| 503 | Pendente | Meet desabilitado ou não configurado. |
| 504 | Pendente | O Meet não respondeu a tempo. |
Histórico do núcleo
GET /v1/history/{resourceType}/{resourceId}
Devolve a linha do tempo de um recurso. O feed do núcleo (RN-GESTAO-034) usa resourceType igual a nucleus. O serviço de histórico é compartilhado; os campos de cada entrada estão na API Reference da Área de Trabalho. A leitura do núcleo, o parâmetro orderDir e os tipos do feed estão em development (nead-hub-api#161 e #165). As reuniões do núcleo e os documentos anexados ao núcleo entram no feed; as reuniões fora do núcleo não entram.
Autenticação e autorização: quem pode ver o núcleo (RN-ORGANIZACAO-002), sem os eventos de reuniões sigilosas.
Entrada
| Local | Campo | Tipo | Obrigatório | Condição |
|---|---|---|---|---|
| Caminho | resourceType | string | Sim | nucleus. |
| Caminho | resourceId | string | Sim | Identificador do núcleo. |
| Query | orderDir | asc ou desc, padrão asc | Não | desc lista do mais recente ao mais antigo, ordem do feed do núcleo. |
| Query | resourceType | work-item, meeting-minutes, resolution, document ou nucleus | Não | Filtro por tipo do feed: reuniões, atas, resoluções, documentos e composição. |
| Query | cursor | string | Não | Cursor da página anterior. |
| Query | limit | número de 1 a 200, padrão 50 | Sim | Tamanho da página. |
Saída
| HTTP | Campo | Tipo | Descrição |
|---|---|---|---|
| 200 | items[] | array de entradas do histórico | Entradas da linha do tempo. |
| 200 | nextCursor | string ou null | Cursor da próxima página. |
Erros
| HTTP | errorCode | Condição |
|---|---|---|
| 400 | Pendente | Identificador, filtro, cursor ou limit inválido. |
| 404 | Pendente | Recurso inexistente ou fora do escopo de quem consulta. |
Operações a criar
| Necessidade | Situação |
|---|---|
| Autorizar a abertura da Página da Presidência e da Página da Área (RN-GESTAO-041 e RN-GESTAO-042) | A criar (nead-hub-api#154). As páginas usam GET /v1/me/nuclei, GET /v1/organization/areas, GET /v1/organization/nuclei, GET /v1/institutional-meetings, GET /v1/nucleus-meetings e GET /v1/resolutions. |
| Leitura consolidada de reuniões, resoluções e atas de vários núcleos | A criar (nead-hub-api#154). |
| Canal de edição simultânea e de presença da ata (RN-GESTAO-043 a RN-GESTAO-045) | A criar (nead-hub-api#156). |