Entities - Get entity metadata

API Url

Get metadata for a given entity.

GET

http://localhost:16010/ProMarkREST/web/Entity/metadata/{entity}

Permissions: user

Field	Type	Description
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
entity	String	Name of the entity.

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
preferences	Object	Object containing user view preferences.
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": {
         "preferences": {
            ...
         }
      }
   }
}

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.