XaitCPQ API

GET page/defaults/{name}

Gets default fields for page without section defined.

Request Information

URI

https://highlandfleets-api.xaitcpq.net/page/defaults/{name}?share={share}

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

The default fields.

DefaultFieldsResponse
NameDescriptionTypeAdditional information
Fields

Collection of FieldsResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "Fields": [
    {
      "Id": "5f3f7147-2066-4ea0-8e7c-2bc6c88b7813",
      "Name": "sample string 2",
      "Required": true,
      "Help": "sample string 4",
      "DefaultValue": "sample string 5",
      "Label": "sample string 6",
      "DataType": {
        "Id": "33802594-4665-4a3e-a15b-85823a468544",
        "Name": "sample string 2",
        "Validation": "sample string 3",
        "Format": "sample string 4"
      },
      "Relationships": [
        {
          "Id": "024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f",
          "From": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "To": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "LinkEditStyle": 0,
          "ShowClearButton": true,
          "ShowRefreshButton": true,
          "ShowAddButton": true,
          "Link": {
            "Page": "sample string 1",
            "Template": "sample string 2",
            "EditTemplate": "sample string 3"
          }
        },
        {
          "Id": "024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f",
          "From": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "To": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "LinkEditStyle": 0,
          "ShowClearButton": true,
          "ShowRefreshButton": true,
          "ShowAddButton": true,
          "Link": {
            "Page": "sample string 1",
            "Template": "sample string 2",
            "EditTemplate": "sample string 3"
          }
        }
      ]
    },
    {
      "Id": "5f3f7147-2066-4ea0-8e7c-2bc6c88b7813",
      "Name": "sample string 2",
      "Required": true,
      "Help": "sample string 4",
      "DefaultValue": "sample string 5",
      "Label": "sample string 6",
      "DataType": {
        "Id": "33802594-4665-4a3e-a15b-85823a468544",
        "Name": "sample string 2",
        "Validation": "sample string 3",
        "Format": "sample string 4"
      },
      "Relationships": [
        {
          "Id": "024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f",
          "From": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "To": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "LinkEditStyle": 0,
          "ShowClearButton": true,
          "ShowRefreshButton": true,
          "ShowAddButton": true,
          "Link": {
            "Page": "sample string 1",
            "Template": "sample string 2",
            "EditTemplate": "sample string 3"
          }
        },
        {
          "Id": "024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f",
          "From": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "To": {
            "Id": "7e1dae57-71f9-4ee7-b25e-0fcfa146dd27",
            "Name": "sample string 1",
            "TableName": "sample string 2"
          },
          "LinkEditStyle": 0,
          "ShowClearButton": true,
          "ShowRefreshButton": true,
          "ShowAddButton": true,
          "Link": {
            "Page": "sample string 1",
            "Template": "sample string 2",
            "EditTemplate": "sample string 3"
          }
        }
      ]
    }
  ]
}

text/html

Sample: 
{"Fields":[{"Id":"5f3f7147-2066-4ea0-8e7c-2bc6c88b7813","Name":"sample string 2","Required":true,"Help":"sample string 4","DefaultValue":"sample string 5","Label":"sample string 6","DataType":{"Id":"33802594-4665-4a3e-a15b-85823a468544","Name":"sample string 2","Validation":"sample string 3","Format":"sample string 4"},"Relationships":[{"Id":"024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f","From":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"To":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"LinkEditStyle":0,"ShowClearButton":true,"ShowRefreshButton":true,"ShowAddButton":true,"Link":{"Page":"sample string 1","Template":"sample string 2","EditTemplate":"sample string 3"}},{"Id":"024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f","From":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"To":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"LinkEditStyle":0,"ShowClearButton":true,"ShowRefreshButton":true,"ShowAddButton":true,"Link":{"Page":"sample string 1","Template":"sample string 2","EditTemplate":"sample string 3"}}]},{"Id":"5f3f7147-2066-4ea0-8e7c-2bc6c88b7813","Name":"sample string 2","Required":true,"Help":"sample string 4","DefaultValue":"sample string 5","Label":"sample string 6","DataType":{"Id":"33802594-4665-4a3e-a15b-85823a468544","Name":"sample string 2","Validation":"sample string 3","Format":"sample string 4"},"Relationships":[{"Id":"024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f","From":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"To":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"LinkEditStyle":0,"ShowClearButton":true,"ShowRefreshButton":true,"ShowAddButton":true,"Link":{"Page":"sample string 1","Template":"sample string 2","EditTemplate":"sample string 3"}},{"Id":"024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f","From":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"To":{"Id":"7e1dae57-71f9-4ee7-b25e-0fcfa146dd27","Name":"sample string 1","TableName":"sample string 2"},"LinkEditStyle":0,"ShowClearButton":true,"ShowRefreshButton":true,"ShowAddButton":true,"Link":{"Page":"sample string 1","Template":"sample string 2","EditTemplate":"sample string 3"}}]}]}

