> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/import/models.md).

# Models

## The Job object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"Job":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["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"]},"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"The type of the job."},"userId":{"type":"string","description":"The ID of the user that initiated this job.","format":"uuid"},"visibility":{"type":"integer","description":"The visibility of the job.","format":"int32"},"progressPercentage":{"type":"number","description":"The progress percentage of the job.","format":"double"},"cancelable":{"type":"boolean","description":"Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."},"startDate":{"type":"integer","description":"The start date of the job.","format":"int64"},"endDate":{"type":"integer","description":"The end date of the job.","format":"int64"},"state":{"type":"string","description":"The state of the job.","enum":["WAITING","RUNNING","CANCELING","COMPLETED","CANCELED","ERROR"]},"result":{"type":"string","description":"The result of the job.","enum":["NOT_SET","SUCCESS","COMPLETED_WITH_ERROR","FAILURE","ABORTED"]},"message":{"type":"string","description":"The message of the job."}},"description":"Represents a job. Job is a single atomic task that is to be performed asynchronously"}}}}
```

## The ImportCsvInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportCsvInJobRequest":{"required":["escape","quote","separator","template"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Delete the file from the Collibra Platform if the import / synchronization job is successful. <b>The default value</b> is <code>false</code><p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"separator":{"type":"string","description":"The delimiter character used to separate entries. <b>The default value</b> is <code>';'</code>."},"quote":{"type":"string","description":"The delimiter character used for quoted entries. <b>The default value</b>  is <code>'\"'</code>."},"escape":{"type":"string","description":"The delimiter character used to escape separator or quote character. <b>The default value</b> is <code>'\\\\'</code>."},"strictQuotes":{"type":"boolean","description":"Whether the characters outside quotes should be ignored. <b>The default value</b> is <code>false</code>."},"ignoreLeadingWhitespace":{"type":"boolean","description":"Whether whitespace characters before quotes should be ignored. <b>The default value</b> is <code>false</code>."},"headerRow":{"type":"boolean","description":"Whether the first row of the imported CSV file is the header. <b>The default value</b> is <code>false</code>."},"template":{"minLength":1,"type":"string","description":"The template that should be used for parsing and importing the contents of the CSV file.\n\n<br/><p>There is one placeholder currently supported:\n<ul>\n     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li>\n</ul>\n\n<p>Example of a correct JSON template:</p>\n<pre>\n[\n  {\n    \"resourceType\": \"Asset\",\n    \"identifier\": {\n      \"name\": \"${1}\",\n      \"domain\": {\n        \"name\": \"${2}\",\n        \"community\": {\n          \"name\": \"Some Community\"\n        }\n      }\n    },\n    \"attributes\" : {\n      \"00000000-0000-0000-0000-000000003115\" : [ {\n        \"value\" : \"${3}\"\n      } ],\n      \"00000000-0000-0000-0000-000000000222\" : [ {\n        \"value\" : \"${4}\"\n      } ]\n    }\n  }\n]\n</pre>\n"}},"description":"The request defining import call properties from a CSV file."}}}}
```

