Search entities

POST 
/v1/entities/search

This route allows you to search for entities in your software catalog based on a given set of rules.

To learn more about entities, check out the documentation.

For more details about Port's search mechanism, rules, and operators - see the search & query documentation.

Request

Query Parameters

exclude_calculated_properties boolean

If true, calculated properties will be excluded from the entities.


include string[]

An array of values from the entity JSON. Only these values will be returned in the response.
For example: { "properties.propertyIdentifier","identifier"}

exclude string[]

An array of values from the entity JSON to be ommitted from the response.
For example: { "properties.propertyIdentifier","identifier"}

application/json

Body

required

combinator required

Possible values: [and, or]

The combinator to use for the rules.


rules

object[]

required

Array [

anyOf

Number Rule

property stringrequired

operator required

Possible values: [>, >=, <, <=]

value numberrequired

Date Rule

property stringrequired

operator required

Possible values: [between, notBetween, =]

value

object

required

oneOf

Date Range

from date-timerequired

to date-timerequired

Date Preset

preset stringrequired

Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]

String Rule

property stringrequired

operator required

Possible values: [=, !=, containsAny, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith, in, notIn]

value

object

required

anyOf

string

string

number

number

boolean

boolean

array

Array [

string

]

date-time

string

Empty Rule

operator required

Possible values: [isEmpty, isNotEmpty]

property stringrequired

Relation Rule

operator required

Possible values: [relatedTo]

blueprint stringrequired

value stringrequired

direction

Possible values: [upstream, downstream]

required boolean

Schema Rule

propertySchema

object

required

type stringrequired

format string

operator required

Possible values: [=, !=]

value

object

anyOf

string

string

number

number

boolean

boolean

]

Responses

200

Success

422

One of the following errors occurred:

Error	Description
invalid_request	The provided data does not match the route schema

500

One of the following errors occurred:

Error	Description
internal_error	An internal error occurred

Loading...