GET api/Entity?entityName={entityName}&relationshipName={relationshipName}&viewId={viewId}&entityId={entityId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityName

System.String

Required
relationshipName

System.String

Required
viewId

System.String

Required
entityId

System.String

Required

Body Parameters

None.

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",
          "BooleanAttributeValue": true,
          "MoneyAttributeValue": 7.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 8"
        },
        {
          "Label": "sample string 1",
          "AttributeName": "sample string 2",
          "DecimalAttributeValue": 3.0,
          "WholeNumberAttributeValue": 4,
          "AttributeValue": "sample string 5",
          "BooleanAttributeValue": true,
          "MoneyAttributeValue": 7.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 8"
        }
      ]
    },
    {
      "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",
          "BooleanAttributeValue": true,
          "MoneyAttributeValue": 7.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 8"
        },
        {
          "Label": "sample string 1",
          "AttributeName": "sample string 2",
          "DecimalAttributeValue": 3.0,
          "WholeNumberAttributeValue": 4,
          "AttributeValue": "sample string 5",
          "BooleanAttributeValue": true,
          "MoneyAttributeValue": 7.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 8"
        }
      ]
    }
  ]
}

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 8</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <BooleanAttributeValue>true</BooleanAttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>7</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 8</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <BooleanAttributeValue>true</BooleanAttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>7</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 8</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <BooleanAttributeValue>true</BooleanAttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>7</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 8</AttributeType>
          <AttributeValue>sample string 5</AttributeValue>
          <BooleanAttributeValue>true</BooleanAttributeValue>
          <DecimalAttributeValue>3</DecimalAttributeValue>
          <Label>sample string 1</Label>
          <MoneyAttributeValue>7</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>