## The ImportExcelInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportExcelInJobRequest":{"required":["template"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Delete the file from the Collibra Platform if the import / synchronization job is successful. <b>The default value</b> is <code>false</code><p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"sheetName":{"type":"string","description":"The name of the Excel sheet\n\n<br/><p>If the name is <code>null</code> and <code>sheetIndex</code> is <code>null</code>, the first sheet\nof the workbook will be used for the import.\n\n<br/><p>If the name is <code>null</code> and <code>sheetIndex</code> is not <code>null</code>, the sheet\nwith the index specified by value of <code>sheetIndex</code> will be used for the import.\n"},"sheetIndex":{"type":"integer","description":"The index of the Excel sheet\n\n<br/><p>If the index is <code>null</code> and <code>sheetName</code> is <code>null</code>, the first sheet\nof the workbook will be used for the import.\n\n<br/><p>If the index is <code>null</code> and <code>sheetName</code> is not <code>null</code>, the sheet\nwith the name specified by value of <code>sheetName</code> will be used for the import.\n","format":"int32"},"headerRow":{"type":"boolean","description":"Whether the first row of the imported Excel sheet is the header. <b>The default value</b> is <code>false</code>."},"template":{"minLength":1,"type":"string","description":"        The template that should be used for parsing and importing the contents of the Excel file.\n\n        <br/><p>There is one placeholder currently supported:\n        <ul>\n             <li><b>${x}</b> - refers to the n-th column in the Excel file, e.g. ${1}, ${2}, ...)</li>\n        </ul>\n\n        <p>Example of a correct JSON template:</p>\n        <pre>\n        [\n          {\n            \"resourceType\": \"Asset\",\n            \"identifier\": {\n              \"name\": \"${1}\",\n              \"domain\": {\n                \"name\": \"${2}\",\n                \"community\": {\n                  \"name\": \"Some Community\"\n                }\n              }\n            },\n            \"attributes\" : {\n              \"00000000-0000-0000-0000-000000003115\" : [ {\n                \"value\" : \"${3}\"\n              } ],\n              \"00000000-0000-0000-0000-000000000222\" : [ {\n                \"value\" : \"${4}\"\n              } ]\n            }\n          }\n        ]\n        </pre>\n"}},"description":"The request defining import call properties from an Excel file."}}}}
```

## The AssetIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The AssetImportCommand object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"AssetImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/AssetIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"responsibilities":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"name":{"type":"string"},"displayName":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"type":{"$ref":"#/components/schemas/AssetTypeIdentifier"},"status":{"$ref":"#/components/schemas/StatusIdentifier"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValue"}}},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}},"tags":{"type":"array","items":{"type":"string"}},"resourceType":{"type":"string"}}},"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"Owner":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserIdentifier"},"userGroup":{"$ref":"#/components/schemas/UserGroupIdentifier"}}},"UserIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"UserGroupIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"AssetTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"publicId":{"type":"string"}}},"StatusIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"AttributeValue":{"type":"object","properties":{"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}}}
```

## The AssetTypeIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"AssetTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"publicId":{"type":"string"}}}}}}
```

## The AttributeValue object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"AttributeValue":{"type":"object","properties":{"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}}}
```

## The CommunityIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The CommunityImportCommand object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"CommunityImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/CommunityIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"responsibilities":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"},"parent":{"$ref":"#/components/schemas/CommunityIdentifier"},"resourceType":{"type":"string"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"Owner":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserIdentifier"},"userGroup":{"$ref":"#/components/schemas/UserGroupIdentifier"}}},"UserIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"UserGroupIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The ComplexRelationIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ComplexRelationIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}}}},"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The ComplexRelationImportCommand object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ComplexRelationImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/ComplexRelationIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"complexRelationType":{"$ref":"#/components/schemas/ComplexRelationTypeIdentifier"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValue"}}},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}},"resourceType":{"type":"string"}}},"ComplexRelationIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}}}},"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"ComplexRelationTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"AttributeValue":{"type":"object","properties":{"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}}}
```

## The ComplexRelationTypeIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ComplexRelationTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}}}}}
```

## The DomainIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The DomainImportCommand object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"DomainImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/DomainIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"responsibilities":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"name":{"type":"string"},"description":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"type":{"$ref":"#/components/schemas/DomainTypeIdentifier"},"resourceType":{"type":"string"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"Owner":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserIdentifier"},"userGroup":{"$ref":"#/components/schemas/UserGroupIdentifier"}}},"UserIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"UserGroupIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"DomainTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"publicId":{"type":"string"}}}}}}
```

## The DomainTypeIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"DomainTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"publicId":{"type":"string"}}}}}}
```

