Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RelationshipsFilterRequest

Hierarchy

Index

Properties

Optional cursor

cursor: undefined | string

Optional fetchResources

fetchResources: undefined | false | true

If true, will try to fetch the resources referred to in the relationship, based on the users access rights. Will silently fail to attatch the resources if the user lacks access to some of them.

Optional filter

Filter on relationships with exact match. Multiple filter elements in one property, e.g. sourceExternalIds: [ "a", "b" ], will return all relationships where the sourceExternalId field is either a or b. Filters in multiple properties will return the relationships that match all criteria. If the filter is not specified it default to an empty filter.

Optional limit

limit: undefined | number