Skip to content

MetadataTaxonomies.md

Latest commit

 

History

History
519 lines (336 loc) · 16.6 KB

MetadataTaxonomies.md

File metadata and controls

519 lines (336 loc) · 16.6 KB

MetadataTaxonomiesManager

Create metadata taxonomy

Creates a new metadata taxonomy that can be used in metadata templates.

This operation is performed by calling function createMetadataTaxonomy.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.createMetadataTaxonomy(requestBody: CreateMetadataTaxonomyRequestBody(displayName: displayName, key: taxonomyKey, namespace: namespace))

Arguments

  • requestBody CreateMetadataTaxonomyRequestBody
    • Request body of createMetadataTaxonomy method
  • headers CreateMetadataTaxonomyHeaders
    • Headers of createMetadataTaxonomy method

Returns

This function returns a value of type MetadataTaxonomy.

The schema representing the metadata taxonomy created.

Get metadata taxonomies for namespace

Used to retrieve all metadata taxonomies in a namespace.

This operation is performed by calling function getMetadataTaxonomies.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.getMetadataTaxonomies(namespace: namespace)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • queryParams GetMetadataTaxonomiesQueryParams
    • Query parameters of getMetadataTaxonomies method
  • headers GetMetadataTaxonomiesHeaders
    • Headers of getMetadataTaxonomies method

Returns

This function returns a value of type MetadataTaxonomies.

Returns all of the metadata taxonomies within a namespace and their corresponding schema.

Get metadata taxonomy by taxonomy key

Used to retrieve a metadata taxonomy by taxonomy key.

This operation is performed by calling function getMetadataTaxonomyByKey.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.getMetadataTaxonomyByKey(namespace: namespace, taxonomyKey: taxonomyKey)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • headers GetMetadataTaxonomyByKeyHeaders
    • Headers of getMetadataTaxonomyByKey method

Returns

This function returns a value of type MetadataTaxonomy.

Returns the metadata taxonomy identified by the taxonomy key.

Update metadata taxonomy

Updates an existing metadata taxonomy.

This operation is performed by calling function updateMetadataTaxonomy.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.updateMetadataTaxonomy(namespace: namespace, taxonomyKey: taxonomyKey, requestBody: UpdateMetadataTaxonomyRequestBody(displayName: updatedDisplayName))

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • requestBody UpdateMetadataTaxonomyRequestBody
    • Request body of updateMetadataTaxonomy method
  • headers UpdateMetadataTaxonomyHeaders
    • Headers of updateMetadataTaxonomy method

Returns

This function returns a value of type MetadataTaxonomy.

The schema representing the updated metadata taxonomy.

Remove metadata taxonomy

Delete a metadata taxonomy. This deletion is permanent and cannot be reverted.

This operation is performed by calling function deleteMetadataTaxonomy.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.deleteMetadataTaxonomy(namespace: namespace, taxonomyKey: taxonomyKey)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • headers DeleteMetadataTaxonomyHeaders
    • Headers of deleteMetadataTaxonomy method

Returns

This function returns a value of type ``.

Returns an empty response when the metadata taxonomy is successfully deleted.

Create metadata taxonomy levels

Creates new metadata taxonomy levels.

This operation is performed by calling function createMetadataTaxonomyLevel.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.createMetadataTaxonomyLevel(namespace: namespace, taxonomyKey: taxonomyKey, requestBody: [MetadataTaxonomyLevel(displayName: "Continent", description: "Continent Level"), MetadataTaxonomyLevel(displayName: "Country", description: "Country Level")])

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • requestBody [MetadataTaxonomyLevel]
    • Request body of createMetadataTaxonomyLevel method
  • headers CreateMetadataTaxonomyLevelHeaders
    • Headers of createMetadataTaxonomyLevel method

Returns

This function returns a value of type MetadataTaxonomyLevels.

Returns an array of all taxonomy levels.

Update metadata taxonomy level

Updates an existing metadata taxonomy level.

This operation is performed by calling function updateMetadataTaxonomyLevelById.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.updateMetadataTaxonomyLevelById(namespace: namespace, taxonomyKey: taxonomyKey, levelIndex: Int64(1), requestBody: UpdateMetadataTaxonomyLevelByIdRequestBody(displayName: "Continent UPDATED", description: "Continent Level UPDATED"))

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • levelIndex Int64
    • The index of the metadata taxonomy level. Example: 1
  • requestBody UpdateMetadataTaxonomyLevelByIdRequestBody
    • Request body of updateMetadataTaxonomyLevelById method
  • headers UpdateMetadataTaxonomyLevelByIdHeaders
    • Headers of updateMetadataTaxonomyLevelById method

Returns

This function returns a value of type MetadataTaxonomyLevel.

The updated taxonomy level.

Add metadata taxonomy level

Creates a new metadata taxonomy level and appends it to the existing levels. If there are no levels defined yet, this will create the first level.

This operation is performed by calling function addMetadataTaxonomyLevel.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.addMetadataTaxonomyLevel(namespace: namespace, taxonomyKey: taxonomyKey, requestBody: AddMetadataTaxonomyLevelRequestBody(displayName: "Region", description: "Region Description"))

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • requestBody AddMetadataTaxonomyLevelRequestBody
    • Request body of addMetadataTaxonomyLevel method
  • headers AddMetadataTaxonomyLevelHeaders
    • Headers of addMetadataTaxonomyLevel method