## The ExternalIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ExternalIdentifier":{"type":"object","properties":{"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"}}}}}}
```

## The ImportJsonInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportJsonInJobRequest":{"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Delete the file from the Collibra Platform if the import / synchronization job is successful. <b>The default value</b> is <code>false</code><p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"allowEmptyAttributeValues":{"type":"boolean","description":"Whether empty attribute values should be allowed during import. <b>The default value</b> is <code>false</code>.<p>When <code>false</code> (default), attribute values that are empty or blank are filtered out and not imported. When <code>true</code>, empty attribute values are preserved and imported as-is."}},"description":"The request defining import call properties from a JSON file.","anyOf":[{"$ref":"#/components/schemas/CommunityImportCommand"},{"$ref":"#/components/schemas/DomainImportCommand"},{"$ref":"#/components/schemas/AssetImportCommand"},{"$ref":"#/components/schemas/MappingImportCommand"},{"$ref":"#/components/schemas/ComplexRelationImportCommand"}]},"CommunityImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/CommunityIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"responsibilities":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"},"parent":{"$ref":"#/components/schemas/CommunityIdentifier"},"resourceType":{"type":"string"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"Owner":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserIdentifier"},"userGroup":{"$ref":"#/components/schemas/UserGroupIdentifier"}}},"UserIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"UserGroupIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"DomainImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/DomainIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"responsibilities":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"name":{"type":"string"},"description":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"type":{"$ref":"#/components/schemas/DomainTypeIdentifier"},"resourceType":{"type":"string"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"DomainTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"publicId":{"type":"string"}}},"AssetImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/AssetIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"responsibilities":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"name":{"type":"string"},"displayName":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"type":{"$ref":"#/components/schemas/AssetTypeIdentifier"},"status":{"$ref":"#/components/schemas/StatusIdentifier"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValue"}}},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}},"tags":{"type":"array","items":{"type":"string"}},"resourceType":{"type":"string"}}},"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"AssetTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"publicId":{"type":"string"}}},"StatusIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"AttributeValue":{"type":"object","properties":{"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"MappingImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/MappingIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"dgcId":{"type":"string","format":"uuid"},"asset":{"$ref":"#/components/schemas/AssetIdentifier"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"complexRelation":{"$ref":"#/components/schemas/ComplexRelationIdentifier"},"extEntityUrl":{"type":"string"},"lastSyncDate":{"type":"integer","format":"int64"},"syncAction":{"type":"string","enum":["ADD","UPDATE","REMOVE"]},"description":{"type":"string"},"resourceType":{"type":"string"}}},"MappingIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"dgcId":{"type":"string","format":"uuid"},"asset":{"$ref":"#/components/schemas/AssetIdentifier"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"complexRelation":{"$ref":"#/components/schemas/ComplexRelationIdentifier"}}},"ComplexRelationIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}}}},"ComplexRelationImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/ComplexRelationIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"complexRelationType":{"$ref":"#/components/schemas/ComplexRelationTypeIdentifier"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValue"}}},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}},"resourceType":{"type":"string"}}},"ComplexRelationTypeIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}}}}}
```

## The MappingIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"MappingIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"dgcId":{"type":"string","format":"uuid"},"asset":{"$ref":"#/components/schemas/AssetIdentifier"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"complexRelation":{"$ref":"#/components/schemas/ComplexRelationIdentifier"}}},"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"ComplexRelationIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}}}}}}}
```

## The MappingImportCommand object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"MappingImportCommand":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/MappingIdentifier"},"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"dgcId":{"type":"string","format":"uuid"},"asset":{"$ref":"#/components/schemas/AssetIdentifier"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"complexRelation":{"$ref":"#/components/schemas/ComplexRelationIdentifier"},"extEntityUrl":{"type":"string"},"lastSyncDate":{"type":"integer","format":"int64"},"syncAction":{"type":"string","enum":["ADD","UPDATE","REMOVE"]},"description":{"type":"string"},"resourceType":{"type":"string"}}},"MappingIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"dgcId":{"type":"string","format":"uuid"},"asset":{"$ref":"#/components/schemas/AssetIdentifier"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"},"complexRelation":{"$ref":"#/components/schemas/ComplexRelationIdentifier"}}},"AssetIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"domain":{"$ref":"#/components/schemas/DomainIdentifier"}}},"DomainIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"},"community":{"$ref":"#/components/schemas/CommunityIdentifier"}}},"CommunityIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"name":{"type":"string"}}},"ComplexRelationIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalSystemId":{"type":"string"},"externalEntityId":{"type":"string"},"relations":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"}}}}}}}}
```

## The Owner object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"Owner":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserIdentifier"},"userGroup":{"$ref":"#/components/schemas/UserGroupIdentifier"}}},"UserIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"UserGroupIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The StatusIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"StatusIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}}}}}
```

## The UserGroupIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"UserGroupIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The UserIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"UserIdentifier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The ImportCommandReference object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportCommandReference":{"type":"object","properties":{"indices":{"type":"array","description":"A list of indices of the import command in the input file.","items":{"type":"integer","description":"A list of indices of the import command in the input file.","format":"int32"}},"identifier":{"type":"string","description":"Import command identifier."}},"description":"A reference to the import command."}}}}
```

