QueryProperties

For APIs that require explicit specification of the properties to query for, this component specifies which property fields and how they are supplied to outbound requests.

• type: object
• required: ["type","property_list"]

type

• Required: Yes
• type: string
• enum: ["QueryProperties"]

property_list

The set of properties that will be queried for in the outbound request. This can either be statically defined or dynamic based on an API endpoint

• Required: Yes

• anyOf:

  • type: array

  • items:

    • type: string

• anyOf:

  • Allowed type: PropertiesFromEndpoint

always_include_properties

The list of properties that should be included in every set of properties when multiple chunks of properties are being requested.

• Required: No

• type: array

• items:

  • type: string

property_chunking

Defines how query properties will be grouped into smaller sets for APIs with limitations on the number of properties fetched per API request.

• Required: No
• Allowed type: PropertyChunking

property_selector

Defines where to look for and which query properties that should be sent in outbound API requests. For example, you can specify that only the selected columns of a stream should be in the request.

• Required: No
• Allowed type: JsonSchemaPropertySelector

$parameters

• Required: No
• type: object