POST api/log/crm/entity/retrieve
Request Information
URI Parameters
None.
Body Parameters
EntityRetrieveData| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityId | globally unique identifier |
Required |
|
| EntityLogicalName | string |
Required |
|
| InitiatingSystemUserId | globally unique identifier |
Required |
|
| SystemUserId | globally unique identifier |
Required |
|
| AccessType | CRMPluginMessage |
Required |
|
| CRMServer | string |
Required |
|
| AccessTimeUTC | date |
Required |
|
| InsertResult | Result |
None. |
Request Formats
application/json, text/json
Sample:
{
"EntityId": "ce5f4249-32bb-462e-8a35-cb4ed312fc98",
"EntityLogicalName": "sample string 2",
"InitiatingSystemUserId": "48496dfd-defe-4f59-9f22-11467a522d2e",
"SystemUserId": "5a1706af-5844-4549-b420-534cc4f508fd",
"AccessType": 0,
"CRMServer": "sample string 5",
"AccessTimeUTC": "2025-11-14T07:35:21.4433683+00:00",
"InsertResult": {
"Message": "sample string 1",
"Success": true,
"Ex": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
}
}
}
application/xml, text/xml
Sample:
<EntityRetrieveData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tandem.WebAPI.AccessLog.Models">
<AccessTimeUTC>2025-11-14T07:35:21.4433683+00:00</AccessTimeUTC>
<AccessType>DEFAULT</AccessType>
<CRMServer>sample string 5</CRMServer>
<EntityId>ce5f4249-32bb-462e-8a35-cb4ed312fc98</EntityId>
<EntityLogicalName>sample string 2</EntityLogicalName>
<InitiatingSystemUserId>48496dfd-defe-4f59-9f22-11467a522d2e</InitiatingSystemUserId>
<InsertResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tandem.Xrm">
<d2p1:Ex xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
<Message i:nil="true" xmlns="" />
<Data i:nil="true" xmlns="" />
<InnerException i:nil="true" xmlns="" />
<HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
<StackTraceString i:nil="true" xmlns="" />
<RemoteStackTraceString i:nil="true" xmlns="" />
<RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
<ExceptionMethod i:nil="true" xmlns="" />
<HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
<Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
<WatsonBuckets i:nil="true" xmlns="" />
</d2p1:Ex>
<d2p1:Message>sample string 1</d2p1:Message>
<d2p1:Success>true</d2p1:Success>
</InsertResult>
<SystemUserId>5a1706af-5844-4549-b420-534cc4f508fd</SystemUserId>
</EntityRetrieveData>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
APIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| requestid | string |
None. |
|
| success | boolean |
None. |
|
| message | string |
None. |
|
| data | Object |
None. |
|
| status | string |
None. |
|
| errors | Collection of ResponseError |
None. |
|
| warnings | Collection of ResponseWarning |
None. |
Response Formats
application/json, text/json
Sample:
{
"requestid": "sample string 1",
"success": true,
"message": "sample string 3",
"data": {},
"status": "Retrieved",
"errors": [
{
"code": 1,
"message": "sample string 2"
},
{
"code": 1,
"message": "sample string 2"
}
],
"warnings": [
{
"code": 1,
"message": "sample string 2"
},
{
"code": 1,
"message": "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/Tandem.IO.WebAPI.Models">
<data />
<errors>
<ResponseError>
<code>1</code>
<message>sample string 2</message>
</ResponseError>
<ResponseError>
<code>1</code>
<message>sample string 2</message>
</ResponseError>
</errors>
<message>sample string 3</message>
<requestid>sample string 1</requestid>
<status>Retrieved</status>
<success>true</success>
<warnings>
<ResponseWarning>
<code>1</code>
<message>sample string 2</message>
</ResponseWarning>
<ResponseWarning>
<code>1</code>
<message>sample string 2</message>
</ResponseWarning>
</warnings>
</APIResponse>