## The ImportError object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportError":{"type":"object","properties":{"errorType":{"type":"string","description":"Import error type.","enum":["VALIDATION","RUNTIME"]},"resourceType":{"type":"string","description":"Import resource type.","enum":["COMMUNITY","DOMAIN","ASSET","ATTRIBUTE","RELATION","COMPLEX_RELATION","MAPPING","RESPONSIBILITY"]},"errorMessage":{"type":"string","description":"User friendly error message."},"command":{"$ref":"#/components/schemas/ImportCommandReference"}},"description":"Import job error."},"ImportCommandReference":{"type":"object","properties":{"indices":{"type":"array","description":"A list of indices of the import command in the input file.","items":{"type":"integer","description":"A list of indices of the import command in the input file.","format":"int32"}},"identifier":{"type":"string","description":"Import command identifier."}},"description":"A reference to the import command."}}}}
```

## The ImportErrorPagedResponse object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportErrorPagedResponse":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results.","format":"int64"},"offset":{"type":"integer","description":"The offset for the results.","format":"int64"},"limit":{"type":"integer","description":"The maximum number of results to be returned.","format":"int64"},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/ImportError"}}}},"ImportError":{"type":"object","properties":{"errorType":{"type":"string","description":"Import error type.","enum":["VALIDATION","RUNTIME"]},"resourceType":{"type":"string","description":"Import resource type.","enum":["COMMUNITY","DOMAIN","ASSET","ATTRIBUTE","RELATION","COMPLEX_RELATION","MAPPING","RESPONSIBILITY"]},"errorMessage":{"type":"string","description":"User friendly error message."},"command":{"$ref":"#/components/schemas/ImportCommandReference"}},"description":"Import job error."},"ImportCommandReference":{"type":"object","properties":{"indices":{"type":"array","description":"A list of indices of the import command in the input file.","items":{"type":"integer","description":"A list of indices of the import command in the input file.","format":"int32"}},"identifier":{"type":"string","description":"Import command identifier."}},"description":"A reference to the import command."}}}}
```

## The PagedResponseImportError object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"PagedResponseImportError":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results.","format":"int64"},"offset":{"type":"integer","description":"The offset for the results.","format":"int64"},"limit":{"type":"integer","description":"The maximum number of results to be returned.","format":"int64"},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/ImportError"}}},"description":"Response containing the paged information."},"ImportError":{"type":"object","properties":{"errorType":{"type":"string","description":"Import error type.","enum":["VALIDATION","RUNTIME"]},"resourceType":{"type":"string","description":"Import resource type.","enum":["COMMUNITY","DOMAIN","ASSET","ATTRIBUTE","RELATION","COMPLEX_RELATION","MAPPING","RESPONSIBILITY"]},"errorMessage":{"type":"string","description":"User friendly error message."},"command":{"$ref":"#/components/schemas/ImportCommandReference"}},"description":"Import job error."},"ImportCommandReference":{"type":"object","properties":{"indices":{"type":"array","description":"A list of indices of the import command in the input file.","items":{"type":"integer","description":"A list of indices of the import command in the input file.","format":"int32"}},"identifier":{"type":"string","description":"Import command identifier."}},"description":"A reference to the import command."}}}}
```

## The CategoryReference object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"CategoryReference":{"type":"object","properties":{"id":{"type":"string","description":"The <code>ID</code> of the category.","format":"uuid"},"name":{"type":"string","description":"The name of the category."}},"description":"A reference to the type of resource, for example Physical Data Dictionary or Business Term."}}}}
```

## The ImportCounters object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportCounters":{"type":"object","properties":{"added":{"type":"integer","description":"The number of added resources.","format":"int32"},"removed":{"type":"integer","description":"The number of removed resources.","format":"int32"},"updated":{"type":"integer","description":"The number of updated resources.","format":"int32"}},"description":"The number of added, removed or updated resources."}}}}
```

## The ImportSummary object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ImportSummary":{"type":"object","properties":{"resourceTypes":{"type":"array","description":"A list of the resource type import summary.","items":{"$ref":"#/components/schemas/ResourceTypeSummary"}},"errorsCount":{"type":"integer","description":"The total number of errors the occurred during the import.","format":"int32"},"importJobState":{"type":"string","description":"Import job state.","enum":["COMPLETED","FAILED","COMPLETED_WITH_ERRORS","ABORTED"]}},"description":"A summary of the import."},"ResourceTypeSummary":{"type":"object","properties":{"resourceType":{"type":"string","description":"Import resource type.","enum":["COMMUNITY","DOMAIN","ASSET","ATTRIBUTE","RELATION","COMPLEX_RELATION","MAPPING","RESPONSIBILITY"]},"counters":{"$ref":"#/components/schemas/ImportCounters"},"subcategories":{"type":"array","description":"A detailed summary of the number of resources that have been affected by the import job. This can be empty for some resource types, f.e. <code>Mapping</code>.","items":{"$ref":"#/components/schemas/SubcategorySummary"}}},"description":"A summary of the import for a particular resource, for example Community, Domain or Asset."},"ImportCounters":{"type":"object","properties":{"added":{"type":"integer","description":"The number of added resources.","format":"int32"},"removed":{"type":"integer","description":"The number of removed resources.","format":"int32"},"updated":{"type":"integer","description":"The number of updated resources.","format":"int32"}},"description":"The number of added, removed or updated resources."},"SubcategorySummary":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategoryReference"},"counters":{"$ref":"#/components/schemas/ImportCounters"}},"description":"A summary of the import for a particular type of resource, for example Physical Data Dictionary or Business Term."},"CategoryReference":{"type":"object","properties":{"id":{"type":"string","description":"The <code>ID</code> of the category.","format":"uuid"},"name":{"type":"string","description":"The name of the category."}},"description":"A reference to the type of resource, for example Physical Data Dictionary or Business Term."}}}}
```

