Lumada Data Catalog REST API Reference: Tag Associations

Endpoints under /tagassociation provide access to TagAssociation objects in the Waterline Data repository. A tag association object defines the relationship of a tag to a specific data resource (folders, files, collections, and tables) or specific field in a data resource.
Tag associations can be made manually through API calls or the UI, or automatically through a Waterline Data tag discovery operation. Tag discovery can be made using the patterns from specific field values ("valueEnabled":"true" for the tag) or through matching field values against a regular expression ("regexEnabled":"true" for the tag). Tag associations have a "tagState" whose value is "ACCEPTED", "REJECTED", or "SUGGESTED".

When a tag association is made manually, the state is "accepted".
The first manual tag association created in the UI is automatically marked with the "semantic" = "sample". This setting must be explicitly marked when adding a tag association through the API.
Tag discovery marks tag associations as "suggested". Users can convert a "suggested" tag association to "accepted" in the UI or the API.
A "suggested" tag association can also be "rejected" by users in the UI or through the API. A rejected tag association contributes to the tag discovery learning algorithm; the tag association object remains, but is marked "rejected".
An "accepted" or "rejected" tag association can be removed by users in the UI or through the API.

POST /v2/tagassociation

A POST request to the /tagassociation endpoint creates an association between an existing tag and an existing data resource or existing field in a data resource. If a matching tag association already exists as "rejected" or "suggested", this call promotes the tagState to "accepted". To create many tag associations, consider using tagassociation/list.

Request Body
media type	data type	description
application/json	TagAssociation (JSON)	A JSON object identifying the tag, data resource, and if used, the field that the tag will be associated with. It must include the state of the new association, such as "ACCEPTED", "SUGGESTED", or "REJECTED".

Response Body
media type	data type	description
application/json	TagAssociation (JSON)	The new tag association object, in JSON format.

Example

Request

