Relations

Returns relations matching the given search criteria.

get

Returns relations 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 relations satisfy all constraints that are specified in this search criteria. By default a result containing 1000 relations is returned.

Authorizations

AuthorizationstringRequired

Query parameters

offsetinteger · int32OptionalDeprecated

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0. Cursor should be preferred over offset for better performance and stable results. It is forbidden to use both in the same request.

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 · int32OptionalDeprecated

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped. For cursor pagination this parameter is ignored and count is skipped.

Default: -1

cursorstringOptional

Cursor for the current page of results. To retrieve the first page with cursor pagination you need to pass this parameter with an empty value (must be non-null). For the next pages, the value must be taken from the response (nextCursor property).

relationTypeIdstring · uuidOptional

The ID of the type of relations to search for.

sourceIdstring · uuidOptional

The ID of the source of relations to search for.

targetIdstring · uuidOptional

The ID of the target of relations to search for.

sourceTargetLogicalOperatorstring · enumOptional

The logical operator determining how to combine the source and target criteria: AND or OR.

Default: ANDPossible values:

typePublicIdstringOptional

The public ID of the type of relations to search for.

Responses

200

OK - The request has succeeded.

application/json

totalinteger · int64Optional

The total number of results. -1 when cursor pagination is used.

Example: 1000

offsetinteger · int64Optional

The offset for the results. -1 when cursor pagination is used.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

nextCursorstringOptional

Cursor value to be passed in next request to retrieve next page of results. Not returned on last page or when offset pagination is used.

401

Unauthorized - Authentication has failed or has not been provided.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

get/relations

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

{
  "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,
      "source": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "target": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "type": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      }
    }
  ],
  "nextCursor": "text"
}

Adds a new relation.

post

Adds a new relation.

Authorizations

AuthorizationstringRequired

Body

sourceIdstring · uuidRequired

The ID of the source of the relation. The combination of sourceId, targetId, and typeId must be unique.

targetIdstring · uuidRequired

The ID of the target of the relation. The combination of sourceId, targetId, and typeId must be unique.

typeIdstring · uuidOptional

The ID of the type of the relation. The combination of sourceId, targetId, and typeId must be unique.

startingDateinteger · int64OptionalDeprecated

The starting date of the relation.

Example: 1488016800

endingDateinteger · int64OptionalDeprecated

The ending date of the relation.

Example: 1658021800

typePublicIdstringOptional

The public ID of the type of the relation.

Responses

201

Created - The request has been fulfilled and resulted in a new resource being created.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

startingDateinteger · int64OptionalDeprecated

The timestamp representing the starting date of the relation.

endingDateinteger · int64OptionalDeprecated

The timestamp representing the ending date of the relation.

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

post/relations

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

{
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "targetId": "123e4567-e89b-12d3-a456-426614174000",
  "typeId": "123e4567-e89b-12d3-a456-426614174000",
  "typePublicId": "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,
  "source": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "target": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "type": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community"
  }
}

Adds multiple relations in one go.

post

Adds multiple relations in one gos.

Authorizations

AuthorizationstringRequired

Bodyobject · AddRelationRequest[]

sourceIdstring · uuidRequired

The ID of the source of the relation. The combination of sourceId, targetId, and typeId must be unique.

targetIdstring · uuidRequired

The ID of the target of the relation. The combination of sourceId, targetId, and typeId must be unique.

typeIdstring · uuidOptional

The ID of the type of the relation. The combination of sourceId, targetId, and typeId must be unique.

startingDateinteger · int64OptionalDeprecated

The starting date of the relation.

Example: 1488016800

endingDateinteger · int64OptionalDeprecated

The ending date of the relation.

Example: 1658021800

typePublicIdstringOptional

The public ID of the type of the relation.

Responses

201

Created - The request has been fulfilled and resulted in a new resource being created.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

startingDateinteger · int64OptionalDeprecated

The timestamp representing the starting date of the relation.

endingDateinteger · int64OptionalDeprecated

The timestamp representing the ending date of the relation.

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

post/relations/bulk

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

[
  {
    "sourceId": "123e4567-e89b-12d3-a456-426614174000",
    "targetId": "123e4567-e89b-12d3-a456-426614174000",
    "typeId": "123e4567-e89b-12d3-a456-426614174000",
    "typePublicId": "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,
    "source": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "target": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "type": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community"
    }
  }
]

Removes multiple relations.

delete

Removes multiple relations.

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

204

No Content - The server has fulfilled the request but does not need to return an entity-body.

No content

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

delete/relations/bulk

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

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

No content

Deprecated

Changes multiple relations.

patch

Changes multiple relations. This API is deprecated, use removeRelations with addRelations instead.

Authorizations

AuthorizationstringRequired

Bodyobject · ChangeRelationRequest[]

idstring · uuidRequired

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

sourceIdstring · uuidOptional

The ID of the new source for the relation.

targetIdstring · uuidOptional

The ID of the new target for the relation.

startingDateinteger · int64OptionalDeprecated

The new starting date for the relation.

Example: 1488016800

endingDateinteger · int64OptionalDeprecated

The new ending date for the relation.

Example: 1658021800

Responses

200

OK - The request has succeeded.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

startingDateinteger · int64OptionalDeprecated

The timestamp representing the starting date of the relation.

endingDateinteger · int64OptionalDeprecated

The timestamp representing the ending date of the relation.

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

patch/relations/bulk

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

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sourceId": "123e4567-e89b-12d3-a456-426614174000",
    "targetId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

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

Returns a relation identified by given id.

get

Returns a relation identified by given id.

Authorizations

AuthorizationstringRequired

Path parameters

relationIdstring · uuidRequired

the ID of the relation

Responses

200

OK - The request has succeeded.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

startingDateinteger · int64OptionalDeprecated

The timestamp representing the starting date of the relation.

endingDateinteger · int64OptionalDeprecated

The timestamp representing the ending date of the relation.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

get/relations/{relationId}

GET /rest/2.0/relations/{relationId} 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,
  "source": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "target": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "type": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community"
  }
}

Removes a relation identified by given id.

delete

Removes a relation identified by given id.

Authorizations

AuthorizationstringRequired

Path parameters

relationIdstring · uuidRequired

the ID of the relation to remove

Responses

204

No Content - The server has fulfilled the request but does not need to return an entity-body.

No content

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

delete/relations/{relationId}

DELETE /rest/2.0/relations/{relationId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Deprecated

Changes the relation with the information that is present in the request.

patch

Changes the relation 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. This API is deprecated, use removeRelation with addRelation instead.

Authorizations

AuthorizationstringRequired

Path parameters

relationIdstring · uuidRequired

The ID of the relation to be changed.

Body

idstring · uuidRequired

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

sourceIdstring · uuidOptional

The ID of the new source for the relation.

targetIdstring · uuidOptional

The ID of the new target for the relation.

startingDateinteger · int64OptionalDeprecated

The new starting date for the relation.

Example: 1488016800

endingDateinteger · int64OptionalDeprecated

The new ending date for the relation.

Example: 1658021800

Responses

200

OK - The request has succeeded.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

startingDateinteger · int64OptionalDeprecated

The timestamp representing the starting date of the relation.

endingDateinteger · int64OptionalDeprecated

The timestamp representing the ending date of the relation.

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

patch/relations/{relationId}

PATCH /rest/2.0/relations/{relationId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "targetId": "123e4567-e89b-12d3-a456-426614174000"
}

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