## The ResourceTypeSummary object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"ResourceTypeSummary":{"type":"object","properties":{"resourceType":{"type":"string","description":"Import resource type.","enum":["COMMUNITY","DOMAIN","ASSET","ATTRIBUTE","RELATION","COMPLEX_RELATION","MAPPING","RESPONSIBILITY"]},"counters":{"$ref":"#/components/schemas/ImportCounters"},"subcategories":{"type":"array","description":"A detailed summary of the number of resources that have been affected by the import job. This can be empty for some resource types, f.e. <code>Mapping</code>.","items":{"$ref":"#/components/schemas/SubcategorySummary"}}},"description":"A summary of the import for a particular resource, for example Community, Domain or Asset."},"ImportCounters":{"type":"object","properties":{"added":{"type":"integer","description":"The number of added resources.","format":"int32"},"removed":{"type":"integer","description":"The number of removed resources.","format":"int32"},"updated":{"type":"integer","description":"The number of updated resources.","format":"int32"}},"description":"The number of added, removed or updated resources."},"SubcategorySummary":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategoryReference"},"counters":{"$ref":"#/components/schemas/ImportCounters"}},"description":"A summary of the import for a particular type of resource, for example Physical Data Dictionary or Business Term."},"CategoryReference":{"type":"object","properties":{"id":{"type":"string","description":"The <code>ID</code> of the category.","format":"uuid"},"name":{"type":"string","description":"The name of the category."}},"description":"A reference to the type of resource, for example Physical Data Dictionary or Business Term."}}}}
```

## The SubcategorySummary object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SubcategorySummary":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategoryReference"},"counters":{"$ref":"#/components/schemas/ImportCounters"}},"description":"A summary of the import for a particular type of resource, for example Physical Data Dictionary or Business Term."},"CategoryReference":{"type":"object","properties":{"id":{"type":"string","description":"The <code>ID</code> of the category.","format":"uuid"},"name":{"type":"string","description":"The name of the category."}},"description":"A reference to the type of resource, for example Physical Data Dictionary or Business Term."},"ImportCounters":{"type":"object","properties":{"added":{"type":"integer","description":"The number of added resources.","format":"int32"},"removed":{"type":"integer","description":"The number of removed resources.","format":"int32"},"updated":{"type":"integer","description":"The number of updated resources.","format":"int32"}},"description":"The number of added, removed or updated resources."}}}}
```

## The PagedResponseSynchronizationInfo object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"PagedResponseSynchronizationInfo":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results.","format":"int64"},"offset":{"type":"integer","description":"The offset for the results.","format":"int64"},"limit":{"type":"integer","description":"The maximum number of results to be returned.","format":"int64"},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/SynchronizationInfo"}}},"description":"Response containing the paged information."},"SynchronizationInfo":{"type":"object","properties":{"synchronizationId":{"type":"string","description":"The <code>id</code> of the synchronization."}},"description":"Represents a synchronization information."}}}}
```

## The SynchronizationInfo object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationInfo":{"type":"object","properties":{"synchronizationId":{"type":"string","description":"The <code>id</code> of the synchronization."}},"description":"Represents a synchronization information."}}}}
```

