Skip to content

AliasApi.md

Latest commit

 

History

History
347 lines (265 loc) · 10.8 KB

AliasApi.md

File metadata and controls

347 lines (265 loc) · 10.8 KB
Raw

BlueRain.ID4i.Api.AliasApi

All URIs are relative to https://backend.id4i.de

Method HTTP request Description
AddGuidAlias POST /api/v1/id4ns/{id4n}/alias/{aliasType} Add alias for GUID or Collection
GetGuidAliasTypes GET /api/v1/search/guids/aliases/types List all supported alias types
GetGuidAliases GET /api/v1/id4ns/{id4n}/alias Get all aliases for the given GUID or Collection.
RemoveGuidAlias DELETE /api/v1/id4ns/{id4n}/alias/{aliasType} Remove aliases from GUID or Collection
SearchByAlias GET /api/v1/search/guids Search for GUIDs by alias

AddGuidAlias

void AddGuidAlias (string id4n, string aliasType, GuidAlias alias)

Add alias for GUID or Collection

Adds or replaces aliases for single ID4ns (alias type item and mapp) or groups of ID4ns (alias types gtin, ean and article)

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class AddGuidAliasExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AliasApi();
            var id4n = id4n_example;  // string | The GUID or Collection to operate on
            var aliasType = aliasType_example;  // string | Alias type, see the corresponding API model
            var alias = new GuidAlias(); // GuidAlias | The alias to add or update

            try
            {
                // Add alias for GUID or Collection
                apiInstance.AddGuidAlias(id4n, aliasType, alias);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AliasApi.AddGuidAlias: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string The GUID or Collection to operate on
aliasType string Alias type, see the corresponding API model
alias GuidAlias The alias to add or update

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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

GetGuidAliasTypes

List GetGuidAliasTypes ()

List all supported alias types

Retrieve this list to find out all alias types to use with alias search and change operations

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetGuidAliasTypesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AliasApi();

            try
            {
                // List all supported alias types
                List<string> result = apiInstance.GetGuidAliasTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AliasApi.GetGuidAliasTypes: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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

GetGuidAliases

Dictionary<string, string> GetGuidAliases (string id4n)

Get all aliases for the given GUID or Collection.

Looks up the alias for each alias type (group and single) and returns a map of all aliases found.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetGuidAliasesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AliasApi();
            var id4n = id4n_example;  // string | The GUID or Collection to operate on

            try
            {
                // Get all aliases for the given GUID or Collection.
                Dictionary&lt;string, string&gt; result = apiInstance.GetGuidAliases(id4n);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AliasApi.GetGuidAliases: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string The GUID or Collection to operate on

Return type

Dictionary<string, string>

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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

RemoveGuidAlias

void RemoveGuidAlias (string id4n, string aliasType)

Remove aliases from GUID or Collection

Remove the alias of the given type

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class RemoveGuidAliasExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AliasApi();
            var id4n = id4n_example;  // string | The GUID or Collection to operate on
            var aliasType = aliasType_example;  // string | Alias type, see the corresponding API model

            try
            {
                // Remove aliases from GUID or Collection
                apiInstance.RemoveGuidAlias(id4n, aliasType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AliasApi.RemoveGuidAlias: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string The GUID or Collection to operate on
aliasType string Alias type, see the corresponding API model

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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

SearchByAlias

PaginatedResponseOfGuid SearchByAlias (string alias, string aliasType, int? offset = null, int? limit = null)

Search for GUIDs by alias

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class SearchByAliasExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new AliasApi();
            var alias = alias_example;  // string | The alias to search for
            var aliasType = aliasType_example;  // string | Alias type type to search for
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // Search for GUIDs by alias
                PaginatedResponseOfGuid result = apiInstance.SearchByAlias(alias, aliasType, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AliasApi.SearchByAlias: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
alias string The alias to search for
aliasType string Alias type type to search for
offset int? Start with the n-th element [optional]
limit int? The maximum count of returned elements [optional]

Return type

PaginatedResponseOfGuid

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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