GET api/Annotation?entityName={entityName}&entityId={entityId}

Retrieve array of annotations for a specific record

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityName

Entity Logical Name

 System.String

Required
entityId

Entity ID

 System.Guid

Required

Body Parameters

None.

Response Information

Resource Description

Array of annotations

System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.Annotation]
NameDescriptionTypeAdditional information
Id

System.Guid

None.
FileName

System.String

None.
CreatedOn

System.DateTime

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "b793a696-87e3-4384-8411-6301d2c4a736",
    "FileName": "sample string 2",
    "CreatedOn": "2025-04-04T08:53:15.790344-04:00"
  },
  {
    "Id": "b793a696-87e3-4384-8411-6301d2c4a736",
    "FileName": "sample string 2",
    "CreatedOn": "2025-04-04T08:53:15.790344-04:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAnnotation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Annotation>
    <CreatedOn>2025-04-04T08:53:15.790344-04:00</CreatedOn>
    <FileName>sample string 2</FileName>
    <Id>b793a696-87e3-4384-8411-6301d2c4a736</Id>
  </Annotation>
  <Annotation>
    <CreatedOn>2025-04-04T08:53:15.790344-04:00</CreatedOn>
    <FileName>sample string 2</FileName>
    <Id>b793a696-87e3-4384-8411-6301d2c4a736</Id>
  </Annotation>
</ArrayOfAnnotation>