SchemaDesignerServicesGetSchemaDetails Method |
Retrieves full details of a single Schema
Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
Syntaxpublic XHRServiceResponseGeneric<SchemaDetails> GetSchemaDetails( SchemaDetailGetInput data )
Parameters
- data
- Type: SchemaDetailGetInput
Object containing Id of the Schema
ExamplesSample JSON inputJavaScript{ "data": { "schemaId": "schemas/194" } }
Return Value
Type: XHRServiceResponseGenericSchemaDetailsFull details of the given schema if it exists
Examples
Sample JSON return
JavaScript
{
"code": 0,
"error": null,
"message": {
"AllowedCategoryRootIDs": "",
"AllowedCategoryRoots": [],
"DefaultCategories": [],
"DefaultCategoryIDs": "",
"Drafting": false,
"Fields": [{
"ChildElementLabel": null,
"ChildElementName": null,
"ChildElementTypeID": "1",
"ChildProperties": [],
"DefaultValue": null,
"ElementTypeName": "string",
"Exports": "",
"HasExports": false,
"HelpText": "",
"Hidden": false,
"IconName": "document16",
"IsXpower": false,
"Label": "Title",
"Name": "Title",
"Properties": [],
"Readonly": false,
"Required": false,
"ResersedContentUnitField": false,
"TypeID": "2",
"TypeLabel": "Plain Text",
"TypeName": "Text Element",
"UniqueID": null
}, {
"ChildElementLabel": null,
"ChildElementName": null,
"ChildElementTypeID": "1",
"ChildProperties": [],
"DefaultValue": null,
"ElementTypeName": "dhtml",
"Exports": "",
"HasExports": false,
"HelpText": "",
"Hidden": false,
"IconName": "edit16",
"IsXpower": false,
"Label": "Body Copy",
"Name": "BodyCopy",
"Properties": [{
"Choices": "",
"Label": "Height",
"Name": "Height",
"Type": "integer",
"Value": ""
}],
"Readonly": false,
"Required": false,
"ResersedContentUnitField": false,
"TypeID": "3",
"TypeLabel": "XHTML Editor",
"TypeName": "XHTML Element",
"UniqueID": null
}, {
"ChildElementLabel": null,
"ChildElementName": null,
"ChildElementTypeID": "1",
"ChildProperties": [],
"DefaultValue": null,
"ElementTypeName": "Component",
"Exports": "",
"HasExports": false,
"HelpText": "",
"Hidden": false,
"IconName": "component16",
"IsXpower": true,
"Label": "Site Control",
"Name": "SiteControl",
"Properties": [{
"Choices": "",
"Label": "Component",
"Name": "Component",
"Type": "page",
"Value": "x4"
}, {
"Choices": "",
"Label": "Component Types",
"Name": "CompTypes",
"Type": "schemas",
"Value": "SiteControl"
}, {
"Choices": "",
"Label": "Wrapped in Expanded Xml",
"Name": "WrappedUp",
"Type": "boolean",
"Value": "false"
}, {
"Choices": "",
"Label": "Allow changing xml wrapping",
"Name": "AllowWrappingChange",
"Type": "boolean",
"Value": "false"
}],
"Readonly": false,
"Required": false,
"ResersedContentUnitField": false,
"TypeID": "4",
"TypeLabel": "Component",
"TypeName": "Component",
"UniqueID": null
}, {
"ChildElementLabel": null,
"ChildElementName": null,
"ChildElementTypeID": "1",
"ChildProperties": [],
"DefaultValue": null,
"ElementTypeName": "Navigation",
"Exports": "",
"HasExports": true,
"HelpText": "",
"Hidden": false,
"IconName": "navigation16",
"IsXpower": true,
"Label": "Ancestor Navigation",
"Name": "AncestorNavigation",
"Properties": [{
"Choices": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean",
"Value": "false"
}, {
"Choices": "Children;Ancestors;Sibling;Sequential;SubTree",
"Label": "Navigation Type",
"Name": "Navigation",
"Type": "enumeration",
"Value": "Ancestors"
}, {
"Choices": "up;down",
"Label": "Generation Order",
"Name": "GenerationOrder",
"Type": "enumeration",
"Value": "down"
}, {
"Choices": "",
"Label": "Start Page",
"Name": "StartPage",
"Type": "page",
"Value": "x2"
}, {
"Choices": "",
"Label": "Maximum Nodes",
"Name": "MaxNodes",
"Type": "",
"Value": ""
}, {
"Choices": "",
"Label": "Maximum Depth",
"Name": "MaxDepth",
"Type": "",
"Value": ""
}, {
"Choices": "",
"Label": "Query",
"Name": "Query",
"Type": "",
"Value": ""
}],
"Readonly": false,
"Required": false,
"ResersedContentUnitField": false,
"TypeID": "8",
"TypeLabel": "Navigation",
"TypeName": "Navigation",
"UniqueID": null
}],
"FriendlyName": "Details",
"Icon": 2,
"IsComponent": false,
"IsDynamicSitePage": true,
"OriginPageId": null,
"PagesCount": 5,
"PresentationsCount": 0,
"RootName": "Details",
"Stylesheet": "",
"UniqueID": "schemas\/194",
"Version": 4,
"VersionsCount": 2,
"VersionsList": [{
"Date": "20140120T14:21:50",
"User": "User\/INGENIUX___awang",
"Version": 3
}, {
"Date": "20131210T15:36:28",
"User": "User\/INGENIUX___awang",
"Version": 2
}],
"ViewName": "Details",
"WorkflowDefinitionID": "",
"WorkflowDefinitions": []
}
}RemarksIf Schema doesn't exist, returns error status
See Also