Customization

Get Schemas Stock (POST)

Gets a stock schema fragment.

POST
/schemas.stock.get
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

id?string

The ID of the stock schema fragment.

Formatid
leaf_type?string

The leaf type this fragment applies to.

Formattext

Response Body

curl -X POST "https://api.devrev.ai/schemas.stock.get" \  -H "Content-Type: application/json" \  -d '{}'
{
  "fragment": {
    "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": "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"
}