Customization
List Schemas Stock
Lists stock schema fragments.
Lists stock schema fragments.
Authorization
auth-token
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
Query Parameters
cursor?string
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
Format
textfilter_preset?string
Filter preset to specify whether to filter only customization enabled leaf types.
Value in
"customizable_types_preset" | "no_preset"leaf_type?array<string>
The list of leaf types.
limit?integer
The maximum number of items.
Format
int32mode?string
The iteration mode to use, otherwise if not set, then "after" is used.
Value in
"after" | "before"prune?array<stock-schema-fragments-list-request-prune>
List of fields which are not required in the payload and can be pruned away.
sort_by?array<string>
The list of fields to sort the items by and how to sort them.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.devrev.ai/schemas.stock.list"{
"next_cursor": "string",
"prev_cursor": "string",
"result": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"composite_schemas": [
{
"description": "string",
"fields": [
{
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"decimal_places": 0,
"display_name": "string",
"group_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_sortable": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
}
],
"name": "string"
}
],
"description": "string",
"fields": [
{
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"decimal_places": 0,
"display_name": "string",
"group_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_sortable": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
}
],
"leaf_type": "string",
"new_fragment_ref": {
"type": "article",
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"title": "string"
},
"old_fragment_ref": {
"type": "article",
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"title": "string"
}
}
]
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}