Importing assets

You define a relation by specifying the relation type, the relation direction and the identifier of the related asset:

"relations": {
  "00000000-0000-0000-0000-000000007030:SOURCE": [
    {
      "name": "Related Asset",
      "domain": {
        "name": "Sample Domain Name",
        "community": {
          "name": "Sample Community Name"
        }
      }
    }
  ]
}

You can specify relation types in multiple ways:

• Using the relation type resource ID and the relation direction separated by a colon, for example: 00000000-0000-0000-0000-000000007042:TARGET.
• Using the relation type public ID and the relation direction separated by a colon, for example: PUBLIC_ID:ColumnIsPartOfTable:TARGET.
• Using a fully qualified relation type name separated by colons and the relation direction also separated by a colon, for example: Schema:contains:is part of:Table:SOURCE.

You can not use the fully qualified name to specify a relation type if the name of the relation type contains a colon.

The relation direction refers to the related asset:

• SOURCE, when the related asset is the head of the relation.
• TARGET, when the related asset is the tail of the relation.

The Import API performs a query for the relations in Collibra and:

• If the same relations exist, the Import API performs no action.
• If the list of relations is different from the one defined in the input, the Import API replaces or creates the relations that are provided in the input and performs no action on the other existing relations.
• If the relations do not exist, the Import API creates them.

You define attributes by specifying the attribute type and the attribute value or values.

When you provide an attribute, the import API performs a query for the attribute in Collibra.

• If the same attributes exist, the Import API performs no action.
• If the list of attributes is different from the one provided in the input exist, the Import API replaces or creates the attributes that are provided in the input and performs no action on the other existing attributes.
• If multi-value attributes exist, the values provided in the input file are updated and the rest of the existing values are deleted.
• If the attributes do not exist, the Import API creates them.

You can use any of the following methods to specify an attribute type but only one at a time:

• The attribute type ID, for example "00000000-0000-0000-0000-000000003115".
• The attribute type name, for example "Descriptive Example".
• The attribute type public ID, for example "DescriptiveExample".

For each attribute type you can provide a list of attribute values.

For attribute types with one value, the structure is as follows:

{
  "value": "Some value"
}

Most attribute types in Collibra have one value.

For attribute types with multiple values, such as Multiple Selection attributes, the structure is as follows:

{
  "values": ["Some value 1", "Some value 2"]
}

To import multiple attributes of the same type, such as Descriptive Example attributes for an asset, the attributes field structure is as follows:

{
  ...
  "attributes": {
    "Descriptive Example": [
      {
        "value": "This is first descriptive example"
      },
      {
        "value": "This is second descriptive example"
      }
    ]
  }
  ...
}

Specifying both a value and a values field results in an error.

You can enable or disable the ability to import responsibilities at asset level by configuring the Asset responsibilities support setting in Collibra Console.

When the setting is disabled and responsibilities are defined at asset level, you get an error.

Setting specific responsibilities on a large number of assets will affect the performance and stability of the system.

Define responsibilities on communities or domains so that the assets can automatically inherit those responsibilities.

You define a responsibility by specifying a resource role, identified by name or ID, and assigning to it one or more users or user groups, identified by ID:

{
  "00000000-0000-0000-0000-000000005018": [
    {
      "user": {
        "id": "00000000-0000-0000-0000-000000900001"
      }
    }
  ],
  "Business Steward": [
    {
      "userGroup": {
        "id": "00000000-0000-0000-0000-000001000002"
      }
    }
  ]
}

The resource roles, users and user groups that define the imported responsibilities must already exist in Collibra.

You must specify each role only once in the list of responsibilities.

You can assign multiple users and multiple user groups to the same role:

"responsibilities": {
  "Chief Data Officer": [
    {
      "user": {
        "id": "00000000-0000-0000-0000-000000900001"
      }
    },
    {
      "user": {
        "id": "00000000-0000-0000-0000-000000900002"
      }
    },
    {
      "userGroup": {
        "id": "00000000-0000-0000-0000-000001000002"
      }
    }
  ]
}

The Import API performs a query for the responsibilities in Collibra and:

• If the same responsibilities exist, the Import API performs no action.
• If responsibilities other than the ones provided in the input exist, they remain unchanged.
• If a responsibility exists with the same role but different assignees, the Import API deletes the existing responsibility and replaces it with the one provided in the input.
• If the responsibilities do not exist, the Import API creates them.

When you provide tags in the input command, they replace any tags that the asset already has. After processing the import command for an asset, only the tags provided in the input are assigned. If you provide an empty tag list in the input, all tags are deleted from the asset.