Customization
Get Schemas Aggregated (POST)
Gets the aggregated schema.
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
custom_schema_fragments?array<string>
The custom schema fragment IDs which are to be aggregated.
custom_schema_spec?custom-schema-spec-for-read
Custom schemas described using identifiers
is_custom_leaf_type?boolean
Whether the leaf type corresponds to a custom object.
leaf_type?string
The leaf type. Used for inferring the default stage diagram and tenant fragment ID.
Format
textstock_schema_fragment?string
The stock schema fragment which is to be aggregated.
Format
idResponse Body
curl -X POST "https://api.devrev.ai/schemas.aggregated.get" \ -H "Content-Type: application/json" \ -d '{}'{
"schema": {
"apps": [
"string"
],
"conditions": [
{
"effects": [
{
"allowed_values": [
"string"
],
"fields": [
"string"
],
"immutable": true,
"require": true,
"show": true
}
],
"expression": "string"
}
],
"custom_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"
}
],
"custom_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
}
],
"description": "string",
"is_custom_leaf_type": true,
"leaf_type": "string",
"stage_diagram_id": {
"display_id": "string",
"id": "string",
"name": "string"
},
"stock_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"
}
],
"stock_field_overrides": [
{
"is_required": true,
"name": "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
}
}
],
"stock_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
}
],
"subtype": "string",
"subtype_display_name": "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": "not_found"
}{
"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"
}