Importing assets

Copy

Command structure

[
  {
    "resourceType": "Asset",
    "identifier": {
      "name": "Asset 1",
      "domain": {
        "name": "Business Data Domain 1",
        "community": {
          "name": "Data Community"
        }
      }
    },
    "domain": {
      "id": "43215678-1234-1234-1234-123456788765"
    },
    "name": "New Asset 1",
    "displayName": "A1",
    "type": {
      "name": "Column"
    },
    "attributes": {
      "Original Column Name": [
        {
          "value": "XXX_COLUMN_1"
        }
      ],
      "00000000-0000-0000-0001-000500000011": [
        {
          "value": "True"
        }
      ]
    },
    "relations": {
      "00000000-0000-0000-0000-000000007062:SOURCE": [
        {
          "name": "Asset 2",
          "domain": {
            "name": "Data Asset Domain 1",
            "community": {
              "name": "Data Community"
            }
          }
        }
      ],
      "00000000-0000-0000-0000-000000007038:SOURCE": [
        {
          "name": "Table representation Asset",
          "domain": {
            "name": "Business Asset Domain 2",
            "community": {
              "name": "Business Community"
            }
          }
        }
      ]
    },
    "status": {
      "name": "Accepted"
    },
    "tags": [
      "sample",
      "technical",
      "crucial"
    ],
    "responsibilities": {
      "00000000-0000-0000-0000-000000005018": [
        {
          "user": {
            "id": "00000000-0000-0000-0000-000000900001"
          }
        }
      ],
      "Business Steward": [
        {
          "userGroup": {
            "id": "00000000-0000-0000-0000-000001000002"
          }
        }
      ]
    }
  }
]

Identifier

The identifier for an asset may contain any of the following fields:

  • id
  • name and domain identified by id
  • name and domain identified by name and by community identified by id or by name
  • externalSystemId and externalEntityId
Copy

Identifier structure

{
  "id": "12345678-1234-1234-1234-123456788765",
  "name": "Sample Asset Name",
  "domain": {
    "id": "98765678-1234-1234-1234-123456788765",
    "name": "Sample Domain Name",
    "community": {
      "id": "43215678-1234-1234-1234-123456788765",
      "name": "Sample Community Name"
    }
  },
  "externalSystemId": "EXT_SYSTEM",
  "externalEntityId": "Asset_1234"
}
Note 
  • The community and domain fields have the same structure and requirements as the community and domain identifiers.
  • Code snippets in this section may show redundant data to demonstrate the fields accepted by the import API.

Optional fields

Field name Field type Remarks
type id or name Updates the asset type.
attributes ATTRIBUTE_TYPE_ID or ATTRIBUTE_TYPE_NAME Sets or updates the asset attributes.
domain Same as identifier for domain Moves the asset to the domain. Should only be used for updates.
name String

Updates the asset full name. Should only be used for updates.

Important The full name must be unique per domain. For more details, see Asset names.

displayName String Sets or updates the asset display name. One domain may contain multiple assets with the same display name. If not specified, the display name will be the same as the name field
relations RELATION_TYPE_ID:RELATION_DIRECTION Sets or updates the asset relations based on the relation type id and the direction.
responsibilities RESOURCE_ROLE_ID or RESOURCE_ROLE_NAME Creates or replaces responsibilities for the associated community.
status id or name Sets or updates the asset status.
tags list of string values Sets or deletes the asset tags. The operation does not add or update a list of tags.

Expected behavior

The behavior is similar to the import of communities and domains.

Add operation

If the asset needs to be created, the following fields must be provided in order to import successfully:

  • name
  • type
  • domain

Additional information