PUT api/Entity?viewId={viewId}&page={page}&size={size}

Returns a paged list of search results.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
viewId

System.String

Required

page

System.Int32

Required

size

System.Int32

Required

Body Parameters

Altai.Web.Services.Models.Entity
NameDescriptionTypeAdditional information
Id

System.String

None.

UpdateEntityId

System.String

None.

LogicalName

System.String

None.

Attributes

System.Collections.Generic.List`1[Altai.Web.Services.Models.Attribute]

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "UpdateEntityId": "sample string 2",
  "LogicalName": "sample string 3",
  "Attributes": [
    {
      "Label": "sample string 1",
      "AttributeName": "sample string 2",
      "DecimalAttributeValue": 3.0,
      "WholeNumberAttributeValue": 4,
      "AttributeValue": "sample string 5",
      "MoneyAttributeValue": 6.0,
      "OptionSetAttributeValue": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "OptionSetValuesAttributeValue": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "AttributeType": "sample string 7"
    },
    {
      "Label": "sample string 1",
      "AttributeName": "sample string 2",
      "DecimalAttributeValue": 3.0,
      "WholeNumberAttributeValue": 4,
      "AttributeValue": "sample string 5",
      "MoneyAttributeValue": 6.0,
      "OptionSetAttributeValue": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "OptionSetValuesAttributeValue": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "AttributeType": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<Entity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Attributes>
    <Attribute>
      <AttributeName>sample string 2</AttributeName>
      <AttributeType>sample string 7</AttributeType>
      <AttributeValue>sample string 5</AttributeValue>
      <DecimalAttributeValue>3</DecimalAttributeValue>
      <Label>sample string 1</Label>
      <MoneyAttributeValue>6</MoneyAttributeValue>
      <OptionSetAttributeValue>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </OptionSetAttributeValue>
      <OptionSetValuesAttributeValue>
        <OptionSetValue>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </OptionSetValue>
        <OptionSetValue>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </OptionSetValue>
      </OptionSetValuesAttributeValue>
      <WholeNumberAttributeValue>4</WholeNumberAttributeValue>
    </Attribute>
    <Attribute>
      <AttributeName>sample string 2</AttributeName>
      <AttributeType>sample string 7</AttributeType>
      <AttributeValue>sample string 5</AttributeValue>
      <DecimalAttributeValue>3</DecimalAttributeValue>
      <Label>sample string 1</Label>
      <MoneyAttributeValue>6</MoneyAttributeValue>
      <OptionSetAttributeValue>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </OptionSetAttributeValue>
      <OptionSetValuesAttributeValue>
        <OptionSetValue>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </OptionSetValue>
        <OptionSetValue>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </OptionSetValue>
      </OptionSetValuesAttributeValue>
      <WholeNumberAttributeValue>4</WholeNumberAttributeValue>
    </Attribute>
  </Attributes>
  <Id>sample string 1</Id>
  <LogicalName>sample string 3</LogicalName>
  <UpdateEntityId>sample string 2</UpdateEntityId>
</Entity>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Altai.Web.Services.Models.ViewResults
NameDescriptionTypeAdditional information
Id

System.String

None.

Columns

System.Collections.Generic.List`1[System.String]

None.

TotalColumns

System.Int32

None.

Rows

System.Collections.Generic.List`1[Altai.Web.Services.Models.Entity]

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Columns": [
    "sample string 1",
    "sample string 2"
  ],
  "TotalColumns": 2,
  "Rows": [
    {
      "Id": "sample string 1",
      "UpdateEntityId": "sample string 2",
      "LogicalName": "sample string 3",
      "Attributes": [
        {
          "Label": "sample string 1",
          "AttributeName": "sample string 2",
          "DecimalAttributeValue": 3.0,
          "WholeNumberAttributeValue": 4,
          "AttributeValue": "sample string 5",
          "MoneyAttributeValue": 6.0,
          "OptionSetAttributeValue": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OptionSetValuesAttributeValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "AttributeType": "sample string 7"
        },
        {
          "Label": "sample string 1",
          "AttributeName": "sample string 2",
          "DecimalAttributeValue": 3.0,
          "WholeNumberAttributeValue": 4,
          "AttributeValue": "sample string 5",
          "MoneyAttributeValue": 6.0,
          "OptionSetAttributeValue": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OptionSetValuesAttributeValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "AttributeType": "sample string 7"
        }
      ]
    },
    {
      "Id": "sample string 1",
      "UpdateEntityId": "sample string 2",
      "LogicalName": "sample string 3",
      "Attributes": [
        {
          "Label": "sample string 1",
          "AttributeName": "sample string 2",
          "DecimalAttributeValue": 3.0,
          "WholeNumberAttributeValue": 4,
          "AttributeValue": "sample string 5",
          "MoneyAttributeValue": 6.0,
          "OptionSetAttributeValue": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OptionSetValuesAttributeValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "AttributeType": "sample string 7"
        },
        {
          "Label": "sample string 1",
          "AttributeName": "sample string 2",
          "DecimalAttributeValue": 3.0,
          "WholeNumberAttributeValue": 4,
          "AttributeValue": "sample string 5",
          "MoneyAttributeValue": 6.0,
          "OptionSetAttributeValue": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OptionSetValuesAttributeValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "AttributeType": "sample string 7"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<ViewResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Columns>
  <Id>sample string 1</Id>
  <Rows>
    <Entity>
      <Attributes>
        <Attribute>
          <AttributeName>sample string 2</AttributeName>
          <AttributeType>sample string 7</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>6</MoneyAttributeValue>
          <OptionSetAttributeValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetAttributeValue>
          <OptionSetValuesAttributeValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
          </OptionSetValuesAttributeValue>
          <WholeNumberAttributeValue>4</WholeNumberAttributeValue>
        </Attribute>
        <Attribute>
          <AttributeName>sample string 2</AttributeName>
          <AttributeType>sample string 7</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>6</MoneyAttributeValue>
          <OptionSetAttributeValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetAttributeValue>
          <OptionSetValuesAttributeValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
          </OptionSetValuesAttributeValue>
          <WholeNumberAttributeValue>4</WholeNumberAttributeValue>
        </Attribute>
      </Attributes>
      <Id>sample string 1</Id>
      <LogicalName>sample string 3</LogicalName>
      <UpdateEntityId>sample string 2</UpdateEntityId>
    </Entity>
    <Entity>
      <Attributes>
        <Attribute>
          <AttributeName>sample string 2</AttributeName>
          <AttributeType>sample string 7</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>6</MoneyAttributeValue>
          <OptionSetAttributeValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetAttributeValue>
          <OptionSetValuesAttributeValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
          </OptionSetValuesAttributeValue>
          <WholeNumberAttributeValue>4</WholeNumberAttributeValue>
        </Attribute>
        <Attribute>
          <AttributeName>sample string 2</AttributeName>
          <AttributeType>sample string 7</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>6</MoneyAttributeValue>
          <OptionSetAttributeValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetAttributeValue>
          <OptionSetValuesAttributeValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
            <OptionSetValue>
              <Id>sample string 1</Id>
              <Name>sample string 2</Name>
            </OptionSetValue>
          </OptionSetValuesAttributeValue>
          <WholeNumberAttributeValue>4</WholeNumberAttributeValue>
        </Attribute>
      </Attributes>
      <Id>sample string 1</Id>
      <LogicalName>sample string 3</LogicalName>
      <UpdateEntityId>sample string 2</UpdateEntityId>
    </Entity>
  </Rows>
  <TotalColumns>2</TotalColumns>
</ViewResults>