Get Relation Definition Entity
Gets a RelationDefinitionEntity object.
Calls the List agent service GetRelationDefinitionEntity. NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Path Parameters
The id of the RelationDefinitionEntity to return.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.
Response
RelationDefinitionEntity found.
A relation definition entity with source and destination tables RelationDefinitionEntity entity with API _Links added.
Primary key
Active text
Tooltip or other description
Text used in passive direction
True if deleted
Rank order
The source of the relation
None, Contact, Person, Both The destination of the relation
None, Contact, Person, Both Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Relation Definition EntityNSListAgentGet Ticket Relation Definition EntityNSRelationDefinitionEntityGet All Ticket Relation Definition Entities