Create a Tulip Table Query
- 01 Oct 2024
- 5 Minutes to read
- Contributors
- Print
Create a Tulip Table Query
- Updated on 01 Oct 2024
- 5 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/tables/{tableId}/queries
Create a Tulip Table Query in specified Table.
Requires the table-queries:write API key scope.
Security
HTTP
Type basic
A Tulip API key is required to use the Tulip API. API key authentication uses HTTP Basic Authentication as defined by RFC 7617. HTTP Basic Authentication uses a generic username/password scheme to authenticate. For Tulip API requests, the password should be the API key's associated secret. The username should have the format {type}.{version}_{id}, where {type} is the API key type, {version} is the type's version number, and {id} is the id of the key. Tulip API keys currently are one of two types:
apikey.2- user API keys provisioned by creating a Tulip API Token. The key id is the token id.onetime.1- temporary API keys provisioned using the/auth/temporaryendpoint or using the One-Time API Key page. These keys are only valid for 30 seconds after provisioning.
Once you have determined the username and password you need to use, the Authorization header should be set to the value Basic {credentials}, where {credentials} is the base64-encoded value of the string {username}:{password}. See RFC 7617 for more details of this encoding.
Path parameters
tableId
stringRequired
The id of a Tulip Table.
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
Body parameters
The Tulip Table query. All fields must be set.
object
tableId
string Required
The ID of the Tulip Table that the query is being created on.
label
string Required
The display label for the query.
Min length1
Max length255
filters
Array of object (TulipTableFilter)
The filters that the query uses.
Max length100
object
The filters can use any of the columns defined in the Tulip Table (including _createdAt and _updatedAt) that the query exists on with any of the functions.
Example{ "_id": "abcdefg", "field": "Color", "functionType": "equal", "value": { "datasourceType": "static", "params": { "value": "yellow" } } }
_id
string Required
field
string Required
functionType
string Required
Valid values[ "equal", "notEqual", "blank", "notBlank", "greaterThanOrEqual", "lessThanOrEqual", "greaterThan", "lessThan", "contains", "notContains", "startsWith", "notStartsWith", "endsWith", "notEndsWith", "isIn", "notIsIn" ]
value
object
The value to compare to.
If datasourceType is set to "app-info", then params is not required.
If datasourceType is set to "static", then params is required.
datasourceType
string Required
Valid values[ "static", "app-info" ]
params
object
value
The static value to compare to. Must be of the same type as the data in the column specified by field.
filterAggregator
string
The aggregator of all filters defined on the query.
sortOptions
Array of object (TulipTableSortOption)
The sorts that will order the records returned by the query.
Max length100
object
Sorts are used to order the queries based on columns defined in the Tulip Table where the query exists.
Example{ "sortBy": "Color", "sortDir": "asc" }
sortBy
string Required
The field that records should be sorted by in the response. Can be the name of any of the columns of the Table (including id) or one of these special values:
_sequenceNumber_createdAt_updatedAt
sortDir
string Required
The direction of the records, either acsending or descending
Valid values[ "asc", "desc" ]
Default"asc"
limit
number Required
The number of records that the query returns.
Minimum1
Maximum1000
Default1000
Responses
201
The Tulip Table query was created successfully. The details of the created Table query are returned in the response.
object
A Tulip Table query that exists on a Tulip Table. The record object will include all the fields of the query, addition to the record's created timestamp and last updated timestamp.
Example{ "id": "PRYGkKgnqySMcpWwr", "createdAt": "2019-01-15T05:30:01Z", "createdBy": "N24uug8iXSTWR39rB", "updatedAt": "2019-01-15T05:31:20Z", "updatedBy": "N24uug8iXSTWR39rB", "tableId": "b93Aj93KlIoaw", "label": "Basic Query", "filters": [ { "_id": "aidv93mise9", "field": "Color", "functionType": "equal", "value": { "datasourceType": "static", "params": { "value": "yellow" } } }, { "_id": "jfsa093m9ds", "field": "ID", "functionType": "notEqual", "value": { "datasourceType": "static", "params": { "value": "a" } } } ], "filterAggregator": "all", "sortOptions": [ { "sortBy": "Color", "sortDir": "asc" } ], "limit": 1000.0 }
_createdAt
string (date-time)
_updatedAt
string (date-time)
tableId
string
The ID of the Tulip Table that the query exists on.
label
string
The name of the Tulip Table Query.
filters
Array of object (TulipTableFilter)
The filters that are applied on this Tulip Table Query.
object
The filters can use any of the columns defined in the Tulip Table (including _createdAt and _updatedAt) that the query exists on with any of the functions.
Example{ "_id": "abcdefg", "field": "Color", "functionType": "equal", "value": { "datasourceType": "static", "params": { "value": "yellow" } } }
_id
string
field
string
functionType
string
Valid values[ "equal", "notEqual", "blank", "notBlank", "greaterThanOrEqual", "lessThanOrEqual", "greaterThan", "lessThan", "contains", "notContains", "startsWith", "notStartsWith", "endsWith", "notEndsWith", "isIn", "notIsIn" ]
value
object
The value to compare to.
If datasourceType is set to "app-info", then params is not required.
If datasourceType is set to "static", then params is required.
datasourceType
string
Valid values[ "static", "app-info" ]
params
object
value
The static value to compare to. Must be of the same type as the data in the column specified by field.
filterAggregator
sortOptions
Array of object (TulipTableSortOption)
The field and sorting direction used to sort the query results
object
Sorts are used to order the queries based on columns defined in the Tulip Table where the query exists.
Example{ "sortBy": "Color", "sortDir": "asc" }
sortBy
string
The field that records should be sorted by in the response. Can be the name of any of the columns of the Table (including id) or one of these special values:
_sequenceNumber_createdAt_updatedAt
sortDir
string
The direction of the records, either acsending or descending
Valid values[ "asc", "desc" ]
Default"asc"
limit
number
The number of records that will be returned at most from this Tulip Table query.
400
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
401
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "AuthenticationRequired" ]
403
The provided authentication info was rejected. The response will provide additional details.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "AuthenticationFailed" ]
404
The requested database entry was not found.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "NoSuchDatabaseEntry" ]
422
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
500
The server encountered an unexpected error.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
Was this article helpful?
