GET api/Schema
Retrieve schema for all business objects
Request Information
Request body formats
text/plain
Sample:
No body required. Body is ignored.
Response Information
Response body formats
application/json, text/json
Sample:
{
"Options": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"DecimalPlaces": 1,
"Properties": {},
"Label": "sample string 2",
"Length": "sample string 3",
"IsImage": true,
"IsFileAttachment": true,
"IsHyperlink": true,
"IsUnicode": true,
"ShowOnInvoice": true,
"ShowOnOrder": true,
"ShowOnQuote": true,
"ShowOnReturn": true,
"IsRichTextMemo": true,
"IsCustomerLookup": true,
"CustomerClass": "sample string 14",
"Id": "sample string 15",
"Title": "sample string 16",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 17",
"Type": "None",
"Pattern": "sample string 18",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [
{
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
{
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
{
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
}
],
"PositionalItemsValidation": true,
"AdditionalItems": {
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
"AllowAdditionalItems": true,
"UniqueItems": true,
"AdditionalProperties": {
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
"PatternProperties": {
"sample string 1": {
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
"sample string 2": {
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
"sample string 3": {
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
}
},
"AllowAdditionalProperties": true,
"Requires": "sample string 23",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [
{
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
{
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
},
{
"Id": "sample string 1",
"Title": "sample string 2",
"Required": true,
"ReadOnly": true,
"Hidden": true,
"Transient": true,
"Description": "sample string 3",
"Type": "None",
"Pattern": "sample string 4",
"MinimumLength": 1,
"MaximumLength": 1,
"DivisibleBy": 1.1,
"Minimum": 1.1,
"Maximum": 1.1,
"ExclusiveMinimum": true,
"ExclusiveMaximum": true,
"MinimumItems": 1,
"MaximumItems": 1,
"Items": [],
"PositionalItemsValidation": true,
"AllowAdditionalItems": true,
"UniqueItems": true,
"Properties": {},
"PatternProperties": {},
"AllowAdditionalProperties": true,
"Requires": "sample string 9",
"Enum": null,
"Disallow": "None",
"Default": null,
"Extends": [],
"Format": "sample string 10"
}
],
"Format": "sample string 24"
}