Skip to main content
Post Relation Definition Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

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.

Body

The RelationDefinitionEntity to be saved.

A relation definition entity with source and destination tables Carrier object for RelationDefinitionEntity. Services for the RelationDefinitionEntity Carrier is available from the List Agent.

ReldefId
integer<int32>

Primary key

Name
string

Active text

Tooltip
string

Tooltip or other description

PassiveText
string

Text used in passive direction

Deleted
boolean

True if deleted

Rank
integer<int32>

Rank order

Source
enum<string>

The source of the relation

Available options:
None,
Contact,
Person,
Both
Destination
enum<string>

The destination of the relation

Available options:
None,
Contact,
Person,
Both
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

OK

A relation definition entity with source and destination tables RelationDefinitionEntity entity with API _Links added.

ReldefId
integer<int32>

Primary key

Name
string

Active text

Tooltip
string

Tooltip or other description

PassiveText
string

Text used in passive direction

Deleted
boolean

True if deleted

Rank
integer<int32>

Rank order

Source
enum<string>

The source of the relation

Available options:
None,
Contact,
Person,
Both
Destination
enum<string>

The destination of the relation

Available options:
None,
Contact,
Person,
Both
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.