- Print
Updates a query in a Tulip Table by the query id
Requires the table-queries:write
API key scope.
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/temporary
endpoint 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.
The id of a Tulip Table.
The id of a Tulip Table query.
The updated Tulip Table query. All fields must be set.
The ID of the Tulip Table that the query is being created on.
The display label for the query.
The filters that the query uses.
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.
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.
The static value to compare to. Must be of the same type as the data in the column specified by field
.
The aggregator of all filters defined on the query.
The sorts that will order the records returned by the query.
Sorts are used to order the queries based on columns defined in the Tulip Table where the query exists.
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
The direction of the records, either acsending or descending
The number of records that the query returns.
The Tulip Table query was updated successfully. The details of the updated Table query are returned in the response.
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.
The ID of the Tulip Table that the query exists on.
The name of the Tulip Table Query.
The filters that are applied on this Tulip Table Query.
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.
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.
The static value to compare to. Must be of the same type as the data in the column specified by field
.
The field and sorting direction used to sort the query results
Sorts are used to order the queries based on columns defined in the Tulip Table where the query exists.
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
The direction of the records, either acsending or descending
The number of records that will be returned at most from this Tulip Table query.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
The provided authentication info was rejected. The response will provide additional details.
The requested database entry was not found.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The server encountered an unexpected error.