academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Curriculum-entries [Beta] → Create a curriculum entry

AI-generated

Summary

Create a curriculum entry by submitting its type, required attributes, study-program relationship, and parent entry; optionally include further relationships and a site context.

Inputs

  • data (required) — Set the entry type and attributes. Attributes require a type (1 for Module or 5 for Elective module), abbreviation, and German, English, Spanish, and French labels. Optional attributes include position (defaults to the last position if omitted), term of study, German and English comments, and minimum and maximum credits.
  • relationships.studyProgram (required) — Provide the study-program relationship data, including its type and study-program ID.
  • relationships.parent (required) — Provide the parent curriculum entry relationship data, including its type and parent entry ID.
  • relationships.moduleVersion — For an entry with attributes.type 1 (Module), provide the module version relationship data, including its type and module version ID. The source describes this relationship as required for modules; the UI marks it optional.
  • relationships.version — Optionally provide a curriculum version relationship, including its type and curriculum version ID.
  • relationships.cohort — Optionally provide a cohort relationship, including its type and cohort ID.
  • relationships.areas — Optionally provide one or more area relationship records, each with a type and ID.
  • relationships.category — Optionally provide a category relationship, including its type and parent study-program category ID.
  • additionalFields.current-site-id — Optionally set the current site context identifier as a query parameter.

Output shape

A list of JSON items from the API response, paired with their input items.

With Continue On Fail enabled, a failed input produces an item containing an error message. The response body determines the returned JSON item shape.

Links

Discussion