Gadget Data Shapes

This article provides a depiction of the data shape for each gadget within the Kuali Platform. Understanding these data shapes will help you effectively manage and utilize the data collected through your documents and workflows.

• Short Text
• Long Text
• Rich Text
• Checkbox
• Multiple Choice
• Dropdown
• Date
• Time
• Number
• Email
• Link
• Currency
• Language
• State/Province
• Option Range
• Signature
• Table
• Repeater
• Data Lookup (Single Item)
• Data Lookup (List)
• Data Lookup (Multiselect)
• **Credits (STU)

Short Text

• Example: "John Smith"
• Data Shape: String

Long Text

• Example:

  • "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

• Data Shape: String

Rich Text

• Example: "<p>rich text</p>"
• Data Shape: String

Checkbox

• Example:

  • [
      {
        "id": "5rVGs-QE9",
        "label": "option 1 checkbox"
      }
    ]

• Data Shape: Array (of Objects)

Multiple Choice

• Example:

  • {
      "id": "dvfdwVLE5X",
      "label": "option 1 multiple choice"
    }

• Data Shape: Object

Dropdown

• Example:

  • {
      "id": "7o2eI4LCe",
      "label": "option 1 dropdown"
    }

• Data Shape: Object

Date

• Example: 1713744000000
• Data Shape: Number (*Unix Date)

Time

• Example: 61200
• Data Shape: Number

Number

• Example: 3
• Data Shape: Number

Email

• Example: "[e-mail]"
• Data Shape: String

Link

• Example: "https://google.com"
• Data Shape: String

Currency

• Example: 5000
• Data Shape: Number

Image Upload

• Example: 

  • {
      "date": "2024-04-22T19:17:38.591Z",
      "filename": "image (3).png",
      "medium": {
        "contentType": "image/png",
        "filename": "medium-image (3).png",
        "filesize": 60182,
        "height": 488,
        "retrievalId": "b1248511-bbac-441b-a7d9",
        "temporaryUrl": "/app/forms/api/v2/files/6626b74f30b1dde5275dd0d4/-",
        "width": 640
      },
      "original": {
        "contentType": "image/png",
        "filename": "image (3).png",
        "filesize": 111905,
        "height": 877,
        "retrievalId": "a0d0d6c1-91e5-4f1e-b661",
        "temporaryUrl": "/app/forms/api/v2/files/6626b74f30b1dde5275dd0d4/a0d0d6c1",
        "width": 1148
      },
      "thumbnail": {
        "contentType": "image/png",
        "filename": "thumbnail-image (3).png",
        "filesize": 746,
        "retrievalId": "aa5b8e8e-ee5f-4d9e-91f0",
        "temporaryUrl": "/app/forms/api/v2/files/6626b74f30b1dde5275dd0d"
      }
    }

• Data Shape: Object

File Upload

• Example: 

  • {
      "contentType": "text/csv",
      "filename": "Course Report.csv",
      "filesize": 95468,
      "retrievalId": "0e12a279-ee49-4b8c-a7fa-56a58ea",
      "temporaryUrl": "/app/forms/api/v2/files/6626b74f30b1dde5275"
    }

• Data Shape: Object

Country

• Example: "Åland Islands"
• Data Shape: String

Language

• Example: "Spanish"
• Data Shape: String

State/Province

• Example: "American Samoa"
• Data Shape: String

Option Range

• Example: 3
• Data Shape: Number

Signature

• Example:

  • {
      "actionId": "6626b79fa943b870b6ba6ade",
      "contentType": "image/png",
      "date": "2024-04-22T19:18:33.881Z",
      "displayName": "kualiadmin",
      "filename": "signature.png",
      "filesize": 3815,
      "retrievalId": "de0b22a7-fe12-4499-a1ff",
      "signatureType": "draw",
      "signedName": "",
      "temporaryUrl": "/app/forms/api/v2/files/6626b74f30b1dde5275",
      "userId": "612e58e2f1ede72e0017be2b"
    }

• Data Shape: Object

Table

• Example: 

  • [
      {
        "_isFooter": true,
        "_rowId": "2xoD5ZSM4B",
        "emailTable": "",
        "shortTextTable": "super short"
      },
      {
        "_rowId": "t8sF_DOc6G",
        "emailTable": "[e-mail]",
        "shortTextTable": "short"
      },
      {
        "_rowId": "c4hA4jovLg",
        "emailTable": "[e-mail]",
        "shortTextTable": "shorter than the other row"
      }
    ]

• Data Shape: Array (of Objects)

Repeater

• Example:

  • {
      "data": [
        {
          "data": {
            "longTextRepeater": "long text repeater value 1",
            "shortTextRepeater": "st repeater value 1"
            },
         "id": "D9B5T4Nouz"
        },
        {
          "data": {
            "longTextRepeater": "long text repeater value 2",
            "shortTextRepeater": "short text repeater value 2"
          },
          "id": "z1Bdqgo7BL"
        }
      ]
    }

• Data Shape: Object (Gadget data in nested data Array)

Data Lookup (Single Item)

• Example:

  • {
      "data": {
        "error": null,
        "pws": [
            "allotments"
          ]
        },
      "id": "allotments",
      "label": "allotments"
    }

• Data Shape: Object

Data Lookup (List)

• Example:

  • {
      "displayName": "Pete Bins",
      "email": "[e-mail]",
      "id": "5d9bb3670acdb5001958cea3",
      "label": "Pete Bins",
      "schoolId": null,
      "username": "plop"
    }

• Data Shape: Object

Data Lookup (Multiselect)

• Example:

  • [
      {
        "displayName": "Myrl Maggio",
        "email": "[e-mail]",
        "id": "5d9bb3670acdb5001958cea4",
        "label": "Myrl Maggio",
        "schoolId": null,
        "username": null
      },
      {
        "displayName": "Dawn Lowe",
        "email": "[e-mail]",
        "id": "5d9bb367a8d73c0012bb4739",
        "label": "Dawn Lowe",
        "schoolId": null,
        "username": null
      }
    ]

• Data Shape: Array (of Objects)

**Credits (STU)

• Example: 

  • {
      "credits": 5,
      "sortKey": 5,
      "type": "single"
    }

• Data Shape: Object

Note: ** indicates gadgets that only apply to certain Kuali products