ListPartitionRouter

A Partition router that specifies a list of attributes where each attribute describes a portion of the complete data set for a stream. During a sync, each value is iterated over and can be used as input to outbound API requests.

• type: object
• required: ["type","cursor_field","values"]

type

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

cursor_field

While iterating over list values, the name of field used to reference a list value. The partition value can be accessed with string interpolation. e.g. "{{ stream_partition['my_key'] }}" where "my_key" is the value of the cursor_field.

• Required: Yes
• type: string
• Available variables: config

Examples:

section

{{ config['section_key'] }}

values

The list of attributes being iterated over and used as input for the requests made to the source API.

• Required: Yes
• Available variables: config

Examples:

- section_a
- section_b
- section_c

{{ config['sections'] }}

• anyOf:

  • type: string

• anyOf:

  • type: array

  • items:

    • type: string

request_option

A request option describing where the list value should be injected into and under what field name if applicable.

• Required: No
• Allowed type: RequestOption

$parameters

• Required: No
• type: object