Skip to main content

Items

Routes​

Get Items​

→ Sample Request

POST /api/items
  ?include[]=objectives
  &include[]=content
  &objectiveAuthorityIds[]=tea
Content-Type: application/json
Authorization: Basic {{appKey}}:{{appSecret}}

{
  "filter": {
    "itemIds": {
      "include": [
        "b842bb5e-9957-403e-bc54-9a054b290158",
        "cdf02148-7888-4e4b-97ff-0003846baa4d",
        "993d673c-5c8d-43aa-99ea-8e417d1300dc",
        "0c4d9608-48da-409e-bfb5-d0d0a019b7e4"
      ]
    }
  }
}

← Sample Response

{
  "items": [
    {
      "id": "0c4d9608-48da-409e-bfb5-d0d0a019b7e4",
      "idInc": "1655",
      "createdAt": "2023-01-07T18:13:29.252Z",
      "updatedAt": "2023-01-07T18:13:29.252Z",
      "name": "Earth is the third largest planet in our solar system, with a diameter at the equator of 12,756 kilo",
      "alignments": [
        {
          "id": "6957472a-20e3-5e8b-8993-1ecf64530ac0",
          "sk": "standard",
          "scope": "tea#teks#ma:2012#3",
          "abbreviation": "3.2.A",
          "content": "compose and decompose numbers up to 100,000 as a sum of so many ten thousands, so many thousands, so many hundreds, so many tens, and so many ones using objects, pictorial models, and numbers, including expanded notation as appropriate;"
        }
      ],
      "workspaceId": "dev-kevin",
      "content": {
        "questions": [
          {
            "id": "oTBcY5tTEox5",
            "interactionType": "choice",
            "keys": [
              {
                "value": "AqPvoKtaHyT0",
                "index": 2
              }
            ],
            "options": [
              {
                "id": "hjacVJJUQnCr",
                "content": "<p>7</p>",
                "isKey": false,
                "index": 0
              },
              {
                "id": "-WAhWra2lHCJ",
                "content": "<p>6</p>",
                "isKey": false,
                "index": 1
              },
              {
                "id": "AqPvoKtaHyT0",
                "content": "<p>1</p>",
                "isKey": true,
                "index": 2
              },
              {
                "id": "MRgfzP3dEiK8",
                "content": "<p>2</p>",
                "isKey": false,
                "index": 3
              }
            ]
          }
        ]
      }
    },
    {
      "id": "67a50a7e-dac0-4181-ac9f-bded600b72a2",
      "sk": "item#v0",
      "name": "Sample Question",
      "idInc": "137",
      "createdAt": "2024-07-20T15:22:31.894Z",
      "updatedAt": "2024-07-20T15:22:31.894Z"
    },
    {
      "id": "ebd9029f-8d13-4447-b55c-8e778b462a34",
      "sk": "item#v0",
      "name": "my item",
      "idInc": "145",
      "createdAt": "2024-09-19T14:58:37.150Z",
      "updatedAt": "2024-09-19T14:58:37.150Z"
    }
  ]
  "nextToken": "WyJpZD1lYmQ5M...",
  "total": 3,
}

Get Items By Tag Value​

→ Sample Request

POST /api/items
  ?include[]=objectives
  &include[]=content
  &objectiveAuthorityIds[]=fdoe
Content-Type: application/json
Authorization: Basic {{appKey}}:{{appSecret}}

{
  "filter": {
    "tags": {
      "include": [{
        "key": "tag-1",
        "type": "string",
        "value": "tag-1-value5"
      }]
    }
  }
}

← Sample Response

