List draft containers awaiting attachment

GET

/institution/catalogue/structures/drafts

GET

/institution-api/institution/catalogue/structures/drafts

curl https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/drafts \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "id": "string",
  "title": "string",
  "description": "string",
  "creditPoints": 1,
  "creditPointsMax": 1,
  "dynamicRules": [
    {}
  ],
  "items": [
    {
      "id": "string",
      "itemType": "string",
      "code": "string",
      "year": 1,
      "name": "string",
      "uoc": 1,
      "resolved": true
    }
  ],
  "children": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "creditPoints": 1,
      "creditPointsMax": 1,
      "dynamicRules": [
        {}
      ],
      "items": [
        {
          "id": "string",
          "itemType": "string",
          "code": "string",
          "year": 1,
          "name": "string",
          "uoc": 1,
          "resolved": true
        }
      ],
      "children": [
        null
      ]
    }
  ]
}

Every draft root this institution has, meaning containers with no owner and no parent, each with its entries and child containers. Drafts are only reachable by id otherwise, so this is how you find work in progress you built earlier and haven't attached yet.

Authentication

AuthorizationBearer

Paste a Keycloak access token (no "Bearer " prefix)

Response

The institution's draft roots, each with its entries and child containers.

idstringOptionalformat: "uuid"

Use this as structureId when adding or removing a subject.

titlestringOptional

descriptionstringOptional

The handbook's requirement sentence, e.g. "Students must take 30 UOC of the following subjects."

creditPointsintegerOptional

UOC that must be taken from this container.

creditPointsMaxintegerOptional

dynamicRuleslist of maps from strings to anyOptional

The handbook's wildcard requirements ("any General Education subject"), for display only, since nothing evaluates these.

itemslist of objectsOptional

childrenlist of objectsOptional