Create table by selection

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

POST

Path

/qrs/selection/{id}/[type]/table?filter={filter}&skip={skip}&take={take}&sortColumn={sortColumn}&orderAscending={orderAscending}

Description

Add a new table definition from the selection set identified by {id}.

Optionally, include an empty GUID in the API call. Optionally, filter the columns in the table.

Tables are used to list specific properties for entities.

The Name property must not include spaces.

Use [columnType] in the following way:

  • When [columnType] is set to Property, the Definition property must contain the property name.
  • When [columnType] is set to Function, the Definition property must contain the function that produces the column values. Initially, the supported functions only include count([type1], [type2],…).
  • When [columnType] is set to List, the Definition property must contain the list item type and the list property must be specified as a list of columns.

Body

TableDefinition:

{ "id": "00000000-0000-0000-0000-000000000000", "type": "...", "columns": [ { "name": "...", "columnType": Property/Function/List, "definition": "[property name]/[function name]/[list item type]", "list": [ { <columns> } ] }, ... ] }

Return value

ITable:

{ "id": "00000000-0000-0000-0000-000000000000", "type": "...", "columnNames": [ "name1", "name2", ... ], "rows": [ { [ "item1.1", "item1.2", ... ] }, { [ "item2.1", "item2.2", ... ] }, ... ] }

Optional parameters

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?