GET api/Entity?entityName={entityName}

Returns the a collection of entities defined by the specified entityName, attribute, view id and queryText.
The results of the search are returned as option set values where the 200/OK - match found and the list of option set records is in the body of the response.
404/Account Not Found - no match found for the specified account id.
404/Business Category Not Found - no market served found for the specified account.
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityName

The name of the entity in CRM

System.String

Required

Body Parameters

None.

Response Information

Resource Description

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

System.String

None.

Name

System.String

None.

FieldMetadata

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

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "FieldMetadata": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "MaxLength": 3,
      "Required": true
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "MaxLength": 3,
      "Required": true
    }
  ]
}

application/xml, text/xml

Sample:
<WebSuiteEntityMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <FieldMetadata>
    <WebSuiteFieldMetadata>
      <Id>sample string 1</Id>
      <MaxLength>3</MaxLength>
      <Name>sample string 2</Name>
      <Required>true</Required>
    </WebSuiteFieldMetadata>
    <WebSuiteFieldMetadata>
      <Id>sample string 1</Id>
      <MaxLength>3</MaxLength>
      <Name>sample string 2</Name>
      <Required>true</Required>
    </WebSuiteFieldMetadata>
  </FieldMetadata>
  <Id>sample string 1</Id>
  <Name>sample string 2</Name>
</WebSuiteEntityMetadata>