Activity catalog

Catalog items of a discipline's professional activities, used to classify activities.

List the discipline's activity catalog

GET /disciplinas/{disciplinaId}/atividades-profissionais

Access: Requires the capability LER over discipline (params.disciplinaId). Success status: 200.

Path parameters

Parameter	Type	Required	Constraints	Description
`disciplinaId`	`string (uuid)`	yes		Discipline id.

Query parameters

Parameter	Type	Required	Constraints	Description
`inativos`	`"true"` \| `"false"`	no	default: `"false"`	`true` also includes inactive records.

Response

AtividadesProfissionais

Field	Type	Required	Constraints	Description
`items`	list of AtividadeProfissionalDto	yes

On error: ErroApi model.

Example

bash

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

Create an item in the discipline catalog

POST /disciplinas/{disciplinaId}/atividades-profissionais

Access: Requires the capability CADASTRAR over discipline (params.disciplinaId). Success status: 201.

Path parameters

Parameter	Type	Required	Constraints	Description
`disciplinaId`	`string (uuid)`	yes		Discipline id.

Request body (AtividadeProfissionalCriar)

Field	Type	Required	Constraints	Description
`nome`	`string`	yes	1–200 characters
`descricao`	`string` or `null`	no	to 2000 characters

Response

AtividadeProfissionalDto

Field	Type	Required	Description
`id`	`string (uuid)`	yes
`disciplinaId`	`string (uuid)`	yes
`nome`	`string`	yes
`descricao`	`string` or `null`	yes
`ativo`	`boolean`	yes
`atividades`	`integer`	yes	How many activities (occurrences) point to the item.

On error: ErroApi model.

Example

bash

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

Update a catalog item

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

Access: Requires the capability CADASTRAR over discipline (params.disciplinaId). Success status: 200.

Path parameters

Parameter	Type	Required	Constraints	Description
`itemId`	`string (uuid)`	yes		Activity catalog item id.
`disciplinaId`	`string (uuid)`	yes		Discipline id.

Request body (AtividadeProfissionalAtualizar)

Field	Type	Required	Constraints
`nome`	`string`	no	1–200 characters
`descricao`	`string` or `null`	no	to 2000 characters
`ativo`	`boolean`	no

Response

AtividadeProfissionalDto

Field	Type	Required	Description
`id`	`string (uuid)`	yes
`disciplinaId`	`string (uuid)`	yes
`nome`	`string`	yes
`descricao`	`string` or `null`	yes
`ativo`	`boolean`	yes
`atividades`	`integer`	yes	How many activities (occurrences) point to the item.

On error: ErroApi model.

Example

bash

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

Merge a catalog item into another

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

Access: Requires the capability CADASTRAR over discipline (params.disciplinaId). Success status: 200.

Path parameters

Parameter	Type	Required	Constraints	Description
`itemId`	`string (uuid)`	yes		Activity catalog item id.
`disciplinaId`	`string (uuid)`	yes		Discipline id.

Request body (AtividadeProfissionalMesclar)

Field	Type	Required	Constraints	Description
`destinoId`	`string (uuid)`	yes

Response

AtividadeProfissionalDto

Field	Type	Required	Description
`id`	`string (uuid)`	yes
`disciplinaId`	`string (uuid)`	yes
`nome`	`string`	yes
`descricao`	`string` or `null`	yes
`ativo`	`boolean`	yes
`atividades`	`integer`	yes	How many activities (occurrences) point to the item.

On error: ErroApi model.

Example

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"}'