BObox
Metadata taxonomies

List metadata taxonomy nodes

Changed on

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.

get/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

namespacestring required

The namespace of the metadata taxonomy.

taxonomy_keystring required

The key of the metadata taxonomy.

Query parameters

levelinteger[]

Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.

parentstring[]

Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.

ancestorstring[]

Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.

querystring

Query text to search for the taxonomy nodes.

include-total-result-countboolean

When set to true this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000 elements. Defaults to false.

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

Response

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

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

next_markerstring nullable

The marker for the start of the next page of results.

prev_markerstring nullable

The marker for the start of the previous page of results.

Example response

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
      "displayName": "France",
      "level": 2,
      "parentId": "99df4513-7102-4896-8228-94635ee9d330",
      "nodePath": [
        "99df4513-7102-4896-8228-94635ee9d330"
      ],
      "ancestors": [
        {
          "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
          "displayName": "France",
          "level": 2
        }
      ]
    }
  ]
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status