Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 3.93 KB

TaxonomyApi.md

File metadata and controls

79 lines (60 loc) · 3.93 KB

DigiKey.Api.Api.TaxonomyApi

All URIs are relative to https://api.digikey.com/taxonomysearch/v3

Method HTTP request Description
TaxonomySearch GET /{category} Retrieves a URL to a filtered partsearch page. Any filter names and values may be used as query parameters as long as it exists for the category. For example: "color=black". However, these cannot be entered on the Swagger page.

TaxonomySearch

string TaxonomySearch (string category, string authorization, string xDIGIKEYClientId)

Retrieves a URL to a filtered partsearch page. Any filter names and values may be used as query parameters as long as it exists for the category. For example: "color=black". However, these cannot be entered on the Swagger page.

Example

using System;
using System.Diagnostics;
using DigiKey.Api.Api;
using DigiKey.Api.Client;
using DigiKey.Api.Model;

namespace Example
{
    public class TaxonomySearchExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeySecurity
            Configuration.Default.AddApiKey("X-DIGIKEY-Client-Id", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-DIGIKEY-Client-Id", "Bearer");
            // Configure OAuth2 access token for authorization: oauth2AccessCodeSecurity
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaxonomyApi();
            var category = category_example;  // string | Category name to filter within. If the category has a parent it can be included as \"parent:child\". If no parent is provided, only child categories are searched. Note that some child categories exist in multiple parents.
            var authorization = authorization_example;  // string | OAuth Bearer Token. Please see<a href= \"https://developer.digikey.com/documentation/oauth\" target= \"_blank\" > OAuth 2.0 Documentation </a > page for more info.
            var xDIGIKEYClientId = xDIGIKEYClientId_example;  // string | The Client Id for your App.

            try
            {
                // Retrieves a URL to a filtered partsearch page. Any filter names and values may be used as query parameters as long as it exists for the category. For example: \"color=black\". However, these cannot be entered on the Swagger page.
                string result = apiInstance.TaxonomySearch(category, authorization, xDIGIKEYClientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyApi.TaxonomySearch: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
category string Category name to filter within. If the category has a parent it can be included as &quot;parent:child&quot;. If no parent is provided, only child categories are searched. Note that some child categories exist in multiple parents.
authorization string OAuth Bearer Token. Please see<a href= &quot;https://developer.digikey.com/documentation/oauth\" target= &quot;_blank&quot; > OAuth 2.0 Documentation </a > page for more info.
xDIGIKEYClientId string The Client Id for your App.

Return type

string

Authorization

apiKeySecurity, oauth2AccessCodeSecurity

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]