POST /v2/tagassociation
Content-Type: application/json
Accept: application/json

                
{
  "weight" : 12345.0,
  "semantic" : "ATTRIBUTE_SAMPLE",
  "state" : "SUGGESTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "weight" : 12345.0,
  "semantic" : "ATTRIBUTE_SAMPLE",
  "state" : "ACCEPTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

GET /v2/tagassociation/byfield

A GET request to the /tagassociation/byfield endpoint retrieves all tag associations for a given field in a data resource.

Request Parameters
name	type	description
fieldName	query	The field name.
resourcePath	query	The name of the data resource that contains the field. For HDFS files, this name includes the full path describing the resource's location in the file system. The path is a slash-delimited string starting with a slash. For example: "/user/me/myproject/myfile."
sourceName	query	The name string of an existing data source that hosts the data resource. Retrieve the valid values using `datasource` endpoint.

Response Body
media type	data type	description
application/json	array of TagAssociation (JSON)	A JSON list containing an array of zero or more TagAssociation objects.

Example

Request

GET /v2/tagassociation/byfield
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "weight" : 12345.0,
  "semantic" : "ATTRIBUTE",
  "state" : "SUGGESTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

GET /v2/tagassociation/byresource

A GET request to the /tagassociation/byresource endpoint retrieves all tag associations for a given data resource.

Request Parameters
name	type	description
resourcePath	query	The data resource name. For HDFS files, this name includes the full path describing the resource's location in the file system. The path is a slash-delimited string starting with a slash. For example: "/user/me/myproject/myfile."
sourceName	query	The name string of an existing data source that hosts the data resource. Retrieve the valid values using `datasource` endpoint.

Response Body
media type	data type	description
application/json	array of TagAssociation (JSON)	A JSON list containing an array of zero or more TagAssociation objects.

Example

Request

GET /v2/tagassociation/byresource
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "weight" : 12345.0,
  "semantic" : "SAMPLE",
  "state" : "SUGGESTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

POST /v2/tagassociation/list

A POST request to the /tagassociation/list endpoint creates tag associations for a list of tag and data resource or field pairs.
If a matching tag association already exists as "rejected" or "suggested," this call promotes the tagState to "accepted."
If a matching tag association already exists as "accepted" this call will ignore that tag association.
If a tag association contains invalid field name, this call will ignore that tag association. You can create single tag associations with a single call to tagassociation.

Request Body
media type	data type	description
application/json	array of TagAssociation (JSON)	A JSON list containing a set of TagAssociation objects, each one identifying a tag by its unique key, and the key of the associated data resource. If the tag association is on a field, the field is specified by name.

Example

Request

POST /v2/tagassociation/list
Content-Type: application/json

                
[ {
  "weight" : 12345.0,
  "semantic" : "ATTRIBUTE",
  "state" : "ACCEPTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

Response

HTTP/1.1 201 Created

PUT /v2/tagassociation/list

A PUT request to the /tagassociation/list endpoint updates existing tag associations for a list of tag associations. Update a tag association to change its state or semantic. The semantic indicates that the tag association identifies a field to be used for sample data in tag discovery operations. You can update a single tag association with a call to tagassociation/{key}.

Request Body
media type	data type	description
application/json	array of TagAssociation (JSON)	A JSON list containing a set of TagAssociation objects, each one identifying a tag by its unique key, and the key of the associated data resource. If the tag association is on a field, the field is specified by name.

Example

Request

PUT /v2/tagassociation/list
Content-Type: application/json

                
[ {
  "weight" : 12345.0,
  "semantic" : "OTHER",
  "state" : "ACCEPTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

Response

HTTP/1.1 204 No Content

DELETE /v2/tagassociation/{key}

A DELETE request to the /tagassociation/{key} endpoint deletes the association between an existing tag and a field or resource. Note that to delete a tag associations, the association's state must be "ACCEPTED" or "REJECTED". To delete a tag association with a state of "SUGGESTED", use the PUT tagassociation/{key} to change its state before deleting the tag association. A successful request calls returns "Tag association successfully deleted from field." If the tag is not currently associated with the field, the call returns a success message and does nothing.

Request Parameters
name	type	description
key	path	The unique identifying key of the TagAssociation object.

Example

Request

DELETE /v2/tagassociation/{key}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /v2/tagassociation/{key}

A GET request to the /tagassociation/{key} endpoint retrieves a TagAssociation object.

Request Parameters
name	type	description
key	path	The unique identifying key of the TagAssociation object.

Response Body
media type	data type	description
application/json	TagAssociation (JSON)	The TagAssociation object in JSON format.

Example

Request

GET /v2/tagassociation/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "weight" : 12345.0,
  "semantic" : "OTHER",
  "state" : "ACCEPTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

PUT /v2/tagassociation/{key}

A PUT request to the /tagassociation/{key} endpoint updates an existing tag association. Update a tag association to change its state or semantic. The semantic indicates that the tag association identifies a field to be used for sample data in tag discovery operations. You can update multiple tag associations with a single call to tagassociation/list.

Request Parameters
name	type	description
key	path	The unique identifying key of the TagAssociation object.

Request Body
media type	data type	description
application/json	TagAssociation (JSON)	A JSON object containing the properties to be updated and their new values. Properties that are not present are not changed.

Response Body
media type	data type	description
application/json	TagAssociation (JSON)	The updated TagAssociation object in JSON format.

Example

Request

PUT /v2/tagassociation/{key}
Content-Type: application/json
Accept: application/json

                
{
  "weight" : 12345.0,
  "semantic" : "OTHER",
  "state" : "ACCEPTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "weight" : 12345.0,
  "semantic" : "ATTRIBUTE_SAMPLE",
  "state" : "REJECTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

GET /v2/tagassociation/field-tag-domain-list/{resourceKey}

A GET request to the /field-tag-domain-list/{resourceKey} endpoint retrieves the number of tag domains for each field.

Request Parameters
name	type	description
resourceKey	path	The unique identifying key of the resource.

Response Body
media type	data type	description
application/json	TagDomainCountByResource (JSON)	.

Example

Request

GET /v2/tagassociation/field-tag-domain-list/{resourceKey}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagDomainList" : [ {
    "tagIdList" : [ "...", "..." ],
    "count" : 12345,
    "tagDomainName" : "..."
  }, {
    "tagIdList" : [ "...", "..." ],
    "count" : 12345,
    "tagDomainName" : "..."
  } ]
}

POST /v2/tagassociation/list/byresource

Request Body
media type	data type
application/json	TagAssociationRequest (JSON)

Response Body
media type	data type	description
application/json	map of array of TagAssociation (JSON)

Example

Request

POST /v2/tagassociation/list/byresource
Content-Type: application/json
Accept: application/json

                
{
  "resourceKeys" : [ "...", "..." ],
  "tagKey" : "...",
  "states" : [ "ACCEPTED", "ACCEPTED" ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "..." : {
    "weight" : 12345.0,
    "semantic" : "SAMPLE",
    "state" : "SUGGESTED",
    "field" : "...",
    "tagKey" : "...",
    "sourceKey" : "...",
    "tagName" : "...",
    "rules" : [ "...", "..." ],
    "resourceKey" : "...",
    "domainName" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }
} ]

GET /v2/tagassociation/resource/{key}

A GET request to the /tagassociation/resource/{key} endpoint retrieves all tag associations for a given data resource.

Request Parameters
name	type	description
key	path	The unique identifying key of the resource.

Response Body
media type	data type	description
application/json	array of TagAssociation (JSON)	A JSON list containing an array of zero or more TagAssociation objects.

Example

Request

GET /v2/tagassociation/resource/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "weight" : 12345.0,
  "semantic" : "DATES",
  "state" : "REJECTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

GET /v2/tagassociation/tag/{key}

A GET request to the /tagassociation/tag/{key} endpoint retrieves all tag associations for a given tag.

Request Parameters
name	type	description
key	path	The unique identifying key of the tag.

Response Body
media type	data type	description
application/json	array of TagAssociation (JSON)	A JSON list containing an array of zero or more TagAssociation objects.

Example

Request

GET /v2/tagassociation/tag/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "weight" : 12345.0,
  "semantic" : "ATTRIBUTE",
  "state" : "ACCEPTED",
  "field" : "...",
  "tagKey" : "...",
  "sourceKey" : "...",
  "tagName" : "...",
  "rules" : [ "...", "..." ],
  "resourceKey" : "...",
  "domainName" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

GET /v2/tagassociation/counts/domainlevel/all

A GET request to the /tagassociation/counts/domainlevel/all endpoint retrieves a summary of tag association counts for the entire domain. The tag association counts are grouped by tag association state.

Response Body
media type	data type	description
application/json	map of AssociationCount (JSON)	A map of the tag association counts by state for each tag in the domain.

Example

Request

GET /v2/tagassociation/counts/domainlevel/all
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "..." : {
    "sample" : 12345,
    "other" : 12345,
    "suggested" : 12345,
    "field" : 12345,
    "resource" : 12345,
    "rejected" : 12345,
    "accepted" : 12345
  }
}

GET /v2/tagassociation/tag/container/{key}

A GET request to the /tagassociation/tag/container/{key} endpoint retrieves all tag associations for the identified tag and any tags underneath this tag in the glossary hierarchy. This endpoint is used by the Catalog view in the UI to search by topic.

Request Parameters
name	type	description
key	path	The unique identifying key of the tag.

Response Body
media type	data type	description
application/json	TagAssociationContainer (JSON)	A JSON list containing an array of zero or more TagAssociation objects.

Example

Request

GET /v2/tagassociation/tag/container/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "resources" : [ {
    "permToReadMap" : {
      "property1" : true,
      "property2" : true
    },
    "dataSetId" : "...",
    "canAssociateTag" : true,
    "partitionCount" : 12345,
    "owner" : "...",
    "xmlRowTag" : "...",
    "separator" : "...",
    "dataSourceName" : "...",
    "errorMsg" : "...",
    "permittedToRead" : true,
    "timeOfResourceChange" : 12345,
    "resourcePath" : "...",
    "allowedTagDomainKeys" : [ "...", "..." ],
    "dataSetRoot" : true,
    "timeOfResourceCreation" : 12345,
    "timeOfResourceAccess" : 12345,
    "dataSetMember" : true,
    "subscribersCount" : 12345,
    "dataSetVirtualFolders" : [ "...", "..." ],
    "resourceState" : "...",
    "datasetVirtualFolderName" : "...",
    "name" : "...",
    "reportedFields" : [ {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    }, {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    } ],
    "timeOfLastProfile" : 12345,
    "dataSourceType" : "...",
    "tableType" : "...",
    "runId" : "...",
    "joinResources" : [ "...", "..." ],
    "collectionRoot" : true,
    "parquetBinaryAsString" : true,
    "partitionDefinition" : [ "...", "..." ],
    "processedTime" : 12345,
    "origins" : [ "...", "..." ],
    "logicalFolderContext" : "...",
    "dataSetPathSpecs" : {
      "property1" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ],
      "property2" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ]
    },
    "fieldCount" : 12345,
    "timeOfLastRefresh" : 12345,
    "curationCount" : 12345,
    "dataSetRootResource" : "...",
    "browseContextDataset" : "...",
    "canRunJob" : true,
    "fileFormat" : "...",
    "canAddOrRemoveResourceFromDataset" : true,
    "dataPermitted" : true,
    "headerRow" : 12345,
    "rowCount" : 12345,
    "databaseName" : "...",
    "experts" : {
      "expertsType" : "DERIVED",
      "experts" : [ "...", "..." ]
    },
    "favorite" : true,
    "resourceType" : "...",
    "xmlRootTag" : "...",
    "joinConditions" : [ {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    }, {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    } ],
    "logicalFolders" : [ "...", "..." ],
    "dataSetSchemaVersion" : 12345,
    "header" : true,
    "averageRating" : 12345.0,
    "lastPartitionProfile" : true,
    "sensitivity" : "...",
    "dataSourceUri" : "...",
    "canCreateHiveTableOrView" : true,
    "landing" : true,
    "fields" : [ {
      "dataType" : "DOUBLE",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    }, {
      "dataType" : "STRING",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    } ],
    "resourceSize" : 12345,
    "dataSchemaName" : "...",
    "usageCount" : 12345,
    "detailedStatus" : [ {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    }, {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    } ],
    "tagAssociationViewList" : [ {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    }, {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    } ],
    "virtualFolderContextName" : "...",
    "dataSourceKey" : "...",
    "ratingCount" : 12345,
    "fileFormatDisplay" : "...",
    "canDisassociateTag" : true,
    "tableName" : "...",
    "status" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "permToReadMap" : {
      "property1" : true,
      "property2" : true
    },
    "dataSetId" : "...",
    "canAssociateTag" : true,
    "partitionCount" : 12345,
    "owner" : "...",
    "xmlRowTag" : "...",
    "separator" : "...",
    "dataSourceName" : "...",
    "errorMsg" : "...",
    "permittedToRead" : true,
    "timeOfResourceChange" : 12345,
    "resourcePath" : "...",
    "allowedTagDomainKeys" : [ "...", "..." ],
    "dataSetRoot" : true,
    "timeOfResourceCreation" : 12345,
    "timeOfResourceAccess" : 12345,
    "dataSetMember" : true,
    "subscribersCount" : 12345,
    "dataSetVirtualFolders" : [ "...", "..." ],
    "resourceState" : "...",
    "datasetVirtualFolderName" : "...",
    "name" : "...",
    "reportedFields" : [ {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    }, {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    } ],
    "timeOfLastProfile" : 12345,
    "dataSourceType" : "...",
    "tableType" : "...",
    "runId" : "...",
    "joinResources" : [ "...", "..." ],
    "collectionRoot" : true,
    "parquetBinaryAsString" : true,
    "partitionDefinition" : [ "...", "..." ],
    "processedTime" : 12345,
    "origins" : [ "...", "..." ],
    "logicalFolderContext" : "...",
    "dataSetPathSpecs" : {
      "property1" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ],
      "property2" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ]
    },
    "fieldCount" : 12345,
    "timeOfLastRefresh" : 12345,
    "curationCount" : 12345,
    "dataSetRootResource" : "...",
    "browseContextDataset" : "...",
    "canRunJob" : true,
    "fileFormat" : "...",
    "canAddOrRemoveResourceFromDataset" : true,
    "dataPermitted" : true,
    "headerRow" : 12345,
    "rowCount" : 12345,
    "databaseName" : "...",
    "experts" : {
      "expertsType" : "MANUAL",
      "experts" : [ "...", "..." ]
    },
    "favorite" : true,
    "resourceType" : "...",
    "xmlRootTag" : "...",
    "joinConditions" : [ {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    }, {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    } ],
    "logicalFolders" : [ "...", "..." ],
    "dataSetSchemaVersion" : 12345,
    "header" : true,
    "averageRating" : 12345.0,
    "lastPartitionProfile" : true,
    "sensitivity" : "...",
    "dataSourceUri" : "...",
    "canCreateHiveTableOrView" : true,
    "landing" : true,
    "fields" : [ {
      "dataType" : "BYTE",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    }, {
      "dataType" : "TIMESTAMP",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    } ],
    "resourceSize" : 12345,
    "dataSchemaName" : "...",
    "usageCount" : 12345,
    "detailedStatus" : [ {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    }, {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    } ],
    "tagAssociationViewList" : [ {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    }, {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    } ],
    "virtualFolderContextName" : "...",
    "dataSourceKey" : "...",
    "ratingCount" : 12345,
    "fileFormatDisplay" : "...",
    "canDisassociateTag" : true,
    "tableName" : "...",
    "status" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "tagAssociationViewList" : [ {
    "tagKey" : "...",
    "rules" : [ "...", "..." ],
    "key" : "...",
    "state" : "...",
    "timeOfLastChange" : 12345,
    "tagName" : "...",
    "timeOfCreation" : 12345,
    "domainKey" : "...",
    "domainName" : "...",
    "resourceKey" : "...",
    "semantic" : "...",
    "weight" : 12345.0,
    "field" : "..."
  }, {
    "tagKey" : "...",
    "rules" : [ "...", "..." ],
    "key" : "...",
    "state" : "...",
    "timeOfLastChange" : 12345,
    "tagName" : "...",
    "timeOfCreation" : 12345,
    "domainKey" : "...",
    "domainName" : "...",
    "resourceKey" : "...",
    "semantic" : "...",
    "weight" : 12345.0,
    "field" : "..."
  } ]
}

