eQuipAPI

<back to all web services

GetFormDesignerData

The following routes are available for this service:
All Verbs/GetFormDesignerData/{UserID}/{CategoryID}/{FormName}/{ObjectID}/{Mode}/{ForSaveEditor}
GetFormDesignerData Parameters:
NameParameterData TypeRequiredDescription
UserIDpathstringNo
CategoryIDpathintNo
FormNamepathstringNo
ObjectIDpathintNo
ModepathstringNo
ForSaveEditorpathstringNo
FormDesignerDataResponse Parameters:
NameParameterData TypeRequiredDescription
TabCollectionbodyList<Tab>No
IsLockedbodyboolNo
isEditInActiveAssetbodyboolNo
Tab Parameters:
NameParameterData TypeRequiredDescription
IDbodyintNo
NamebodystringNo
ContentbodystringNo
FieldCollectionbodyList<Field>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetFormDesignerData HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<GetFormDesignerData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <CategoryID>0</CategoryID>
  <ForSaveEditor>String</ForSaveEditor>
  <FormName>String</FormName>
  <Mode>String</Mode>
  <ObjectID>0</ObjectID>
  <UserID>String</UserID>
</GetFormDesignerData>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormDesignerDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <IsLocked>false</IsLocked>
  <TabCollection>
    <Tab>
      <Content>String</Content>
      <FieldCollection>
        <Field>
          <Display>String</Display>
          <DisplayMask>String</DisplayMask>
          <FieldDataSource xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:ArrayOfKeyValueOfstringanyType>
              <d6p1:KeyValueOfstringanyType>
                <d6p1:Key>String</d6p1:Key>
                <d6p1:Value />
              </d6p1:KeyValueOfstringanyType>
            </d6p1:ArrayOfKeyValueOfstringanyType>
          </FieldDataSource>
          <Format>String</Format>
          <H>0</H>
          <Hidden>String</Hidden>
          <ID>0</ID>
          <IsAlias>false</IsAlias>
          <IsEditForm>false</IsEditForm>
          <IsLocked>false</IsLocked>
          <IsMask>false</IsMask>
          <IsParentAliasField>false</IsParentAliasField>
          <LX>0</LX>
          <LY>0</LY>
          <Mandatory>String</Mandatory>
          <MappingField>
            <Column>
              <AssetMappedFieldID>0</AssetMappedFieldID>
              <Disable>false</Disable>
              <FieldDataSource xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:ArrayOfKeyValueOfstringanyType>
                  <d8p1:KeyValueOfstringanyType>
                    <d8p1:Key>String</d8p1:Key>
                    <d8p1:Value />
                  </d8p1:KeyValueOfstringanyType>
                </d8p1:ArrayOfKeyValueOfstringanyType>
              </FieldDataSource>
              <FieldId>0</FieldId>
              <IsEditable>false</IsEditable>
              <IsInlineEditWF>false</IsInlineEditWF>
              <IsMaxLength>false</IsMaxLength>
              <MaxLengthCount>0</MaxLengthCount>
              <Required>false</Required>
              <TableType>String</TableType>
              <TextLength>0</TextLength>
              <UseMultiSelect>false</UseMultiSelect>
              <ValueListType>0</ValueListType>
              <command>String</command>
              <decimals>0</decimals>
              <editor>String</editor>
              <expandable>false</expandable>
              <field>String</field>
              <filterable>false</filterable>
              <format>String</format>
              <headerTemplate>String</headerTemplate>
              <lockable>false</lockable>
              <locked>false</locked>
              <selectable>false</selectable>
              <sortable>false</sortable>
              <template>String</template>
              <title>String</title>
              <type>String</type>
              <valueList>false</valueList>
              <width>200</width>
            </Column>
          </MappingField>
          <MappingFieldValidation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:ArrayOfKeyValueOfstringanyType>
              <d6p1:KeyValueOfstringanyType>
                <d6p1:Key>String</d6p1:Key>
                <d6p1:Value />
              </d6p1:KeyValueOfstringanyType>
            </d6p1:ArrayOfKeyValueOfstringanyType>
          </MappingFieldValidation>
          <MappingPKField>String</MappingPKField>
          <MappingTable>String</MappingTable>
          <MappingTableDisplayReadOnly>false</MappingTableDisplayReadOnly>
          <MaskEnd>0</MaskEnd>
          <MaskStart>0</MaskStart>
          <MaxLength>0</MaxLength>
          <Name>String</Name>
          <ParentFieldDefinitionID>0</ParentFieldDefinitionID>
          <ReadOnly>String</ReadOnly>
          <TabIndex>0</TabIndex>
          <TableType>0</TableType>
          <Text>String</Text>
          <Type>0</Type>
          <UseMultiSelect>0</UseMultiSelect>
          <Value />
          <ValueList>false</ValueList>
          <W>0</W>
          <X>0</X>
          <Y>0</Y>
        </Field>
      </FieldCollection>
      <ID>0</ID>
      <Name>String</Name>
    </Tab>
  </TabCollection>
  <isEditInActiveAsset>false</isEditInActiveAsset>
</FormDesignerDataResponse>