latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Mappings

Returns mappings matching the given search criteria.

Returns mappings matching the given search criteria.<p>Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored.</p>The returned synchronization information satisfies all constraints that are specified in this search criteria. By default a result containing 1000 mappings is returned.</p>

get/mappings

Query parameters

offsetinteger

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

limitinteger

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

countLimitinteger

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

externalSystemIdstring

The ID of the external system that the mapped resource belongs to.

externalEntityIdstring

The external ID of the mapped resource.

mappedResourceIdstring

The ID of the mapped resource.

mappedResourceType'Asset' | 'Domain' | 'Community'

The type of the mapped resource.

syncAction'ADD' | 'UPDATE' | 'REMOVE'

Represents the type of the action performed during last successful synchronization

The type of the action performed during last successful synchronization. Deprecated. This property will be removed in a future version.

Response

The paged response with found synchronization information.

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.