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
If true, calculated properties will be excluded from the entities.
falseAn array of values from the entity JSON. Only these values will be returned in the response.
For example: { "properties.propertyIdentifier","identifier"}
An array of values from the entity JSON to be ommitted from the response.
For example: { "properties.propertyIdentifier","identifier"}
- application/json
Body
required
Array [
- Number Rule
- Date Rule
- String Rule
- Empty Rule
- Relation Rule
- Schema Rule
- Date Range
- Date Preset
- string
- number
- boolean
- array
- date-time
Array [
]
- string
- number
- boolean
]
The combinator to use for the rules.
Possible values: [and, or]
rules
object[]
required
anyOf
Possible values: [>, >=, <, <=]
Possible values: [between, notBetween, =]
value
object
required
oneOf
Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]
Possible values: [=, !=, containsAny, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith, in, notIn]
value
object
required
anyOf
string
number
boolean
string
string
Possible values: [isEmpty, isNotEmpty]
Possible values: [relatedTo]
Possible values: [upstream, downstream]
propertySchema
object
required
Possible values: [=, !=]
value
object
anyOf
string
number
boolean
Responses
- 200
- 422
- 500
Success
One of the following errors occurred:
| Error | Description |
|---|---|
| invalid_request | The provided data does not match the route schema |
One of the following errors occurred:
| Error | Description |
|---|---|
| internal_error | An internal error occurred |