Skip to main content
POST
/
ims
/
case
/
v1p1
/
CFPackages
Upload Package
curl --request POST \
  --url https://api.alpha-1edtech.ai/ims/case/v1p1/CFPackages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CFDocument": {
    "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "uri": "<string>",
    "lastChangeDateTime": "<string>",
    "title": "<string>",
    "creator": "<string>",
    "officialSourceURL": "<string>",
    "publisher": "<string>",
    "description": "<string>",
    "language": "<string>",
    "version": "<string>",
    "caseVersion": "<string>",
    "adoptionStatus": "<string>",
    "statusStartDate": "<string>",
    "statusEndDate": "<string>",
    "licenseUri": "<string>",
    "notes": "<string>",
    "subject": [
      "<string>"
    ],
    "extensions": "<unknown>"
  },
  "CFItems": [
    {
      "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "uri": "<string>",
      "lastChangeDateTime": "<string>",
      "fullStatement": "<string>",
      "alternativeLabel": "<string>",
      "CFItemType": "<string>",
      "cfItemType": "<string>",
      "humanCodingScheme": "<string>",
      "listEnumeration": "<string>",
      "abbreviatedStatement": "<string>",
      "conceptKeywords": [
        "<string>"
      ],
      "notes": "<string>",
      "subject": [
        "<string>"
      ],
      "language": "<string>",
      "educationLevel": [
        "<string>"
      ],
      "CFItemTypeURI": "<unknown>",
      "licenseURI": "<unknown>",
      "statusStartDate": "<string>",
      "statusEndDate": "<string>",
      "extensions": "<unknown>"
    }
  ],
  "CFAssociations": [
    {
      "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "uri": "<string>",
      "lastChangeDateTime": "<string>",
      "associationType": "<string>",
      "originNodeURI": {
        "title": "<string>",
        "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "uri": "<string>"
      },
      "destinationNodeURI": {
        "title": "<string>",
        "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "uri": "<string>"
      },
      "sequenceNumber": 123,
      "extensions": "<unknown>"
    }
  ],
  "CFDefinitions": {
    "CFItemTypes": [
      "<unknown>"
    ],
    "CFSubjects": [
      "<unknown>"
    ],
    "CFConcepts": [
      "<unknown>"
    ],
    "CFLicenses": [
      "<unknown>"
    ],
    "CFAssociationGroupings": [
      "<unknown>"
    ],
    "extensions": "<unknown>"
  },
  "extensions": "<unknown>"
}
'
{
  "success": true,
  "message": "<string>",
  "result": {
    "documentId": "<string>",
    "stats": {
      "documents": 123,
      "items": 123,
      "associations": 123
    },
    "success": true
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
CFDocument
object
required
CFItems
object[]
required
CFAssociations
object[]
required
CFDefinitions
object
extensions
any

Response

CASE Package Upload Result

success
boolean
required
message
string
required
result
object
required