POST
/
api
/
content
/
trail
/
new_trail
curl --request POST \
  --url https://kong.api.toolzz.com.br/api/content/trail/new_trail \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "trail_title": "<string>",
  "trail_description": "<string>",
  "group": [
    {}
  ],
  "subgroup": [
    {}
  ],
  "specialty": [
    {}
  ],
  "trail_start_date": "<string>",
  "trail_end_date": "<string>",
  "workload": 123,
  "certificate": "<string>",
  "progression_criteria": 123,
  "school": [
    {}
  ],
  "volume": 123,
  "tag": [
    {}
  ],
  "trail_view": 123,
  "available_content": "<string>",
  "available_content_type": {},
  "cover": "<string>",
  "days_to_release": 123,
  "trail_is_exclusive": true,
  "class_ids": {}
}'

Parâmetros

trail_title
string
required

Título da trilha. Deve ter no máximo 255 caracteres.

trail_description
string

Descrição da trilha.

group
array
required

Array de grupos por nome, separados por vírgula.

subgroup
array

Array de subgrupos por nome, separados por vírgula.

specialty
array

Array de especialidades por nome, separados por vírgula.

trail_start_date
date

Data de início da trilha. Deve ser igual ou posterior à data atual.

trail_end_date
date

Data de término da trilha. Deve ser posterior à trail_start_date.

workload
int

Carga horária. Deve ser maior que 0.

certificate
string

Certificado concedido na trilha. Deve ter no máximo 255 caracteres para o nome ou informar o ID do certificado.

progression_criteria
int

Critério de progressão. Deve ser “0” sem critério, “1” sequencial, “2” por período ou “3” por desempenho.

school
array

Subdomínios das escolas onde a trilha será disponibilizada. Array com valores separados por vírgula.

volume
int

Número inteiro que representa o volume. Deve ser entre 1 e 10.

tag
array

Tags separadas por vírgula.

trail_view
int

Número que representa a visualização da trilha. Deve ser “0” para visual padrão ou “1” para visual gamificado.

available_content
string
required

Conteúdos da trilha separados por vírgula. Cada item deve ser o nome ou ID do conteúdo.

available_content_type
array[int]
required

Tipo de conteúdo incluso em available_content, separados por vírgula. Cada item deve ser “0” para tipo curso ou “1” para tipo conteúdo, sendo cada dígito associado de maneira posicional ao seu respectivo conteúdo em available_content. Exemplo: para os conteúdos Curso 01, Conteúdo 01, seus tipos devem ser declarados como 0,1.

cover
string

URL da imagem de capa. Deve ser um dos formatos ‘jpeg’, ‘png’ ou ‘jpg’ e ter no máximo 4096 kb. Caso não seja informado, a logo da instituição será utilizada.

days_to_release
int

Dias para liberar o próximo conteúdo. Obrigatório se progression_criteria for “2”. Deve ser maior que 1.

trail_is_exclusive
boolean

Campo para definir se a trilha é exclusiva.

class_ids
array[int]

Campo para definir as turmas que serão vinculadas à trilha. Caso o campo “trail_is_exclusive” seja verdadeiro e “class_ids” não seja informado, as turmas serão criadas dentro das escolas informadas no campo “school”. Exemplo de uso: “class_ids”: class_id1,class_id2,class_id3

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.