Stock Schema Fragments List Post

POST
Lists stock schema fragments.

Request

This endpoint expects an object.
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
Allowed values: customizable_types_presetno_preset
leaf_typelist of stringsOptional
The list of leaf types.
limitintegerOptional
The maximum number of items.
mode"after" or "before"Optional
Allowed values: afterbefore
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
prunelist of "composite_schemas" or "fields"Optional
Allowed values: composite_schemasfields
List of fields which are not required in the payload and can be pruned away.
sort_bylist of stringsOptional
The list of fields to sort the items by and how to sort them.

Response

This endpoint returns an object.
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