Relation Types

Finds all the relation types matching the given criteria.

get

Returns relation types matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned relation types satisfy all constraints that are specified in this search criteria. By default a result containing 1000 relation types is returned.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

sourceTypeIdstring · uuidOptional

The ID of the source type of the Relation Type to search for.

sourceTypeNamestringOptional

The name of the source type of the Relation Type to search for.

rolestringOptional

The name of the role that the source plays to search for.

targetTypeIdstring · uuidOptional

The ID of the target type of the Relation Type to search for.

targetTypeNamestringOptional

The name of the target type of the Relation Type to search for.

coRolestringOptional

The name of the role that the target plays to search for.

sortFieldstring · enumOptional

The field that should be used as reference for sorting.

Default: ROLEPossible values:

sortOrderstring · enumOptional

The order of sorting.

Default: ASCPossible values:

roleCoRoleLogicalOperatorstring · enumOptional

The logical operator determining how to combine the role and coRole criteria: AND or OR.

Default: ANDPossible values:

Responses

200

The paged response of found Relation types.

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/relationTypes

HTTPcURLJavaScriptPython

GET /rest/2.0/relationTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response of found Relation types.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
      "sourceType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "publicId": "text"
      },
      "targetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "publicId": "text"
      },
      "role": "text",
      "coRole": "text",
      "description": "text"
    }
  ]
}

Adds a new relation type.

post

Adds a new relation type.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Body

application/json

idstring · uuidOptional

The ID of the new Relation Type. Should be unique within all Relation Types.
It should have a format of universally unique identifier (UUID) and should not start with 00000000-0000-0000- which is a reserved prefix.

publicIdstringOptional

The public id that will be assigned to the new Relation Type. It must be unique within all Relation Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

sourceTypeIdstring · uuidRequired

The ID of the source type for the new Relation Type.

rolestring · min: 1 · max: 255Required

The name of the role that the source plays.

targetTypeIdstring · uuidRequired

The ID of the source type for the new Relation Type.

coRolestring · min: 1 · max: 255Required

The name of the role that the target plays.

descriptionstring · max: 4000Optional

The description of the Relation Type.

Responses

201

Relation type successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

400

A relation type with the given ID already exists

post/relationTypes

HTTPcURLJavaScriptPython

POST /rest/2.0/relationTypes HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "publicId": "text",
  "sourceTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "role": "text",
  "targetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "coRole": "text",
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
  "sourceType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "targetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "role": "text",
  "coRole": "text",
  "description": "text"
}

Adds multiple new relation type.

post

Adds multiple new relation type.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodyobject · AddRelationTypeRequest[]

application/json

idstring · uuidOptional

The ID of the new Relation Type. Should be unique within all Relation Types.
It should have a format of universally unique identifier (UUID) and should not start with 00000000-0000-0000- which is a reserved prefix.

publicIdstringOptional

The public id that will be assigned to the new Relation Type. It must be unique within all Relation Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

sourceTypeIdstring · uuidRequired

The ID of the source type for the new Relation Type.

rolestring · min: 1 · max: 255Required

The name of the role that the source plays.

targetTypeIdstring · uuidRequired

The ID of the source type for the new Relation Type.

coRolestring · min: 1 · max: 255Required

The name of the role that the target plays.

descriptionstring · max: 4000Optional

The description of the Relation Type.

Responses

201

Relation types successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

post/relationTypes/bulk

HTTPcURLJavaScriptPython

POST /rest/2.0/relationTypes/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 224

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicId": "text",
    "sourceTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "role": "text",
    "targetTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "coRole": "text",
    "description": "text"
  }
]

201

Relation types successfully added.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
    "sourceType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "publicId": "text"
    },
    "targetType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "publicId": "text"
    },
    "role": "text",
    "coRole": "text",
    "description": "text"
  }
]

Removes multiple relation types.

delete

Removes multiple relation types identified by the UUIDs passed as parameter.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

default

default response

application/json

delete/relationTypes/bulk

HTTPcURLJavaScriptPython

DELETE /rest/2.0/relationTypes/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

default

default response

Changes the relation types.

patch

Changes the relation types with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodyobject · ChangeRelationTypeRequest[]

application/json

idstring · uuidRequired

The ID of the Relation Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

publicIdstring · min: 1 · max: 260Optional

The new public id for the Relation Type. It must be unique within all Relation Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

sourceTypeIdstring · uuidOptional

The ID of the new source type for the Relation Type.

rolestring · min: 1 · max: 255Optional

The new name of the role that the source plays.

targetTypeIdstring · uuidOptional

The ID of the new target type for the Relation Type.

coRolestring · min: 1 · max: 255Optional

The new name of the role that the target plays.

descriptionstring · max: 4000Optional

The new description of the Relation Type.

Responses

200

Relation types successfully changed.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

patch/relationTypes/bulk

HTTPcURLJavaScriptPython

PATCH /rest/2.0/relationTypes/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 224

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicId": "text",
    "sourceTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "role": "text",
    "targetTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "coRole": "text",
    "description": "text"
  }
]

200

Relation types successfully changed.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
    "sourceType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "publicId": "text"
    },
    "targetType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "publicId": "text"
    },
    "role": "text",
    "coRole": "text",
    "description": "text"
  }
]

Returns relation type identified by given UUID.

get

Returns relation type identified by given UUID.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

relationTypeIdstring · uuidRequired

The unique identifier of the relationType

Responses

200

Relation Type found.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

404

Relation Type not found.

get/relationTypes/{relationTypeId}

HTTPcURLJavaScriptPython

GET /rest/2.0/relationTypes/{relationTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
  "sourceType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "targetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "role": "text",
  "coRole": "text",
  "description": "text"
}

Removes relation type identified by given UUID.

delete

Removes relation type identified by given UUID.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

relationTypeIdstring · uuidRequired

The unique identifier of the relationType

Responses

default

default response

application/json

delete/relationTypes/{relationTypeId}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/relationTypes/{relationTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

default response

Changes the relation type.

patch

Changes the relation type with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

relationTypeIdstring · uuidRequired

The unique identifier of the relationType

Body

application/json

idstring · uuidRequired

The ID of the Relation Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

publicIdstring · min: 1 · max: 260Optional

The new public id for the Relation Type. It must be unique within all Relation Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

sourceTypeIdstring · uuidOptional

The ID of the new source type for the Relation Type.

rolestring · min: 1 · max: 255Optional

The new name of the role that the source plays.

targetTypeIdstring · uuidOptional

The ID of the new target type for the Relation Type.

coRolestring · min: 1 · max: 255Optional

The new name of the role that the target plays.

descriptionstring · max: 4000Optional

The new description of the Relation Type.

Responses

200

Relation type successfully changed.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

patch/relationTypes/{relationTypeId}

HTTPcURLJavaScriptPython

PATCH /rest/2.0/relationTypes/{relationTypeId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "publicId": "text",
  "sourceTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "role": "text",
  "targetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "coRole": "text",
  "description": "text"
}

200

Relation type successfully changed.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
  "sourceType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "targetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "role": "text",
  "coRole": "text",
  "description": "text"
}

Get the relation type by public id

get

Returns the relation type identified by the given public id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

publicIdstringRequired

The public identifier of the relation type

Responses

200

Relation type found.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

404

Relation type not found.

get/relationTypes/publicId/{publicId}

HTTPcURLJavaScriptPython

GET /rest/2.0/relationTypes/publicId/{publicId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
  "sourceType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "targetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "publicId": "text"
  },
  "role": "text",
  "coRole": "text",
  "description": "text"
}