Skip to main content

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.

Body

array

required

  • Array [

  • action Actionrequired

    Possible values: [search]

    expression Expressionrequired
    terms string[]required
    entity_type Entity Typerequired

    context_id

    object

    nullable

    anyOf

    boolean

    object_type_ids

    object

    nullable

    anyOf

  • Array [

  • string

  • ]

  • metadata

    object

    property name* any
  • ]

Responses

Successful Response

Loading...