customization

Stock Schema Fragments List Post

POST
Lists stock schema fragments.

Request

This endpoint expects an object.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
filter_preset
enumOptional
Allowed values: customizable_types_presetno_preset
leaf_type
list of stringsOptional
The list of leaf types.
limit
integerOptional
The maximum number of items.
mode
enumOptional
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.
Allowed values: afterbefore
prune
list of enumsOptional
List of fields which are not required in the payload and can be pruned away.
Allowed values: composite_schemasfields
sort_by
list of stringsOptional
The list of fields to sort the items by and how to sort them.

Response

This endpoint returns an object
result
list of objects
The stock schema fragments.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/schemas.stock.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
1{
2  "result": [
3    {
4      "fields": [],
5      "id": "id",
6      "created_date": "2023-01-01T12:00:00Z",
7      "description": "description",
8      "display_id": "display_id",
9      "leaf_type": "leaf_type",
10      "modified_date": "2023-01-01T12:00:00Z",
11      "title": "title"
12    }
13  ],
14  "next_cursor": "next_cursor",
15  "prev_cursor": "prev_cursor"
16}
Built with