POST api/DataAccess

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Entities	Collection of Entities	Required
LogicalName	string	Required
APIKey	string	Required
ClientId	string	Required

Request Formats

application/json, text/json

Sample:

{
  "Entities": [
    {
      "Id": "c016dab6-3641-42ae-bc5a-4a46bd29e5b0",
      "Attributes": [
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        },
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        }
      ]
    },
    {
      "Id": "c016dab6-3641-42ae-bc5a-4a46bd29e5b0",
      "Attributes": [
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        },
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        }
      ]
    }
  ],
  "LogicalName": "sample string 1",
  "APIKey": "sample string 2",
  "ClientId": "sample string 3"
}

application/xml, text/xml

Sample:

<EntityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
  <APIKey>sample string 2</APIKey>
  <ClientId>sample string 3</ClientId>
  <Entities>
    <Entities>
      <Attributes>
        <Attribute>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Type>text</Type>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Type>text</Type>
          <Value>sample string 2</Value>
        </Attribute>
      </Attributes>
      <Id>c016dab6-3641-42ae-bc5a-4a46bd29e5b0</Id>
    </Entities>
    <Entities>
      <Attributes>
        <Attribute>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Type>text</Type>
          <Value>sample string 2</Value>
        </Attribute>
        <Attribute>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Type>text</Type>
          <Value>sample string 2</Value>
        </Attribute>
      </Attributes>
      <Id>c016dab6-3641-42ae-bc5a-4a46bd29e5b0</Id>
    </Entities>
  </Entities>
  <LogicalName>sample string 1</LogicalName>
</EntityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse

Name	Type	Additional information
Status	Status	None.
Id	globally unique identifier	None.
Description	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "Id": "b5564cab-dabe-4aa7-8dc9-18ce082798d9",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:

<APIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Response">
  <Description>sample string 2</Description>
  <Id>b5564cab-dabe-4aa7-8dc9-18ce082798d9</Id>
  <Status>Success</Status>
</APIResponse>