GET api/relationship

Get list of relationships.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/relationship. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of relationships available.

Collection of RelationshipDto

Name	Description	Type	Additional information
RelationshipID	Unique identifier to represent the Relationship list.	integer	Required
Name	Name of relationship.	string	Required
Directional	Determines whether relationship have different name in reverse.	boolean
Active	Denotes whether relationship data is active.	boolean
Reversed	Denotes whether relationship name is a reversed name of other relationship.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "relationshipID": 1,
    "name": "sample string 1",
    "directional": true,
    "active": true,
    "reversed": true
  },
  {
    "relationshipID": 1,
    "name": "sample string 1",
    "directional": true,
    "active": true,
    "reversed": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfRelationshipDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <RelationshipDto>
    <Active>true</Active>
    <Directional>true</Directional>
    <Name>sample string 1</Name>
    <RelationshipID>1</RelationshipID>
    <Reversed>true</Reversed>
  </RelationshipDto>
  <RelationshipDto>
    <Active>true</Active>
    <Directional>true</Directional>
    <Name>sample string 1</Name>
    <RelationshipID>1</RelationshipID>
    <Reversed>true</Reversed>
  </RelationshipDto>
</ArrayOfRelationshipDto>