PropertiesFromEndpoint

Defines the behavior for fetching the list of properties from an API that will be loaded into the requests to extract records. Note that stream_slices can't be interpolated from this retriever.

• type: object
• required: ["type","property_field_path","retriever"]

type

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

property_field_path

Describes the path to the field that should be extracted

• Required: Yes
• type: array
• Available variables: config, parameters

Examples:

- name

• items:

  • type: string

retriever

Requester component that describes how to fetch the properties to query from a remote API endpoint.

• Required: Yes

• anyOf:

  • Allowed type: SimpleRetriever

• anyOf:

  • Allowed type: CustomRetriever

$parameters

• Required: No
• type: object