Complex 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 asset for which complex relations should be found.
The ID of the type of complex relations to search for. Deprecated in favour of 'typePublicIds'.
The list of Public ID of the type of complex 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 new complex relation. Should be unique within all complex relations and assets.
It should have a format of universally unique identifier (UUID) and should not start with 00000000-0000-0000- which is a reserved prefix.
The ID of the type of the complex relation.
The public ID of the type of the complex 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.
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 complex 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.
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 complex relation to be removed.
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 complex relation to be modified.
When partialAttributesUpdate is false, all existing attribute values are replaced by the provided ones. If no value is provided for an attribute type, then all corresponding values are removed.When partialAttributesUpdate is true, only the values for the attribute types provided in the request are replaced. If no value is provided for one of them, then the existing values are kept.The default parameter value is false.
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.
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 ComplexRelationType for which the export will be executed.
The Id of the Domain to filter on (optional).
Sets if the export should be stored as an attachment (true) or not (false)
of the provided {@link #domainId}.
The name of the file. (optional) if not provided a name is generated.
Set if the file will include a header (true) or not (false)
Default value is false.
Adds characteristics to support reimport (true) or not (false)
Default value is false.
Remove text formatting (true) or not (false)
Default value is false.
The delimiter character used to separate entries.
If not provided default value ';' is used.
The delimiter character used for quoted entries.
If not provided default value '"' is used.
The delimiter character used to escape separator or quote character.
If not provided default value '\' is used.
default response
Represents a job. Job is a single atomic task that is to be performed asynchronously
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 name of the resource.
Test nameThe type of the job.
IMPORTThe ID of the user that initiated this job.
The visibility of the job.
The progress percentage of the job.
50Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.
The start date of the job.
1488016800The end date of the job.
1488021800The state of the job.
COMPLETEDPossible values: The result of the job.
SUCCESSPossible values: The message of the job.
Import finished in 12s.default response
The Id of the ComplexRelationType for which the export will be executed.
The Id of the Domain to filter on (optional).
Sets if the export should be stored as an attachment (true) or not (false)
of the provided {@link #domainId}.
The name of the file. (optional) if not provided a name is generated.
Set if the file will include a header (true) or not (false)
Default value is false.
Adds characteristics to support reimport (true) or not (false)
Default value is false.
Remove text formatting (true) or not (false)
Default value is false.
The delimiter character used to separate entries.
If not provided default value ';' is used.
The delimiter character used for quoted entries.
If not provided default value '"' is used.
The delimiter character used to escape separator or quote character.
If not provided default value '\' is used.
default response
default response
The Id of the ComplexRelationType for which the export will be executed.
The Id of the Domain to filter on (optional).
Sets if the export should be stored as an attachment (true) or not (false)
of the provided {@link #domainId}.
The name of the file. (optional) if not provided a name is generated.
Set if the file will include a header (true) or not (false)
Default value is false.
Adds characteristics to support reimport (true) or not (false)
Default value is false.
Remove text formatting (true) or not (false)
Default value is false.
The delimiter character used to separate entries.
If not provided default value ';' is used.
The delimiter character used for quoted entries.
If not provided default value '"' is used.
The delimiter character used to escape separator or quote character.
If not provided default value '\' is used.
default response
The ID of the file.
The name of the file.
The MIME type of the file content.
The size of the file.
The extension of the file.
default response
The Id of the ComplexRelationType for which the export will be executed.
The Id of the Domain to filter on (optional).
Sets if the export should be stored as an attachment (true) or not (false)
of the provided {@link #domainId}.
The name of the file. (optional) if not provided a name is generated.
Set if the file will include a header (true) or not (false)
Default value is false.
Adds characteristics to support reimport (true) or not (false)
Default value is false.
Remove text formatting (true) or not (false)
Default value is false.
The name of the sheet.
Set if the Excel file to export will be '.xlsx' file (true) or a '.xls' file (false)
Default value is (true).
default response
Represents a job. Job is a single atomic task that is to be performed asynchronously
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 name of the resource.
Test nameThe type of the job.
IMPORTThe ID of the user that initiated this job.
The visibility of the job.
The progress percentage of the job.
50Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.
The start date of the job.
1488016800The end date of the job.
1488021800The state of the job.
COMPLETEDPossible values: The result of the job.
SUCCESSPossible values: The message of the job.
Import finished in 12s.default response
The Id of the ComplexRelationType for which the export will be executed.
The Id of the Domain to filter on (optional).
Sets if the export should be stored as an attachment (true) or not (false)
of the provided {@link #domainId}.
The name of the file. (optional) if not provided a name is generated.
Set if the file will include a header (true) or not (false)
Default value is false.
Adds characteristics to support reimport (true) or not (false)
Default value is false.
Remove text formatting (true) or not (false)
Default value is false.
The name of the sheet.
Set if the Excel file to export will be '.xlsx' file (true) or a '.xls' file (false)
Default value is (true).
default response
The ID of the file.
The name of the file.
The MIME type of the file content.
The size of the file.
The extension of the file.
default response
Last updated
Was this helpful?