Entities - Get entity data

API Url

Get data for a given entity. If two entities are requested, they must be in a parent-child relationship, {parentId} being the parent.

GET

http://localhost:16010/ProMarkREST/web/Entity/data/{parent}/{parentId}/{child}/{childId}

Permissions: user

Field	Type	Description
Accept	String	Supported request types. Allowed values:`"application/json""text/csv"`
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Field	Type	Description
delimiter`optional`	Boolean	Field delimiter character used when exporting data to CSV. Default is comma ",".
fields`optional`	Number	Query expression used to select what fields should be returned. Example: fields=id,description.
filter`optional`	String	Query expression used for filtering the records. Example: filter=id eq 'A' or description begins 'A'.
includeInactive`optional`	Boolean	FALSE = Return only the active records. TRUE = Return all records including the inactive ones. Default is FALSE. The property is ignored if a 'filter' containing the 'inactive' field exists.
links`optional`	Boolean	TRUE = include the related navigation links of the selected entity record.
skip`optional`	Number	How many records to skip.
sortBy`optional`	String	Query expression used to sort the resulted records. Example: sortBy=id,description desc.
take`optional`	Number	How many records to load.

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
entity	Object[]	Object containing a list of entities, where 'entity' should be replaced with the proper data entity.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

HTTP/1.1 200 OK 
{
   "response": {
      "data": {
         "entity": [
            ...
         ]
      }
   }
}

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.