application/xml, text/xml

Sample: 
<DefaultFieldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.Responses">
  <Fields>
    <FieldsResponse>
      <DataType>
        <Format>sample string 4</Format>
        <Id>33802594-4665-4a3e-a15b-85823a468544</Id>
        <Name>sample string 2</Name>
        <Validation>sample string 3</Validation>
      </DataType>
      <DefaultValue>sample string 5</DefaultValue>
      <Help>sample string 4</Help>
      <Id>5f3f7147-2066-4ea0-8e7c-2bc6c88b7813</Id>
      <Label>sample string 6</Label>
      <Name>sample string 2</Name>
      <Relationships>
        <RelationshipResponse>
          <From>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </From>
          <Id>024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f</Id>
          <Link>
            <EditTemplate>sample string 3</EditTemplate>
            <Page>sample string 1</Page>
            <Template>sample string 2</Template>
          </Link>
          <LinkEditStyle>DropDown</LinkEditStyle>
          <ShowAddButton>true</ShowAddButton>
          <ShowClearButton>true</ShowClearButton>
          <ShowRefreshButton>true</ShowRefreshButton>
          <To>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </To>
        </RelationshipResponse>
        <RelationshipResponse>
          <From>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </From>
          <Id>024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f</Id>
          <Link>
            <EditTemplate>sample string 3</EditTemplate>
            <Page>sample string 1</Page>
            <Template>sample string 2</Template>
          </Link>
          <LinkEditStyle>DropDown</LinkEditStyle>
          <ShowAddButton>true</ShowAddButton>
          <ShowClearButton>true</ShowClearButton>
          <ShowRefreshButton>true</ShowRefreshButton>
          <To>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </To>
        </RelationshipResponse>
      </Relationships>
      <Required>true</Required>
    </FieldsResponse>
    <FieldsResponse>
      <DataType>
        <Format>sample string 4</Format>
        <Id>33802594-4665-4a3e-a15b-85823a468544</Id>
        <Name>sample string 2</Name>
        <Validation>sample string 3</Validation>
      </DataType>
      <DefaultValue>sample string 5</DefaultValue>
      <Help>sample string 4</Help>
      <Id>5f3f7147-2066-4ea0-8e7c-2bc6c88b7813</Id>
      <Label>sample string 6</Label>
      <Name>sample string 2</Name>
      <Relationships>
        <RelationshipResponse>
          <From>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </From>
          <Id>024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f</Id>
          <Link>
            <EditTemplate>sample string 3</EditTemplate>
            <Page>sample string 1</Page>
            <Template>sample string 2</Template>
          </Link>
          <LinkEditStyle>DropDown</LinkEditStyle>
          <ShowAddButton>true</ShowAddButton>
          <ShowClearButton>true</ShowClearButton>
          <ShowRefreshButton>true</ShowRefreshButton>
          <To>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </To>
        </RelationshipResponse>
        <RelationshipResponse>
          <From>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </From>
          <Id>024873ad-ba5e-4e0c-aeea-5b7ba4dcf84f</Id>
          <Link>
            <EditTemplate>sample string 3</EditTemplate>
            <Page>sample string 1</Page>
            <Template>sample string 2</Template>
          </Link>
          <LinkEditStyle>DropDown</LinkEditStyle>
          <ShowAddButton>true</ShowAddButton>
          <ShowClearButton>true</ShowClearButton>
          <ShowRefreshButton>true</ShowRefreshButton>
          <To>
            <Id>7e1dae57-71f9-4ee7-b25e-0fcfa146dd27</Id>
            <Name>sample string 1</Name>
            <TableName>sample string 2</TableName>
          </To>
        </RelationshipResponse>
      </Relationships>
      <Required>true</Required>
    </FieldsResponse>
  </Fields>
</DefaultFieldsResponse>