microappdata/row

description

Returns a row of data from a Microapp.

parameters

The X-Auth-Token and X-User-Id are derived from the values authToken and userId returned from the login endpoint and are used in the HTTP header.

Resource

POST /api/microappdata/row
X-Auth-Token: <token goes here>
X-User-Id: <userID goes here>

{
	"rowID":"<insert row id here>"
}

response

A JSON document with the Microapp data.

example

Fetching a single row from a Microapp is achieved by passing in a rowID.

POST /api/microappdata/row
X-Auth-Token: <the authtoken you got back after authentication>
X-User-Id: <the userid you got back after authentication>

{
	"rowID":"cd34d53eddaad4aa55656bb5"
}

linkedtable (crossapp row) field example

If the input Datatable row has a linked table (crossAppRow) field, then the target field information will be returned. Linked table fields create relationships between different tables in your app.

Structure:

crossAppRowID: The _id of the linked row in another table
value: Display information from the linked row
additionalValues: Additional field values from the linked row (optional)

Example Response:

{
    "currentRow": {
        "organizationName": "Acme Corporation",
        "assignedUser": {
            "crossAppRowID": "5ee91f0c8b83524c3dd69dc8",
            "value": {
                "label": "name",
                "value": "John Smith"
            },
            "additionalValues": {
                "b1350a79a78e27a9c0715c95": {
                    "label": "email",
                    "value": "[email protected]"
                }
            }
        },
        "marketplaceListing": {
            "crossAppRowID": "marketplace-listing-id-123",
            "value": {
                "label": "listingName", 
                "value": "AI Customer Support Solution"
            },
            "additionalValues": {
                "field-id-456": {
                    "label": "category",
                    "value": "Customer Service"
                }
            }
        },
        "_id": "cd34d53eddaad4aa55656bb5",
        "userID": "1d88e48c3b08b536dfe0ebdf",
        "viewers": [],
        "isLocked": false,
        "submitted": 1614573289488,
        "deviceID": null,
        "appVersion": null,
        "hasConflict": false,
        "clientCounter": null,
        "clientSubmitted": "2021-03-01 (15:34:49) +1100"
    }
}

Common Use Cases:

Connecting organizations to marketplace listings
Assigning users to projects or tasks
Linking products to categories
Creating many-to-many relationships between data tables