View References
get
/primeapi/restapi/entityReference/{id}
This endpoint returns references that meet the following requirements:
- ${}
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of an entity reference.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityEntityReference
Type:
Show Source
object
-
entityReferenceId(optional):
integer(int64)
The system-generated identfier of a reference.
-
fromId(optional):
integer(int64)
The system-generated identifier of the object the reference is from.
-
fromType:
string
Allowed Values:
[ "PCO", "RISK", "RFI", "ACTIVITY", "WORK_MANAGER_TASK", "CHANGE_EVENT", "PROJECT", "IDEA" ]
The type of the object the reference is from. -
fromTypeRecordCode:
string
The user-specified identifier of an object associated with a reference.
-
link(optional):
string(url)
Read Only:
true
-
projectCode:
string
The user-specified identfier of a project.
-
toId(optional):
integer(int64)
The system-generated identifier of the object a reference is a reference to.
-
toType:
string
Allowed Values:
[ "PCO", "RISK", "RFI", "ACTIVITY", "WORK_MANAGER_TASK", "CHANGE_EVENT", "PROJECT", "IDEA" ]
The type of the object a reference refers to. -
toTypeRecordCode:
string
The user-specified identifier of an object associated with a reference.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceCode:
string
The user-specified identifier of a workspace.
404 Response
The requested object does not exist, or you do not have access to it.