Skip to main content

Search the graph and return the resulting graph.

POST 

/graph/:graph_id/search/graph

Search the graph and return the matching nodes including the traversed edges. The resulting data can be interpreted as a graph. A section can be defined (defaults to / == root) to interpret relative property paths. Example: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)

Request​

Path Parameters

    graph_id stringrequired

    The identifier of the graph

    Example: fix

Query Parameters

    section string

    Possible values: [reported, desired, metadata]

    The name of the section used for all property paths. If not defined root is assumed.

    with-kind boolean

    Include the kind of the node in the result node.

    count boolean

    Default value: true

    Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements

    search_timeout string

    Optional duration the search is allowed to run.

    at date-time

    The timestamp to use for the search. If not defined the latest version of the graph is used.

Body

The search to perform

    string

Responses​

The result of this search in the defined format

Schema

  • Array [

  • kind string

    The kind of this node.

  • ]

Loading...