{
  "aggregations": null,
  "nextToken": "WyJpZD0yMDhhY2NjNy0xZjM1LTRjODgtOTFhZC05ZTEzZDA0ZjA1OGZ8c2s9aXRlbSN2MCJd",
  "total": 1,
  "items": [
    {
      "id": "208accc7-1f35-4c88-91ad-9e13d04f058f",
      "idInc": "9540",
      "createdAt": "2025-04-08T19:49:24.072Z",
      "updatedAt": "2025-04-08T19:49:24.072Z",
      "name": "Item Created via API 2025-04-08T19:49:18.809Z",
      "alignments": [],
      "workspaceId": "focus1f8-hardeecoun37",
      "content": {
        "questions": [
          {
            "id": "ESepew4fAJ",
            "interactionType": "choice",
            "keys": [
              {
                "value": "d4PoBGmIf",
                "index": 0
              }
            ],
            "options": [
              {
                "id": "d4PoBGmIf",
                "content": "Option 1 (correct)",
                "isKey": true,
                "index": 0
              },
              {
                "id": "VVeS0A7DlI",
                "content": "Option 2",
                "isKey": false,
                "index": 1
              },
              {
                "id": "eQD7c57IXI",
                "content": "Option 3",
                "isKey": false,
                "index": 2
              },
              {
                "id": "66jA62Cgj6",
                "content": "Option 4",
                "isKey": false,
                "index": 3
              }
            ]
          }
        ]
      }
    }
  ]
}

Create Item With Tags​

→ Sample Request

POST /api/item
Content-Type: application/json
Authorization: Basic *****

{
  "title": "Item Created via API {{$datetime iso8601}}",
  "content": {
    "questions": [{
      "type": "choice",
      "prompt": {
        "body": "What is the capital of France?"
      },
      "options": [{
        "text": "Option 1",
        "isKey": false
      }, {
        "text": "Option 2 (Correct)",
        "isKey": true
      }, {
        "text": "Option 3",
        "isKey": false
      }, {
        "text": "Option 4",
        "isKey": false
      }]
    }]
  },
  "tags": [
    {
      "key": "tag-1",
      "type": "string",
      "value": "tag-1-value3"
    },
    {
      "key": "tag-1",
      "type": "string",
      "value": "tag-1-value5"
    }
  ]
}

← Sample Response

{
  "item": {
    "id": "208accc7-1f35-4c88-91ad-9e13d04f058f",
    "sk": "item#v0",
    "name": "Item Created via API 2025-04-08T19:49:18.809Z",
    "createdAt": "2025-04-08T19:49:24.072Z",
    "updatedAt": "2025-04-08T19:49:24.072Z",
    "schemaVersion": "2020-01-01",
    "workspaceId": "focus1f8-hardeecoun37",
    "bankId": "focus1f8-hardeecoun37/content",
    "__typename": "Resource",
    "idInc": 9540,
    "content": {
      "canvas": [
        {
          "id": "ESepew4fAJ",
          "type": "stem",
          "interactionType": "choice",
          "config": {},
          "content": {
            "prompt": {
              "body": "What is the capital of France?"
            },
            "options": [
              {
                "id": "d4PoBGmIf",
                "body": "Option 1 (correct)"
              },
              {
                "id": "VVeS0A7DlI",
                "body": "Option 2"
              },
              {
                "id": "eQD7c57IXI",
                "body": "Option 3"
              },
              {
                "id": "66jA62Cgj6",
                "body": "Option 4"
              }
            ]
          },
          "scoring": {
            "options": {
              "d4PoBGmIf": {
                "isKey": true
              }
            }
          }
        }
      ]
    },
    "tags": [
      {
        "key": "tag-1",
        "type": "string",
        "value": "tag-1-value3"
      },
      {
        "key": "tag-1",
        "type": "string",
        "value": "tag-1-value5"
      }
    ]
  }
}

Update Item​

→ Sample Request

PUT /api/item/:id
Content-Type: application/json
Authorization: Basic *****

{
  "title": "Item Created via API {{$datetime iso8601}}",
  "content": {
    "questions": [{
      "type": "choice",
      "prompt": {
        "body": "What is the capital of France?"
      },
      "options": [{
        "text": "Option 1",
        "isKey": false
      }, {
        "text": "Option 2 (Correct)",
        "isKey": true
      }, {
        "text": "Option 3",
        "isKey": false
      }, {
        "text": "Option 4",
        "isKey": false
      }]
    }]
  }
}

← Sample Response

(Same response as POST response)