Jump to

• Request
• Response
• Examples

Searches for nodes in the viewpoint using supplied criteria

post

/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/nodes/search

Request

Path Parameters

• viewId(required): string(uuid)
• viewpointId(required): string(uuid)

Body ()

Root Schema : NodeSearchCriteriaJson

Type: object

Show Source

• options: object NodeSearchOptionsJson
• predicates: array predicates

{
    "type":"object",
    "properties":{
        "predicates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeSearchPredicate"
            }
        },
        "options":{
            "$ref":"#/definitions/NodeSearchOptionsJson"
        }
    }
}

Nested Schema : NodeSearchOptionsJson

Type: object

Show Source

• limit: integer(int32)
  The maximum number of nodes to return in the search results
• matchAllPredicates: boolean
  If true, a node only matches if it matches all of the specified predicates
• matchEachNodeInstance: boolean
  If true, return every instance of a given node as a match
• requestUri: string

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum number of nodes to return in the search results"
        },
        "matchAllPredicates":{
            "type":"boolean",
            "description":"If true, a node only matches if it matches all of the specified predicates"
        },
        "matchEachNodeInstance":{
            "type":"boolean",
            "description":"If true, return every instance of a given node as a match"
        },
        "requestUri":{
            "type":"string"
        }
    }
}

Nested Schema : predicates

Type: array

Show Source

• Array of: object NodeSearchPredicate

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/NodeSearchPredicate"
    }
}

Nested Schema : NodeSearchPredicate

Type: object

Show Source

• operator: string
• property: string
• value: string

{
    "type":"object",
    "properties":{
        "property":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, search processing

400 Response

Invalid input

Back to Top

Examples

The following example shows how search for nodes in a viewpoint with a post request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/nodes/search

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "predicates": [
        {
            "property": "name",
            "operator": "equals",
            "value": "No Account"
        },
        {
            "property": "description",
            "operator": "equals",
            "value": "No Account"
        }
    ],
    "options": {
        "limit": 200,
        "matchAllPredicates": false,
        "returnEachNodeInstance": true
    }
}

Example of Response Body

The following shows an example of the response body in JSON format. This creates an asynchronous request. Access the results link to retrieve the results.

{
    "links": [
        {
            "rel": "results",
            "href": "https://servername.fa.us2.oraclecloud.com/epm/ui-rest/v1/jobRuns/d7a3e4f9-197f-4100-bb19-005d54907001"
        }
    ]
}

Back to Top