## The FindSynchronizationRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"FindSynchronizationRequest":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"countLimit":{"type":"integer","format":"int32"}},"description":"The search criteria for synchronization information.\nOnly parameters that are specified in this request and have not <code>null</code> values are used for filtering.\nAll other parameters are ignored.\nThe returned synchronization information satisfy all constraints that are specified in this search criteria.\nBy default a result containing 1000 synchronization infos is returned.\n"}}}}
```

## The SynchronizationBatchCsvInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationBatchCsvInJobRequest":{"required":["escape","quote","separator","synchronizationId","template"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Whether the file should be deleted after the synchronization job is finished, regardless of the result. <b>The default value</b> is <code>false</code>.<p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"separator":{"type":"string","description":"The delimiter character used to separate entries. <b>The default value</b> is <code>';'</code>."},"quote":{"type":"string","description":"The delimiter character used for quoted entries. <b>The default value</b>  is <code>'\"'</code>."},"escape":{"type":"string","description":"The delimiter character used to escape separator or quote character. <b>The default value</b> is <code>'\\\\'</code>."},"strictQuotes":{"type":"boolean","description":"Whether the characters outside quotes should be ignored. <b>The default value</b> is <code>false</code>."},"ignoreLeadingWhitespace":{"type":"boolean","description":"Whether whitespace characters before quotes should be ignored. <b>The default value</b> is <code>false</code>."},"headerRow":{"type":"boolean","description":"Whether the first row of the synchronized CSV file is the header. <b>The default value</b> is <code>false</code>."},"template":{"minLength":1,"type":"string","description":"    The template that should be used for parsing and synchronizing the contents of the CSV file.\n\n    <br/><p>There is one placeholder currently supported:\n    <ul>\n         <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li>\"\n    </ul>\n\n    <p>Example of a correct JSON template:</p>\n    <pre>\n    [\n      {\n        \"resourceType\": \"Asset\",\n        \"identifier\": {\n          \"name\": \"${1}\",\n          \"domain\": {\n            \"name\": \"${2}\",\n            \"community\": {\n              \"name\": \"Some Community\"\n            }\n          }\n        },\n        \"attributes\" : {\n          \"00000000-0000-0000-0000-000000003115\" : [ {\n            \"value\" : \"${3}\"\n          } ],\n          \"00000000-0000-0000-0000-000000000222\" : [ {\n            \"value\" : \"${4}\"\n          } ]\n        }\n      }\n    ]\n    </pre>\n"}},"description":"The request defining batch synchronization call properties from a CSV file."}}}}
```

## The SynchronizationBatchExcelInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationBatchExcelInJobRequest":{"required":["synchronizationId","template"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Whether the file should be deleted after the synchronization job is finished, regardless of the result. <b>The default value</b> is <code>false</code>.<p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"sheetName":{"type":"string","description":"The name of the Excel sheet.\n\n<br/><p>If the name is <code>null</code> and <code>sheetIndex</code> is <code>null</code>, the first sheet\nof the workbook will be used for the synchronization.\n<br/><p>If the name is <code>null</code> and <code>sheetIndex</code> is not <code>null</code>, the sheet\nwith the index specified by value of <code>sheetIndex</code> will be used for the synchronization.\n"},"sheetIndex":{"type":"integer","description":"The index of the Excel sheet.\n\n<br/><p>If the index is <code>null</code> and <code>sheetName</code> is <code>null</code>, the first sheet\nof the workbook will be used for the synchronization.\n<br/><p>If the index is <code>null</code> and <code>sheetName</code> is not <code>null</code>, the sheet\nwith the name specified by value of <code>sheetName</code> will be used for the synchronization.\n","format":"int32"},"headerRow":{"type":"boolean","description":"Whether the first row of the synchronized Excel file is the header. <b>The default value</b> is <code>false</code>."},"template":{"minLength":1,"type":"string","description":"The template that should be used for parsing and synchronizing the contents of the Excel file.\n\n<br/><p>There is one placeholder currently supported:\n<ul>\n     <li><b>${x}</b> - refers to the n-th column in the Excel file, e.g. ${1}, ${2}, ...)</li>\n</ul>\n<p>Example of a correct JSON template:</p>\n<pre>\n[\n  {\n    \"resourceType\": \"Asset\",\n    \"identifier\": {\n      \"name\": \"${1}\",\n      \"domain\": {\n        \"name\": \"${2}\",\n        \"community\": {\n          \"name\": \"Some Community\"\n        }\n      }\n    },\n    \"attributes\" : {\n      \"00000000-0000-0000-0000-000000003115\" : [ {\n        \"value\" : \"${3}\"\n      } ],\n      \"00000000-0000-0000-0000-000000000222\" : [ {\n        \"value\" : \"${4}\"\n      } ]\n    }\n  }\n]\n</pre>\n"}},"description":"The request defining batch synchronization call properties from a Excel file."}}}}
```

## The SynchronizationBatchJsonInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationBatchJsonInJobRequest":{"required":["synchronizationId"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Whether the file should be deleted after the synchronization job is finished, regardless of the result. <b>The default value</b> is <code>false</code>.<p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"allowEmptyAttributeValues":{"type":"boolean","description":"Whether empty attribute values should be allowed during import. <b>The default value</b> is <code>false</code>.<p>When <code>false</code> (default), attribute values that are empty or blank are filtered out and not imported. When <code>true</code>, empty attribute values are preserved and imported as-is."}},"description":"The request defining synchronization call properties from a JSON file."}}}}
```

