Entities - Get where-used

API Url

Return a list of references where this entity record is used.

GET

http://localhost:16010/ProMarkREST/web/Entity/where-used/{type}/{id}

Permissions: user

Request headers

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.

Path parameters

Field	Type	Description
id	String	ID of the entity.
type	String	Name of the entity.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
whereUsed	Object[]	Object containing a list of where-used entries.
description	String	The description of the entity where it is used.
entityName	String	Entity name. Used for grouping
entityType	String	Path of the entity.
id	String	The id of the entity where it is used.
internalId	String	InternalId. For links
type	String	Description of the where used type.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK 
{
   "response": {
      "data": {
         "whereUsed": [
           {
                "type": "Department in time queue for employee",
                "id": "SCP",
                "description": "Sheldon Cooper"
                "entityType": "employees",
                "internalId":  "624",
                "entityName": "Employees"
            }
         ]
      }
   }
}

Error 4xx

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.