Catálogo de atividades

Itens de catálogo de atividades profissionais de uma disciplina, usados para classificar as atividades.

Lista o catálogo de atividades da disciplina

GET /disciplinas/{disciplinaId}/atividades-profissionais

Acesso: Exige a capacidade LER sobre disciplina (params.disciplinaId). Status de sucesso: 200.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
`disciplinaId`	`string (uuid)`	sim		Id da disciplina.

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
`inativos`	`"true"` \| `"false"`	não	padrão: `"false"`	`true` inclui também os registros inativos.

Resposta

AtividadesProfissionais

Campo	Tipo	Obrigatório	Restrições	Descrição
`items`	lista de AtividadeProfissionalDto	sim

Em caso de erro: modelo ErroApi.

Exemplo

bash

curl -X GET "$API/disciplinas/{disciplinaId}/atividades-profissionais" -H "Authorization: Bearer $TOKEN"

Cria um item no catálogo da disciplina

POST /disciplinas/{disciplinaId}/atividades-profissionais

Acesso: Exige a capacidade CADASTRAR sobre disciplina (params.disciplinaId). Status de sucesso: 201.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
`disciplinaId`	`string (uuid)`	sim		Id da disciplina.

Corpo da requisição (AtividadeProfissionalCriar)

Campo	Tipo	Obrigatório	Restrições	Descrição
`nome`	`string`	sim	1–200 caracteres
`descricao`	`string` ou `nulo`	não	a 2000 caracteres

Resposta

AtividadeProfissionalDto

Campo	Tipo	Obrigatório	Descrição
`id`	`string (uuid)`	sim
`disciplinaId`	`string (uuid)`	sim
`nome`	`string`	sim
`descricao`	`string` ou `nulo`	sim
`ativo`	`boolean`	sim
`atividades`	`integer`	sim	Quantas atividades (ocorrências) apontam para o item.

Em caso de erro: modelo ErroApi.

Exemplo

bash

curl -X POST "$API/disciplinas/{disciplinaId}/atividades-profissionais" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"nome":"texto"}'

Atualiza um item do catálogo

PATCH /disciplinas/{disciplinaId}/atividades-profissionais/{itemId}

Acesso: Exige a capacidade CADASTRAR sobre disciplina (params.disciplinaId). Status de sucesso: 200.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
`itemId`	`string (uuid)`	sim		Id do item do catálogo de atividades.
`disciplinaId`	`string (uuid)`	sim		Id da disciplina.

Corpo da requisição (AtividadeProfissionalAtualizar)

Campo	Tipo	Obrigatório	Restrições
`nome`	`string`	não	1–200 caracteres
`descricao`	`string` ou `nulo`	não	a 2000 caracteres
`ativo`	`boolean`	não

Resposta

AtividadeProfissionalDto

Campo	Tipo	Obrigatório	Descrição
`id`	`string (uuid)`	sim
`disciplinaId`	`string (uuid)`	sim
`nome`	`string`	sim
`descricao`	`string` ou `nulo`	sim
`ativo`	`boolean`	sim
`atividades`	`integer`	sim	Quantas atividades (ocorrências) apontam para o item.

Em caso de erro: modelo ErroApi.

Exemplo

bash

curl -X PATCH "$API/disciplinas/{disciplinaId}/atividades-profissionais/{itemId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'

Mescla um item do catálogo em outro

POST /disciplinas/{disciplinaId}/atividades-profissionais/{itemId}/mesclar

Acesso: Exige a capacidade CADASTRAR sobre disciplina (params.disciplinaId). Status de sucesso: 200.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
`itemId`	`string (uuid)`	sim		Id do item do catálogo de atividades.
`disciplinaId`	`string (uuid)`	sim		Id da disciplina.

Corpo da requisição (AtividadeProfissionalMesclar)

Campo	Tipo	Obrigatório	Restrições	Descrição
`destinoId`	`string (uuid)`	sim

Resposta

AtividadeProfissionalDto

Campo	Tipo	Obrigatório	Descrição
`id`	`string (uuid)`	sim
`disciplinaId`	`string (uuid)`	sim
`nome`	`string`	sim
`descricao`	`string` ou `nulo`	sim
`ativo`	`boolean`	sim
`atividades`	`integer`	sim	Quantas atividades (ocorrências) apontam para o item.

Em caso de erro: modelo ErroApi.

Exemplo

bash

curl -X POST "$API/disciplinas/{disciplinaId}/atividades-profissionais/{itemId}/mesclar" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"destinoId":"0198a000-0000-7000-8000-000000000001"}'