---
title: "Returns mappings matching the given search criteria."
method: GET
path: "/mappings"
tags: ["Mappings"]
---

# Returns mappings matching the given search criteria.

`GET /mappings`

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>

## Query parameters

- `offset` integer
- `limit` integer
- `countLimit` integer
- `externalSystemId` string
- `externalEntityId` string
- `mappedResourceId` string
- `mappedResourceType` 'Asset' | 'Domain' | 'Community'
- `syncAction` 'ADD' | 'UPDATE' | 'REMOVE' — Represents the type of the action performed during last successful synchronization

## Response `200`

The paged response with found synchronization information.

- MappingPagedResponse
  - `total` integer — The total number of results.
  - `offset` integer — The offset for the results.
  - `limit` integer — The maximum number of results to be returned.
  - `results` Mapping[] — The list of results.
    - `id` string, uuid, required — The id of the represented object (entity).
    - `createdBy` string, uuid — The id of the user that created this resource.
    - `createdOn` integer — The timestamp (in UTC time standard) of the creation of this resource.
    - `lastModifiedBy` string, uuid — The id of the user who modified this resource the last time.
    - `lastModifiedOn` integer — The timestamp (in UTC time standard) of the last modification of this resource.
    - `system` boolean — Whether this is a system resource or not.
    - `resourceType` 'View' | 'Asset' | 'Community' | 'Domain' | 'AssetType' | 'DomainType' | 'Status' | 'User' | 'ClassificationMatch' | 'UserGroup' | 'Attribute' | 'StringAttribute' | 'ScriptAttribute' | 'BooleanAttribute' | 'DateAttribute' | 'NumericAttribute' | 'SingleValueListAttribute' | 'MultiValueListAttribute' | 'Comment' | 'Attachment' | 'Responsibility' | 'Workflow' | 'Job' | 'Relation' | 'RelationType' | 'ComplexRelation' | 'ComplexRelationType' | 'ArticulationRule' | 'Assignment' | 'Scope' | 'RelationTrace' | 'ValidationRule' | 'DataQualityRule' | 'DataQualityMetric' | 'Address' | 'InstantMessagingAccount' | 'Email' | 'PhoneNumber' | 'Website' | 'Activity' | 'FormProperty' | 'WorkflowTask' | 'ActivityChange' | 'WorkflowInstance' | 'Role' | 'AttributeType' | 'BooleanAttributeType' | 'DateAttributeType' | 'DateTimeAttributeType' | 'MultiValueListAttributeType' | 'NumericAttributeType' | 'ScriptAttributeType' | 'SingleValueListAttributeType' | 'StringAttributeType' | 'ViewSharingRule' | 'ViewAssignmentRule' | 'JdbcDriverFile' | 'JdbcDriver' | 'JdbcIngestionProperties' | 'CsvIngestionProperties' | 'ExcelIngestionProperties' | 'ConnectionStringParameter' | 'AssignedCharacteristicType' | 'Notification' | 'Tag' | 'ComplexRelationLegType' | 'ComplexRelationAttributeType' | 'ComplexRelationLeg' | 'BaseDataType' | 'AdvancedDataType' | 'DiagramPicture' | 'DiagramPictureSharingRule' | 'DiagramPictureAssignmentRule' | 'Rating' | 'Classification' | 'PhysicalDataConnector' | 'Context', required — 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.
    - `externalSystemId` string — The id of the external system that the mapped resource belongs to.
    - `externalEntityId` string — The external id of the mapped resource.
    - `externalEntityUrl` string — The external URL of the mapped resource. Deprecated. This property will be removed in a future version.
    - `description` string — The description of the mapped resource. Deprecated. This property will be removed in a future version.
    - `mappedResource` NamedResourceReferenceImpl — A reference to the resource, including its name.
      - `id` string, uuid, required — The ID of the referenced resource.
      - `name` string — The name of the referenced resource.
      - `resourceType` 'View' | 'Asset' | 'Community' | 'Domain' | 'AssetType' | 'DomainType' | 'Status' | 'User' | 'ClassificationMatch' | 'UserGroup' | 'Attribute' | 'StringAttribute' | 'ScriptAttribute' | 'BooleanAttribute' | 'DateAttribute' | 'NumericAttribute' | 'SingleValueListAttribute' | 'MultiValueListAttribute' | 'Comment' | 'Attachment' | 'Responsibility' | 'Workflow' | 'Job' | 'Relation' | 'RelationType' | 'ComplexRelation' | 'ComplexRelationType' | 'ArticulationRule' | 'Assignment' | 'Scope' | 'RelationTrace' | 'ValidationRule' | 'DataQualityRule' | 'DataQualityMetric' | 'Address' | 'InstantMessagingAccount' | 'Email' | 'PhoneNumber' | 'Website' | 'Activity' | 'FormProperty' | 'WorkflowTask' | 'ActivityChange' | 'WorkflowInstance' | 'Role' | 'AttributeType' | 'BooleanAttributeType' | 'DateAttributeType' | 'DateTimeAttributeType' | 'MultiValueListAttributeType' | 'NumericAttributeType' | 'ScriptAttributeType' | 'SingleValueListAttributeType' | 'StringAttributeType' | 'ViewSharingRule' | 'ViewAssignmentRule' | 'JdbcDriverFile' | 'JdbcDriver' | 'JdbcIngestionProperties' | 'CsvIngestionProperties' | 'ExcelIngestionProperties' | 'ConnectionStringParameter' | 'AssignedCharacteristicType' | 'Notification' | 'Tag' | 'ComplexRelationLegType' | 'ComplexRelationAttributeType' | 'ComplexRelationLeg' | 'BaseDataType' | 'AdvancedDataType' | 'DiagramPicture' | 'DiagramPictureSharingRule' | 'DiagramPictureAssignmentRule' | 'Rating' | 'Classification' | 'PhysicalDataConnector' | 'Context', required — The type of the resource, for example [Community, Asset, Domain, Attribute, Relation, WorkflowInstance].
    - `lastSyncDate` integer — The timestamp (in UTC time standard) of the last synchronization of mapped resource. Deprecated. This property will be removed in a future version.
    - `syncAction` 'ADD' | 'UPDATE' | 'REMOVE' | 'ADD, UPDATE, REMOVE' — Represents the type of the action performed during last successful synchronization

---

[API](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api.md) · [All operations](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/collibra/collibra-data-governance-center-core-api/revisions/6d091bc86a33/schema)