## The SynchronizationCsvInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationCsvInJobRequest":{"required":["escape","quote","separator","synchronizationId","template"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Whether the file should be deleted after the synchronization job is finished, regardless of the result. <b>The default value</b> is <code>false</code>.<p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"finalizationStrategy":{"pattern":"REMOVE_RESOURCES|CHANGE_STATUS|IGNORE","type":"string","description":"The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.<br />Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.<br />When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."},"missingAssetStatusId":{"type":"string","description":"If <b>finalizationStrategy</b> is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.","format":"uuid"},"separator":{"type":"string","description":"The delimiter character used to separate entries. <b>The default value</b> is <code>';'</code>."},"quote":{"type":"string","description":"The delimiter character used for quoted entries. <b>The default value</b>  is <code>'\"'</code>."},"escape":{"type":"string","description":"The delimiter character used to escape separator or quote character. <b>The default value</b> is <code>'\\\\'</code>."},"strictQuotes":{"type":"boolean","description":"Whether the characters outside quotes should be ignored. <b>The default value</b> is <code>false</code>."},"ignoreLeadingWhitespace":{"type":"boolean","description":"Whether whitespace characters before quotes should be ignored. <b>The default value</b> is <code>false</code>."},"headerRow":{"type":"boolean","description":"Whether the first row of the synchronized CSV file is the header. <b>The default value</b> is <code>false</code>."},"template":{"minLength":1,"type":"string","description":"The template that should be used for parsing and synchronizing the contents of the CSV file.\n\n<br/><p>There is one placeholder currently supported:\n<ul>\n     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li>\n</ul>\n<p>Example of a correct JSON template:</p>\n<pre>\n[\n  {\n    \"resourceType\": \"Asset\",\n    \"identifier\": {\n      \"name\": \"${1}\",\n      \"domain\": {\n        \"name\": \"${2}\",\n        \"community\": {\n          \"name\": \"Some Community\"\n        }\n      }\n    },\n    \"attributes\" : {\n      \"00000000-0000-0000-0000-000000003115\" : [ {\n        \"value\" : \"${3}\"\n      } ],\n      \"00000000-0000-0000-0000-000000000222\" : [ {\n        \"value\" : \"${4}\"\n      } ]\n    }\n  }\n]\n</pre>\n"},"finalizationParameters":{"type":"object","additionalProperties":{"type":"string"}}},"description":"The request defining synchronization call properties from a CSV file."}}}}
```

## The SynchronizationExcelInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationExcelInJobRequest":{"required":["synchronizationId","template"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Whether the file should be deleted after the synchronization job is finished, regardless of the result. <b>The default value</b> is <code>false</code>.<p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"finalizationStrategy":{"pattern":"REMOVE_RESOURCES|CHANGE_STATUS|IGNORE","type":"string","description":"The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.<br />Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.<br />When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."},"missingAssetStatusId":{"type":"string","description":"If <b>finalizationStrategy</b> is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.","format":"uuid"},"sheetName":{"type":"string","description":"The name of the Excel sheet.\n\n<br/><p>If the name is <code>null</code> and <code>sheetIndex</code> is <code>null</code>, the first sheet\nof the workbook will be used for the synchronization.\n<br/><p>If the name is <code>null</code> and <code>sheetIndex</code> is not <code>null</code>, the sheet\nwith the index specified by value of <code>sheetIndex</code> will be used for the synchronization.\n"},"sheetIndex":{"type":"integer","description":"The index of the Excel sheet.\n\n<br/><p>If the index is <code>null</code> and <code>sheetName</code> is <code>null</code>, the first sheet\nof the workbook will be used for the synchronization.\n<br/><p>If the index is <code>null</code> and <code>sheetName</code> is not <code>null</code>, the sheet\nwith the name specified by value of <code>sheetName</code> will be used for the synchronization.\n","format":"int32"},"headerRow":{"type":"boolean","description":"Whether the first row of the synchronized Excel file is the header. <b>The default value</b> is <code>false</code>."},"template":{"minLength":1,"type":"string","description":"The template that should be used for parsing and synchronizing the contents of the Excel file.\n\n<br/><p>There is one placeholder currently supported:\n<ul>\n     <li><b>${x}</b> - refers to the n-th column in the Excel file, e.g. ${1}, ${2}, ...)</li>\n</ul>\n<p>Example of a correct JSON template:</p>\n<pre>\n[\n  {\n    \"resourceType\": \"Asset\",\n    \"identifier\": {\n      \"name\": \"${1}\",\n      \"domain\": {\n        \"name\": \"${2}\",\n        \"community\": {\n          \"name\": \"Some Community\"\n        }\n      }\n    },\n    \"attributes\" : {\n      \"00000000-0000-0000-0000-000000003115\" : [ {\n        \"value\" : \"${3}\"\n      } ],\n      \"00000000-0000-0000-0000-000000000222\" : [ {\n        \"value\" : \"${4}\"\n      } ]\n    }\n  }\n]\n</pre>\n"},"finalizationParameters":{"type":"object","additionalProperties":{"type":"string"}}},"description":"The request defining synchronization call properties from a Excel file."}}}}
```