Returns

This function returns a value of type MetadataTaxonomyLevels.

Returns an array of all taxonomy levels.

Delete metadata taxonomy level

Deletes the last level of the metadata taxonomy.

This operation is performed by calling function deleteMetadataTaxonomyLevel.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.deleteMetadataTaxonomyLevel(namespace: namespace, taxonomyKey: taxonomyKey)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • headers DeleteMetadataTaxonomyLevelHeaders
    • Headers of deleteMetadataTaxonomyLevel method

Returns

This function returns a value of type MetadataTaxonomyLevels.

Returns an array of all taxonomy levels.

List metadata taxonomy nodes

Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a query parameter is passed. With a query parameter specified, results are sorted in order of relevance.

This operation is performed by calling function getMetadataTaxonomyNodes.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.getMetadataTaxonomyNodes(namespace: namespace, taxonomyKey: taxonomyKey)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • queryParams GetMetadataTaxonomyNodesQueryParams
    • Query parameters of getMetadataTaxonomyNodes method
  • headers GetMetadataTaxonomyNodesHeaders
    • Headers of getMetadataTaxonomyNodes method

Returns

This function returns a value of type MetadataTaxonomyNodes.

Returns a list of the taxonomy nodes that match the specified parameters.

Create metadata taxonomy node

Creates a new metadata taxonomy node.

This operation is performed by calling function createMetadataTaxonomyNode.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.createMetadataTaxonomyNode(namespace: namespace, taxonomyKey: taxonomyKey, requestBody: CreateMetadataTaxonomyNodeRequestBody(displayName: "Europe", level: 1))

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • requestBody CreateMetadataTaxonomyNodeRequestBody
    • Request body of createMetadataTaxonomyNode method
  • headers CreateMetadataTaxonomyNodeHeaders
    • Headers of createMetadataTaxonomyNode method

Returns

This function returns a value of type MetadataTaxonomyNode.

The schema representing the taxonomy node created.

Get metadata taxonomy node by ID

Retrieves a metadata taxonomy node by its identifier.

This operation is performed by calling function getMetadataTaxonomyNodeById.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.getMetadataTaxonomyNodeById(namespace: namespace, taxonomyKey: taxonomyKey, nodeId: countryNode.id)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • nodeId String
    • The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"
  • headers GetMetadataTaxonomyNodeByIdHeaders
    • Headers of getMetadataTaxonomyNodeById method

Returns

This function returns a value of type MetadataTaxonomyNode.

Returns the metadata taxonomy node that matches the identifier.

Update metadata taxonomy node

Updates an existing metadata taxonomy node.

This operation is performed by calling function updateMetadataTaxonomyNode.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.updateMetadataTaxonomyNode(namespace: namespace, taxonomyKey: taxonomyKey, nodeId: countryNode.id, requestBody: UpdateMetadataTaxonomyNodeRequestBody(displayName: "Poland UPDATED"))

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • nodeId String
    • The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"
  • requestBody UpdateMetadataTaxonomyNodeRequestBody
    • Request body of updateMetadataTaxonomyNode method
  • headers UpdateMetadataTaxonomyNodeHeaders
    • Headers of updateMetadataTaxonomyNode method

Returns

This function returns a value of type MetadataTaxonomyNode.

The schema representing the updated taxonomy node.

Remove metadata taxonomy node

Delete a metadata taxonomy node. This deletion is permanent and cannot be reverted. Only metadata taxonomy nodes without any children can be deleted.

This operation is performed by calling function deleteMetadataTaxonomyNode.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.deleteMetadataTaxonomyNode(namespace: namespace, taxonomyKey: taxonomyKey, nodeId: countryNode.id)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • taxonomyKey String
    • The key of the metadata taxonomy. Example: "geography"
  • nodeId String
    • The identifier of the metadata taxonomy node. Example: "14d3d433-c77f-49c5-b146-9dea370f6e32"
  • headers DeleteMetadataTaxonomyNodeHeaders
    • Headers of deleteMetadataTaxonomyNode method

Returns

This function returns a value of type ``.

Returns an empty response when the metadata taxonomy node is successfully deleted.

List metadata template's options for taxonomy field

Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a query parameter is passed. With a query parameter specified, results are sorted in order of relevance.

This operation is performed by calling function getMetadataTemplateFieldOptions.

See the endpoint docs at API Reference.

try await client.metadataTaxonomies.getMetadataTemplateFieldOptions(namespace: namespace, templateKey: metadataTemplateKey, fieldKey: fieldKey)

Arguments

  • namespace String
    • The namespace of the metadata taxonomy. Example: "enterprise_123456"
  • templateKey String
    • The name of the metadata template. Example: "properties"
  • fieldKey String
    • The key of the metadata taxonomy field in the template. Example: "geography"
  • queryParams GetMetadataTemplateFieldOptionsQueryParams
    • Query parameters of getMetadataTemplateFieldOptions method
  • headers GetMetadataTemplateFieldOptionsHeaders
    • Headers of getMetadataTemplateFieldOptions method

Returns

This function returns a value of type MetadataTaxonomyNodes.

Returns a list of the taxonomy nodes that match the specified parameters.