List Schemas Stock

GET

Lists stock schema fragments.

Query parameters

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

filter_preset"customizable_types_preset" or "no_preset"Optional

Filter preset to specify whether to filter only customization enabled leaf types.

Allowed values: customizable_types_presetno_preset
leaf_typestringOptional

The list of leaf types.

limitintegerOptional

The maximum number of items.

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
prune"composite_schemas" or "fields"Optional

List of fields which are not required in the payload and can be pruned away.

Allowed values: composite_schemasfields
sort_bystringOptional

The list of fields to sort the items by and how to sort them.

Response

Success.

resultlist of objects

The stock schema fragments.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Built with