GET /v2/tagassociation/counts/taglevel/domain/{key}

A GET request to the /tagassociation/counts/taglevel/domain/{key} endpoint retrieves the number of tag associations for each tag in a domain. The tag association counts are grouped by the state of each tag association.

Request Parameters
name	type	description
key	path	The unique identifying key of the tag domain.

Response Body
media type	data type	description
application/json	map of AssociationCount (JSON)	A map of the tag association counts by state for each tag in the domain.

Example

Request

GET /v2/tagassociation/counts/taglevel/domain/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "..." : {
    "sample" : 12345,
    "other" : 12345,
    "suggested" : 12345,
    "field" : 12345,
    "resource" : 12345,
    "rejected" : 12345,
    "accepted" : 12345
  }
}

GET /v2/tagassociation/counts/taglevel/tag/{key}

A GET request to the /tagassociation/counts/taglevel/tag/{key} endpoint retrieves the number of tag associations for the given tag. The tag association counts are grouped by the state of each tag association.

Request Parameters
name	type	description
key	path	The unique identifying key of the tag.

Response Body
media type	data type	description
application/json	map of AssociationCount (JSON)	A map of the tag association counts by state for the tag.

Example

Request

GET /v2/tagassociation/counts/taglevel/tag/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "..." : {
    "sample" : 12345,
    "other" : 12345,
    "suggested" : 12345,
    "field" : 12345,
    "resource" : 12345,
    "rejected" : 12345,
    "accepted" : 12345
  }
}

Tag Associations Resource

POST /v2/tagassociation

Example

Request

Response

GET /v2/tagassociation/byfield

Example

Request

Response

GET /v2/tagassociation/byresource

Example

Request

Response

POST /v2/tagassociation/list

Example

Request

Response

PUT /v2/tagassociation/list

Example

Request

Response

DELETE /v2/tagassociation/{key}

Example

Request

Response

GET /v2/tagassociation/{key}

Example

Request

Response

PUT /v2/tagassociation/{key}

Example

Request

Response

GET /v2/tagassociation/field-tag-domain-list/{resourceKey}

Example

Request

Response

POST /v2/tagassociation/list/byresource

Example

Request

Response

GET /v2/tagassociation/resource/{key}

Example

Request

Response

GET /v2/tagassociation/tag/{key}

Example

Request

Response

GET /v2/tagassociation/counts/domainlevel/all

Example

Request

Response

GET /v2/tagassociation/tag/container/{key}

Example

Request

Response

GET /v2/tagassociation/counts/taglevel/domain/{key}

Example

Request

Response

GET /v2/tagassociation/counts/taglevel/tag/{key}

Example

Request

Response