academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Task-types [Beta] → Create a new task type

AI-generated

Summary

Create a task type in academyFIVE using the supplied type, labels, link settings, and required color and icon relationships. Optionally assign read and write access groups; the operation sends the values to the API and returns its response as JSON.

Inputs

  • data.type (required) — Task type identifier or value.
  • data.attributes.labelDe (required) — German label.
  • data.attributes.labelEn (required) — English label.
  • data.attributes.isActive — Whether the task type is active; defaults to false when omitted.
  • data.attributes.isProfileLink — Whether the task type links to a profile; defaults to false when omitted.
  • data.attributes.isCourseLink — Whether the task type links to a course; defaults to false when omitted.
  • data.attributes.isExamLink — Whether the task type links to an exam; defaults to false when omitted. The UI description says this requires the new exam list feature flag to be enabled.
  • data.relationships.color.data.type (required) — Type for the related color reference.
  • data.relationships.color.data.id (required) — ID of the color to associate.
  • data.relationships.icon.data.type (required) — Type for the related icon reference.
  • data.relationships.icon.data.id (required) — ID of the icon to associate.
  • data.relationships.readAccessGroups.data — Optional list of access group references, each with a required type and ID, that can read the task type.
  • data.relationships.writeAccessGroups.data — Optional list of access group references, each with a required type and ID, that can write the task type.

Output shape

A single JSON API response item per input item.

The source passes the API response through as JSON and pairs each result with its input item. With Continue On Fail enabled, an item that errors instead returns JSON containing an error message.

Links

Discussion