Relations
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.
0The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.
0Allows 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.
-1Cursor 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).
The ID of the type of relations to search for.
The ID of the source of relations to search for.
The ID of the target of relations to search for.
The logical operator determining how to combine the source and target criteria: AND or OR.
ANDPossible values: The public ID of the type of relations to search for.
OK - The request has succeeded.
The total number of results. -1 when cursor pagination is used.
1000The offset for the results. -1 when cursor pagination is used.
10The maximum number of results to be returned.
100Cursor value to be passed in next request to retrieve next page of results. Not returned on last page or when offset pagination is used.
Unauthorized - Authentication has failed or has not been provided.
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.
The ID of the source of the relation.
The ID of the target of the relation.
The ID of the type of the relation.
The starting date of the relation.
1488016800The ending date of the relation.
1658021800The public ID of the type of the relation.
Created - The request has been fulfilled and resulted in a new resource being created.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
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.
The timestamp representing the starting date of the relation.
The timestamp representing the ending date of the relation.
Bad Request - Request data is malformed or illegal. The request body will contain additional information.
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
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.
The ID of the source of the relation.
The ID of the target of the relation.
The ID of the type of the relation.
The starting date of the relation.
1488016800The ending date of the relation.
1658021800The public ID of the type of the relation.
Created - The request has been fulfilled and resulted in a new resource being created.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
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.
The timestamp representing the starting date of the relation.
The timestamp representing the ending date of the relation.
Bad Request - Request data is malformed or illegal. The request body will contain additional information.
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
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.
No Content - The server has fulfilled the request but does not need to return an entity-body.
No content
Bad Request - Request data is malformed or illegal. The request body will contain additional information.
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
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.
No content
The ID of the relation to be changed. Silently ignored if the ID is provided as path parameter of the request.
The ID of the new source for the relation.
The ID of the new target for the relation.
The new starting date for the relation.
1488016800The new ending date for the relation.
1658021800OK - The request has succeeded.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
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.
The timestamp representing the starting date of the relation.
The timestamp representing the ending date of the relation.
Bad Request - Request data is malformed or illegal. The request body will contain additional information.
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
Not Found - One of the requested resources could not be found or the requested URI is invalid.
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.
the ID of the relation
OK - The request has succeeded.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
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.
The timestamp representing the starting date of the relation.
The timestamp representing the ending date of the relation.
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
Not Found - One of the requested resources could not be found or the requested URI is invalid.
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.
the ID of the relation to remove
No Content - The server has fulfilled the request but does not need to return an entity-body.
No content
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
Not Found - One of the requested resources could not be found or the requested URI is invalid.
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.
No content
The ID of the relation to be changed.
The ID of the relation to be changed. Silently ignored if the ID is provided as path parameter of the request.
The ID of the new source for the relation.
The ID of the new target for the relation.
The new starting date for the relation.
1488016800The new ending date for the relation.
1658021800OK - The request has succeeded.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
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.
The timestamp representing the starting date of the relation.
The timestamp representing the ending date of the relation.
Bad Request - Request data is malformed or illegal. The request body will contain additional information.
Unauthorized - Authentication has failed or has not been provided.
Forbidden - Insufficient permissions to perform the requested operation.
Not Found - One of the requested resources could not be found or the requested URI is invalid.
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.
Last updated
Was this helpful?