Search
POST/api
Search entities with the same query language used in Query operation. Allows providing additional filter conditions such as context or object type.
Request
Header Parameters
Ftrack-Api-Options any
Api options formatted as key value pairs separated by semicolon.
Suported values are:
- denormalize
- strict
denormalize - data is not normalised before sent to client which means there is no need to merge entities client side.
Must also have strict option enabled.
strict - only requested data is loaded and returned to the client
Examples:
denormalize=1;strict=1
denormalize=False;strict=True
denormalize=false;strict=false
Ftrack-Api-Key any
API key used to authenticate. API keys are created from Settings under the page API keys.
Ftrack-User any
Username used to authenticate.
- application/json
Body
array
required
Array [
- MOD2
- MOD3
- MOD2
Array [
]
]
action Actionrequired
Possible values: [search
]
expression Expressionrequired
terms string[]required
entity_type Entity Typerequired
context_id
object
nullable
anyOf
boolean
string
object_type_ids
object
nullable
anyOf
string
metadata
object
property name* any
Responses
- 200
- 422
Successful Response
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Messagerequired
type Error Typerequired
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...