POST meta/FormTemplate

Request Information

URI Parameters

None.

Body Parameters

ElementSchema
NameDescriptionTypeAdditional information
Name

string

Required

ScopeId

integer

Required

Language

string

Required

KeyColumn

string

Required

DisplayColumn

string

Required

TypeColumn

string

None.

ExtendedScopeTable

ExtendedScopeTableAttribute

None.

ElementName

string

Required

ElementNamePlural

string

Required

WelcomeMessage

string

None.

Properties

Collection of Property

Required

PropertyGroups

Collection of PropertyGroup

Required

PropertySections

Collection of PropertySection

Required

AddressDefinitions

Dictionary of Object [key] and Object [value]

None.

Filters

Dictionary of string [key] and FilterColumnAttribute [value]

None.

DefaultOrder

Dictionary of string [key] and string [value]

None.

AssociationFilterTables

Collection of string

None.

AssociationPropertyNames

Collection of string

None.

MergeColumns

Collection of string

None.

TimeStamp

date

Required

Type

Type

Required

GroupOrder

Dictionary of string [key] and integer [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "ScopeId": 2,
  "Language": "sample string 3",
  "KeyColumn": "sample string 4",
  "DisplayColumn": "sample string 5",
  "TypeColumn": "sample string 6",
  "ElementName": "sample string 7",
  "ElementNamePlural": "sample string 8",
  "WelcomeMessage": "sample string 9",
  "Properties": [
    {
      "Meta": {
        "FormDisplay": true,
        "IsReadOnly": true,
        "IsRequired": true,
        "IsDefaultValue": true,
        "Name": "sample string 5",
        "Description": "sample string 6",
        "DefaultValue": {}
      },
      "PropertyName": "sample string 1",
      "AllowEmptyStrings": true,
      "AttachmentUsage": "sample string 3",
      "AttachmentAssignment": "sample string 4",
      "AttachmentAspectRatio": "sample string 5",
      "AttachmentElementName": "sample string 6",
      "AttachmentElementIdProperty": "sample string 7",
      "AutoGenerateField": true,
      "AutoGenerateFilter": true,
      "CompareOtherProperty": "sample string 10",
      "CompareMessage": "sample string 11",
      "DataFormatString": "sample string 12",
      "DefaultValue": {},
      "Description": "sample string 14",
      "DisplayNameFunction": "sample string 15",
      "DummyType": "sample string 16",
      "HasDynOptions": true,
      "FormDisplayRule": {
        "Display": 0,
        "CreateModeDisplay": 0,
        "EditModeDisplay": 0,
        "DuplicateModeDisplay": 0,
        "DeleteModeDisplay": 0,
        "Dependency": {
          "Items": [
            {
              "PropertyName": "sample string 1",
              "Value": {},
              "Operator": "sample string 3",
              "DataType": "sample string 4",
              "IsBooleanType": true,
              "IsNumericType": true
            },
            {
              "PropertyName": "sample string 1",
              "Value": {},
              "Operator": "sample string 3",
              "DataType": "sample string 4",
              "IsBooleanType": true,
              "IsNumericType": true
            }
          ]
        }
      },
      "ForeignKeyName": "sample string 18",
      "FileExtensions": "sample string 19",
      "GridDisplayRule": {
        "SortFields": [
          "sample string 1",
          "sample string 2"
        ],
        "SearchFields": [
          "sample string 1",
          "sample string 2"
        ],
        "FilterFields": [
          "sample string 1",
          "sample string 2"
        ],
        "Display": true,
        "IsSortAble": true,
        "IsSearchAble": true,
        "IsFilterAble": true,
        "IsMainColumn": true
      },
      "GroupName": "sample string 20",
      "HtmlEncode": true,
      "HttpGetOptionsUrl": "sample string 22",
      "IsKey": true,
      "IsConcurrencyCheck": true,
      "IsDisabled": true,
      "IsReadOnly": true,
      "_IsReadOnly": true,
      "IsRequired": true,
      "_IsRequired": true,
      "IsSortable": true,
      "IsVirtual": true,
      "IsMultiple": true,
      "EnableText": true,
      "MaxLength": 34,
      "MinLength": 35,
      "Max": {},
      "Min": {},
      "Name": "sample string 38",
      "Options": [
        {
          "Key": {},
          "Value": {},
          "Sort": 3,
          "Hide": true
        },
        {
          "Key": {},
          "Value": {},
          "Sort": 3,
          "Hide": true
        }
      ],
      "Order": 39,
      "ParentPropertyName": "sample string 40",
      "Prompt": "sample string 41",
      "Properties": {
        "sample string 1": {},
        "sample string 3": {}
      },
      "RequiredPermissions": [
        "sample string 1",
        "sample string 2"
      ],
      "Rows": 42,
      "SectionName": "sample string 43",
      "ShortName": "sample string 44",
      "UiHint": "sample string 45",
      "UiHintControlParameters": {
        "System.Object": {}
      },
      "Directive": {
        "Attributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "Name": "sample string 1",
        "SetModel": true,
        "IntegratedMerge": true,
        "IntegratedStatus": true,
        "Placement": "FullWidth",
        "TypeId": "ASTLib.Types.Attributes.DirectiveAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
      },
      "UIAttributes": {
        "Attributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "TypeId": "ASTLib.Types.Attributes.UIAttributesAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
      },
      "ElementSchemaReference": {
        "ElementName": "sample string 1",
        "PropertyName": "sample string 2",
        "TypeId": "ASTLib.Types.Attributes.ElementSchemaReferenceAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
      },
      "WidgetDisplay": "None",
      "SystemDataType": "sample string 46",
      "DataType": "sample string 47"
    },
    {
      "Meta": {
        "FormDisplay": true,
        "IsReadOnly": true,
        "IsRequired": true,
        "IsDefaultValue": true,
        "Name": "sample string 5",
        "Description": "sample string 6",
        "DefaultValue": {}
      },
      "PropertyName": "sample string 1",
      "AllowEmptyStrings": true,
      "AttachmentUsage": "sample string 3",
      "AttachmentAssignment": "sample string 4",
      "AttachmentAspectRatio": "sample string 5",
      "AttachmentElementName": "sample string 6",
      "AttachmentElementIdProperty": "sample string 7",
      "AutoGenerateField": true,
      "AutoGenerateFilter": true,
      "CompareOtherProperty": "sample string 10",
      "CompareMessage": "sample string 11",
      "DataFormatString": "sample string 12",
      "DefaultValue": {},
      "Description": "sample string 14",
      "DisplayNameFunction": "sample string 15",
      "DummyType": "sample string 16",
      "HasDynOptions": true,
      "FormDisplayRule": {
        "Display": 0,
        "CreateModeDisplay": 0,
        "EditModeDisplay": 0,
        "DuplicateModeDisplay": 0,
        "DeleteModeDisplay": 0,
        "Dependency": {
          "Items": [
            {
              "PropertyName": "sample string 1",
              "Value": {},
              "Operator": "sample string 3",
              "DataType": "sample string 4",
              "IsBooleanType": true,
              "IsNumericType": true
            },
            {
              "PropertyName": "sample string 1",
              "Value": {},
              "Operator": "sample string 3",
              "DataType": "sample string 4",
              "IsBooleanType": true,
              "IsNumericType": true
            }
          ]
        }
      },
      "ForeignKeyName": "sample string 18",
      "FileExtensions": "sample string 19",
      "GridDisplayRule": {
        "SortFields": [
          "sample string 1",
          "sample string 2"
        ],
        "SearchFields": [
          "sample string 1",
          "sample string 2"
        ],
        "FilterFields": [
          "sample string 1",
          "sample string 2"
        ],
        "Display": true,
        "IsSortAble": true,
        "IsSearchAble": true,
        "IsFilterAble": true,
        "IsMainColumn": true
      },
      "GroupName": "sample string 20",
      "HtmlEncode": true,
      "HttpGetOptionsUrl": "sample string 22",
      "IsKey": true,
      "IsConcurrencyCheck": true,
      "IsDisabled": true,
      "IsReadOnly": true,
      "_IsReadOnly": true,
      "IsRequired": true,
      "_IsRequired": true,
      "IsSortable": true,
      "IsVirtual": true,
      "IsMultiple": true,
      "EnableText": true,
      "MaxLength": 34,
      "MinLength": 35,
      "Max": {},
      "Min": {},
      "Name": "sample string 38",
      "Options": [
        {
          "Key": {},
          "Value": {},
          "Sort": 3,
          "Hide": true
        },
        {
          "Key": {},
          "Value": {},
          "Sort": 3,
          "Hide": true
        }
      ],
      "Order": 39,
      "ParentPropertyName": "sample string 40",
      "Prompt": "sample string 41",
      "Properties": {
        "sample string 1": {},
        "sample string 3": {}
      },
      "RequiredPermissions": [
        "sample string 1",
        "sample string 2"
      ],
      "Rows": 42,
      "SectionName": "sample string 43",
      "ShortName": "sample string 44",
      "UiHint": "sample string 45",
      "UiHintControlParameters": {
        "System.Object": {}
      },
      "Directive": {
        "Attributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "Name": "sample string 1",
        "SetModel": true,
        "IntegratedMerge": true,
        "IntegratedStatus": true,
        "Placement": "FullWidth",
        "TypeId": "ASTLib.Types.Attributes.DirectiveAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
      },
      "UIAttributes": {
        "Attributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "TypeId": "ASTLib.Types.Attributes.UIAttributesAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
      },
      "ElementSchemaReference": {
        "ElementName": "sample string 1",
        "PropertyName": "sample string 2",
        "TypeId": "ASTLib.Types.Attributes.ElementSchemaReferenceAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
      },
      "WidgetDisplay": "None",
      "SystemDataType": "sample string 46",
      "DataType": "sample string 47"
    }
  ],
  "PropertyGroups": [
    {
      "Meta": {
        "Name": "sample string 1"
      },
      "GroupName": "sample string 1",
      "Description": "sample string 2",
      "Name": "sample string 3",
      "Order": 4,
      "ShortName": "sample string 5",
      "PropertyIdxs": [
        1,
        2
      ]
    },
    {
      "Meta": {
        "Name": "sample string 1"
      },
      "GroupName": "sample string 1",
      "Description": "sample string 2",
      "Name": "sample string 3",
      "Order": 4,
      "ShortName": "sample string 5",
      "PropertyIdxs": [
        1,
        2
      ]
    }
  ],
  "PropertySections": [
    {
      "SectionName": "sample string 1",
      "Name": "sample string 2",
      "PropertyGroups": [
        {
          "Meta": {
            "Name": "sample string 1"
          },
          "GroupName": "sample string 1",
          "Description": "sample string 2",
          "Name": "sample string 3",
          "Order": 4,
          "ShortName": "sample string 5",
          "PropertyIdxs": [
            1,
            2
          ]
        },
        {
          "Meta": {
            "Name": "sample string 1"
          },
          "GroupName": "sample string 1",
          "Description": "sample string 2",
          "Name": "sample string 3",
          "Order": 4,
          "ShortName": "sample string 5",
          "PropertyIdxs": [
            1,
            2
          ]
        }
      ],
      "PropertyIdxs": [
        1,
        2
      ]
    },
    {
      "SectionName": "sample string 1",
      "Name": "sample string 2",
      "PropertyGroups": [
        {
          "Meta": {
            "Name": "sample string 1"
          },
          "GroupName": "sample string 1",
          "Description": "sample string 2",
          "Name": "sample string 3",
          "Order": 4,
          "ShortName": "sample string 5",
          "PropertyIdxs": [
            1,
            2
          ]
        },
        {
          "Meta": {
            "Name": "sample string 1"
          },
          "GroupName": "sample string 1",
          "Description": "sample string 2",
          "Name": "sample string 3",
          "Order": 4,
          "ShortName": "sample string 5",
          "PropertyIdxs": [
            1,
            2
          ]
        }
      ],
      "PropertyIdxs": [
        1,
        2
      ]
    }
  ],
  "AddressDefinitions": {
    "System.Object": {}
  },
  "Filters": {
    "sample string 1": {
      "Name": "sample string 1",
      "MultiSelect": true,
      "Mode": "Normal",
      "Options": [
        {},
        {}
      ],
      "Label": "sample string 3",
      "OptionLabel": "sample string 4",
      "TypeId": "ASTLib.Types.Attributes.FilterColumnAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
    },
    "sample string 2": {
      "Name": "sample string 1",
      "MultiSelect": true,
      "Mode": "Normal",
      "Options": [
        {},
        {}
      ],
      "Label": "sample string 3",
      "OptionLabel": "sample string 4",
      "TypeId": "ASTLib.Types.Attributes.FilterColumnAttribute, ASTLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
    }
  },
  "DefaultOrder": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "AssociationFilterTables": [
    "sample string 1",
    "sample string 2"
  ],
  "AssociationPropertyNames": [
    "sample string 1",
    "sample string 2"
  ],
  "MergeColumns": [
    "sample string 1",
    "sample string 2"
  ],
  "TimeStamp": "2024-11-21T10:34:22.1109851+01:00",
  "GroupOrder": {
    "sample string 1": 2,
    "sample string 3": 4
  }
}

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.