## The SynchronizationFinalizationRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationFinalizationRequest":{"required":["synchronizationId"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"finalizationStrategy":{"pattern":"REMOVE_RESOURCES|CHANGE_STATUS|IGNORE","type":"string","description":"The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.<br />Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.<br />When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."},"missingAssetStatusId":{"type":"string","description":"If <b>finalizationStrategy</b> is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.","format":"uuid"},"finalizationParameters":{"required":["STATUS_ID"],"type":"object","additionalProperties":{"required":["STATUS_ID"],"type":"string","description":"If you have set `finalizationStrategy` to `CHANGE_STATUS`, the status ID for the assets that no longer exist in the external system.<p><b>NOTE:</b> This parameter must be declared with an 'application/json' content type.<p><b>DEPRECATED:</b> This parameter is deprecated and will be removed in the future. Please, use </b>missingAssetStatusId</b>.","deprecated":true},"description":"If you have set `finalizationStrategy` to `CHANGE_STATUS`, the status ID for the assets that no longer exist in the external system.<p><b>NOTE:</b> This parameter must be declared with an 'application/json' content type.<p><b>DEPRECATED:</b> This parameter is deprecated and will be removed in the future. Please, use </b>missingAssetStatusId</b>.","deprecated":true},"continueOnError":{"type":"boolean","description":"Whether the operation should continue if some of the finalization steps failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid steps are still committed to the database, which can lead to partial results being stored."}},"description":"The request defining synchronization finalization call properties."}}}}
```

## The SynchronizationJsonInJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Import API","version":"2.0"},"components":{"schemas":{"SynchronizationJsonInJobRequest":{"required":["synchronizationId"],"type":"object","properties":{"sendNotification":{"type":"boolean","description":"Whether job status notification should be sent. <b>The default value</b> is <code>false</code>."},"batchSize":{"minimum":1,"type":"integer","description":"<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>","format":"int64","deprecated":true,"default":1000},"simulation":{"type":"boolean","description":"Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods."},"saveResult":{"type":"boolean","description":"Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.","deprecated":true},"synchronizationId":{"maxLength":50,"minLength":1,"type":"string"},"fileId":{"type":"string","description":"The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.","format":"uuid"},"file":{"type":"string","description":"The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.","format":"binary"},"fileName":{"type":"string","description":"The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set."},"deleteFile":{"type":"boolean","description":"Whether the file should be deleted after the synchronization job is finished, regardless of the result. <b>The default value</b> is <code>false</code>.<p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted."},"continueOnError":{"type":"boolean","description":"Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored."},"relationsAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"attributesAction":{"pattern":"ADD_OR_IGNORE|REPLACE","type":"string"},"finalizationStrategy":{"pattern":"REMOVE_RESOURCES|CHANGE_STATUS|IGNORE","type":"string","description":"The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.<br />Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.<br />When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."},"missingAssetStatusId":{"type":"string","description":"If <b>finalizationStrategy</b> is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.","format":"uuid"},"finalizationParameters":{"type":"object","additionalProperties":{"type":"string"}},"allowEmptyAttributeValues":{"type":"boolean","description":"Whether empty attribute values should be allowed during import. <b>The default value</b> is <code>false</code>.<p>When <code>false</code> (default), attribute values that are empty or blank are filtered out and not imported. When <code>true</code>, empty attribute values are preserved and imported as-is."}},"description":"The request defining synchronization call properties from a JSON file."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.collibra.com/api/references/import/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.