POST api/DataAccess

Request Information

URI Parameters

None.

Body Parameters

EntityRequest
NameDescriptionTypeAdditional information
Entities

Collection of Entities

Required

LogicalName

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Entities": [
    {
      "Id": "6735ca9b-fe31-421b-a9a0-202e99e6eae3",
      "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": "6735ca9b-fe31-421b-a9a0-202e99e6eae3",
      "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"
}

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">
  <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>6735ca9b-fe31-421b-a9a0-202e99e6eae3</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>6735ca9b-fe31-421b-a9a0-202e99e6eae3</Id>
    </Entities>
  </Entities>
  <LogicalName>sample string 1</LogicalName>
</EntityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse
NameDescriptionTypeAdditional information
Status

Status

None.

Id

globally unique identifier

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "Id": "d2a1b16e-9de6-4d40-9d19-c7255ac8ec19",
  "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>d2a1b16e-9de6-4d40-9d19-c7255ac8ec19</Id>
  <Status>Success</Status>
</APIResponse>