Skip to content

Latest commit

 

History

History
2256 lines (1653 loc) · 85.8 KB

TaxonomiesApi.md

File metadata and controls

2256 lines (1653 loc) · 85.8 KB

TaxonomiesApi

All URIs are relative to http://localhost

Method HTTP request Description
fotowebApiTaxonomiesArchivesArchiveIDGet GET /fotoweb/api/taxonomies/archives/{archiveID} Get all the taxonomies for an archive
fotowebApiTaxonomiesArchivesArchiveIDGetWithHttpInfo GET /fotoweb/api/taxonomies/archives/{archiveID} Get all the taxonomies for an archive
fotowebApiTaxonomiesFieldIdDelete DELETE /fotoweb/api/taxonomies/{fieldId}/ Delete a taxonomy
fotowebApiTaxonomiesFieldIdDeleteWithHttpInfo DELETE /fotoweb/api/taxonomies/{fieldId}/ Delete a taxonomy
fotowebApiTaxonomiesFieldIdGet GET /fotoweb/api/taxonomies/{fieldId}/ Get taxonomy of a metadata field, list root items
fotowebApiTaxonomiesFieldIdGetWithHttpInfo GET /fotoweb/api/taxonomies/{fieldId}/ Get taxonomy of a metadata field, list root items
fotowebApiTaxonomiesFieldIdItemIdDelete DELETE /fotoweb/api/taxonomies/{fieldId}/{itemId} Delete a taxonomy item
fotowebApiTaxonomiesFieldIdItemIdDeleteWithHttpInfo DELETE /fotoweb/api/taxonomies/{fieldId}/{itemId} Delete a taxonomy item
fotowebApiTaxonomiesFieldIdItemIdGet GET /fotoweb/api/taxonomies/{fieldId}/{itemId} Get taxonomy item and list children
fotowebApiTaxonomiesFieldIdItemIdGetWithHttpInfo GET /fotoweb/api/taxonomies/{fieldId}/{itemId} Get taxonomy item and list children
fotowebApiTaxonomiesFieldIdItemIdPost POST /fotoweb/api/taxonomies/{fieldId}/{itemId} Create a new taxonomy item under an existing item
fotowebApiTaxonomiesFieldIdItemIdPostWithHttpInfo POST /fotoweb/api/taxonomies/{fieldId}/{itemId} Create a new taxonomy item under an existing item
fotowebApiTaxonomiesFieldIdItemIdPpGet GET /fotoweb/api/taxonomies/{fieldId}/{itemId}/;p={p} Get a taxonomy item and list its children
fotowebApiTaxonomiesFieldIdItemIdPpGetWithHttpInfo GET /fotoweb/api/taxonomies/{fieldId}/{itemId}/;p={p} Get a taxonomy item and list its children
fotowebApiTaxonomiesFieldIdItemIdPut PUT /fotoweb/api/taxonomies/{fieldId}/{itemId} Update the description of a taxonomy item
fotowebApiTaxonomiesFieldIdItemIdPutWithHttpInfo PUT /fotoweb/api/taxonomies/{fieldId}/{itemId} Update the description of a taxonomy item
fotowebApiTaxonomiesFieldIdPost POST /fotoweb/api/taxonomies/{fieldId}/ Create a new taxonomy item at the root of the taxonomy
fotowebApiTaxonomiesFieldIdPostWithHttpInfo POST /fotoweb/api/taxonomies/{fieldId}/ Create a new taxonomy item at the root of the taxonomy
fotowebApiTaxonomiesFieldIdPpGet GET /fotoweb/api/taxonomies/{fieldId}/;p={p} Get taxonomy of a metadata field, list root items
fotowebApiTaxonomiesFieldIdPpGetWithHttpInfo GET /fotoweb/api/taxonomies/{fieldId}/;p={p} Get taxonomy of a metadata field, list root items
fotowebApiTaxonomiesFieldIdPut PUT /fotoweb/api/taxonomies/{fieldId}/ Update a taxonomy field
fotowebApiTaxonomiesFieldIdPutWithHttpInfo PUT /fotoweb/api/taxonomies/{fieldId}/ Update a taxonomy field
fotowebApiTaxonomiesGet GET /fotoweb/api/taxonomies/ List all fields with taxonomy enabled
fotowebApiTaxonomiesGetWithHttpInfo GET /fotoweb/api/taxonomies/ List all fields with taxonomy enabled
fotowebApiTaxonomiesInfoPost POST /fotoweb/api/taxonomies/info Get a taxonomy item list by passing in an item id list
fotowebApiTaxonomiesInfoPostWithHttpInfo POST /fotoweb/api/taxonomies/info Get a taxonomy item list by passing in an item id list
fotowebApiTaxonomiesPost POST /fotoweb/api/taxonomies/ Create a new taxonomy
fotowebApiTaxonomiesPostWithHttpInfo POST /fotoweb/api/taxonomies/ Create a new taxonomy
fotowebApiTaxonomiesPpGet GET /fotoweb/api/taxonomies/;p={p} List all fields with taxonomy enabled
fotowebApiTaxonomiesPpGetWithHttpInfo GET /fotoweb/api/taxonomies/;p={p} List all fields with taxonomy enabled

fotowebApiTaxonomiesArchivesArchiveIDGet

List fotowebApiTaxonomiesArchivesArchiveIDGet(archiveID)

Get all the taxonomies for an archive

Returns a list of taxonomy fields with root items for the archive id that is passed as a parameter.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer archiveID = 56; // Integer | Numeric ID of the archive
        try {
            List<Taxonomy> result = apiInstance.fotowebApiTaxonomiesArchivesArchiveIDGet(archiveID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesArchivesArchiveIDGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
archiveID Integer Numeric ID of the archive

Return type

List<Taxonomy>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Taxonomy field list with root items -
404 Archive not found -

fotowebApiTaxonomiesArchivesArchiveIDGetWithHttpInfo

ApiResponse<List> fotowebApiTaxonomiesArchivesArchiveIDGet fotowebApiTaxonomiesArchivesArchiveIDGetWithHttpInfo(archiveID)

Get all the taxonomies for an archive

Returns a list of taxonomy fields with root items for the archive id that is passed as a parameter.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer archiveID = 56; // Integer | Numeric ID of the archive
        try {
            ApiResponse<List<Taxonomy>> response = apiInstance.fotowebApiTaxonomiesArchivesArchiveIDGetWithHttpInfo(archiveID);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesArchivesArchiveIDGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
archiveID Integer Numeric ID of the archive

Return type

ApiResponse<List<Taxonomy>>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Taxonomy field list with root items -
404 Archive not found -

fotowebApiTaxonomiesFieldIdDelete

void fotowebApiTaxonomiesFieldIdDelete(fieldId)

Delete a taxonomy

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        try {
            apiInstance.fotowebApiTaxonomiesFieldIdDelete(fieldId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy has been deleted or was not enabled -
401 Unauthorized -
403 User is not allowed to delete taxonomy -
404 Metadata field not valid -

fotowebApiTaxonomiesFieldIdDeleteWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdDelete fotowebApiTaxonomiesFieldIdDeleteWithHttpInfo(fieldId)

Delete a taxonomy

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesFieldIdDeleteWithHttpInfo(fieldId);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy has been deleted or was not enabled -
401 Unauthorized -
403 User is not allowed to delete taxonomy -
404 Metadata field not valid -

fotowebApiTaxonomiesFieldIdGet

Taxonomy fotowebApiTaxonomiesFieldIdGet(fieldId, q)

Get taxonomy of a metadata field, list root items

Returns the description of the taxonomy and/or a paged list of top level items in the taxonomy. The page URLs of this paged list can also be obtained from the paging information of each page. If a paging parameter is specified, then this request always returns a taxonomy item list, and other content types are not acceptable.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String q = "q_example"; // String | Query string
        try {
            Taxonomy result = apiInstance.fotowebApiTaxonomiesFieldIdGet(fieldId, q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
q String Query string [optional]

Return type

Taxonomy

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy+json, application/vnd.fotoware.taxonomy-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Metadata field is not valid, or taxonomy not enabled -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesFieldIdGetWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdGet fotowebApiTaxonomiesFieldIdGetWithHttpInfo(fieldId, q)

Get taxonomy of a metadata field, list root items

Returns the description of the taxonomy and/or a paged list of top level items in the taxonomy. The page URLs of this paged list can also be obtained from the paging information of each page. If a paging parameter is specified, then this request always returns a taxonomy item list, and other content types are not acceptable.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String q = "q_example"; // String | Query string
        try {
            ApiResponse<Taxonomy> response = apiInstance.fotowebApiTaxonomiesFieldIdGetWithHttpInfo(fieldId, q);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
q String Query string [optional]

Return type

ApiResponse<Taxonomy>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy+json, application/vnd.fotoware.taxonomy-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Metadata field is not valid, or taxonomy not enabled -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesFieldIdItemIdDelete

void fotowebApiTaxonomiesFieldIdItemIdDelete(fieldId, itemId)

Delete a taxonomy item

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        try {
            apiInstance.fotowebApiTaxonomiesFieldIdItemIdDelete(fieldId, itemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy item has been deleted or did not exist -
401 Unauthorized -
403 User is not allowed to update taxonomy items -

fotowebApiTaxonomiesFieldIdItemIdDeleteWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdItemIdDelete fotowebApiTaxonomiesFieldIdItemIdDeleteWithHttpInfo(fieldId, itemId)

Delete a taxonomy item

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesFieldIdItemIdDeleteWithHttpInfo(fieldId, itemId);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy item has been deleted or did not exist -
401 Unauthorized -
403 User is not allowed to update taxonomy items -

fotowebApiTaxonomiesFieldIdItemIdGet

TaxonomyItem fotowebApiTaxonomiesFieldIdItemIdGet(fieldId, itemId)

Get taxonomy item and list children

Returns the description of the taxonomy item and a paged list of child items.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        try {
            TaxonomyItem result = apiInstance.fotowebApiTaxonomiesFieldIdItemIdGet(fieldId, itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item

Return type

TaxonomyItem

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-item+json, application/vnd.fotoware.taxonomy-item-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Taxonomy item not found -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesFieldIdItemIdGetWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdItemIdGet fotowebApiTaxonomiesFieldIdItemIdGetWithHttpInfo(fieldId, itemId)

Get taxonomy item and list children

Returns the description of the taxonomy item and a paged list of child items.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        try {
            ApiResponse<TaxonomyItem> response = apiInstance.fotowebApiTaxonomiesFieldIdItemIdGetWithHttpInfo(fieldId, itemId);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item

Return type

ApiResponse<TaxonomyItem>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-item+json, application/vnd.fotoware.taxonomy-item-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Taxonomy item not found -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesFieldIdItemIdPost

void fotowebApiTaxonomiesFieldIdItemIdPost(fieldId, itemId, taxonomyItemCreationInfo)

Create a new taxonomy item under an existing item

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        TaxonomyItemCreationInfo taxonomyItemCreationInfo = new TaxonomyItemCreationInfo(); // TaxonomyItemCreationInfo | 
        try {
            apiInstance.fotowebApiTaxonomiesFieldIdItemIdPost(fieldId, itemId, taxonomyItemCreationInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item
taxonomyItemCreationInfo TaxonomyItemCreationInfo [optional]

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-item-creation-info+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Taxonomy item has been created * Location - URL of the new taxonomy item
401 Unauthorized -
403 User is not allowed to create taxonomy items -
404 Metadata field not valid, or taxonomy not enabled -

fotowebApiTaxonomiesFieldIdItemIdPostWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdItemIdPost fotowebApiTaxonomiesFieldIdItemIdPostWithHttpInfo(fieldId, itemId, taxonomyItemCreationInfo)

Create a new taxonomy item under an existing item

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        TaxonomyItemCreationInfo taxonomyItemCreationInfo = new TaxonomyItemCreationInfo(); // TaxonomyItemCreationInfo | 
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesFieldIdItemIdPostWithHttpInfo(fieldId, itemId, taxonomyItemCreationInfo);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item
taxonomyItemCreationInfo TaxonomyItemCreationInfo [optional]

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-item-creation-info+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Taxonomy item has been created * Location - URL of the new taxonomy item
401 Unauthorized -
403 User is not allowed to create taxonomy items -
404 Metadata field not valid, or taxonomy not enabled -

fotowebApiTaxonomiesFieldIdItemIdPpGet

TaxonomyItem fotowebApiTaxonomiesFieldIdItemIdPpGet(fieldId, itemId, p)

Get a taxonomy item and list its children

Returns the description of the taxonomy item and a paged list of its child items. The URLs of this paged list can also be obtained from the paging information in the result.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        Integer p = 56; // Integer | Page Number
        try {
            TaxonomyItem result = apiInstance.fotowebApiTaxonomiesFieldIdItemIdPpGet(fieldId, itemId, p);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdPpGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item
p Integer Page Number

Return type

TaxonomyItem

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-item+json, application/vnd.fotoware.taxonomy-item-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Taxonomy item not found -

fotowebApiTaxonomiesFieldIdItemIdPpGetWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdItemIdPpGet fotowebApiTaxonomiesFieldIdItemIdPpGetWithHttpInfo(fieldId, itemId, p)

Get a taxonomy item and list its children

Returns the description of the taxonomy item and a paged list of its child items. The URLs of this paged list can also be obtained from the paging information in the result.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        Integer p = 56; // Integer | Page Number
        try {
            ApiResponse<TaxonomyItem> response = apiInstance.fotowebApiTaxonomiesFieldIdItemIdPpGetWithHttpInfo(fieldId, itemId, p);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdPpGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item
p Integer Page Number

Return type

ApiResponse<TaxonomyItem>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-item+json, application/vnd.fotoware.taxonomy-item-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Taxonomy item not found -

fotowebApiTaxonomiesFieldIdItemIdPut

void fotowebApiTaxonomiesFieldIdItemIdPut(fieldId, itemId, taxonomyItemUpdate)

Update the description of a taxonomy item

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        TaxonomyItemUpdate taxonomyItemUpdate = new TaxonomyItemUpdate(); // TaxonomyItemUpdate | 
        try {
            apiInstance.fotowebApiTaxonomiesFieldIdItemIdPut(fieldId, itemId, taxonomyItemUpdate);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdPut");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item
taxonomyItemUpdate TaxonomyItemUpdate [optional]

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-item-update+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy item has been updated -
401 Unauthorized -
403 User is not allowed to update taxonomy item -
404 Taxonomy item not found -

fotowebApiTaxonomiesFieldIdItemIdPutWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdItemIdPut fotowebApiTaxonomiesFieldIdItemIdPutWithHttpInfo(fieldId, itemId, taxonomyItemUpdate)

Update the description of a taxonomy item

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        String itemId = "itemId_example"; // String | Unique ID of the taxonomy item
        TaxonomyItemUpdate taxonomyItemUpdate = new TaxonomyItemUpdate(); // TaxonomyItemUpdate | 
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesFieldIdItemIdPutWithHttpInfo(fieldId, itemId, taxonomyItemUpdate);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdItemIdPut");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
itemId String Unique ID of the taxonomy item
taxonomyItemUpdate TaxonomyItemUpdate [optional]

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-item-update+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy item has been updated -
401 Unauthorized -
403 User is not allowed to update taxonomy item -
404 Taxonomy item not found -

fotowebApiTaxonomiesFieldIdPost

void fotowebApiTaxonomiesFieldIdPost(fieldId, taxonomyItemCreationInfo)

Create a new taxonomy item at the root of the taxonomy

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        TaxonomyItemCreationInfo taxonomyItemCreationInfo = new TaxonomyItemCreationInfo(); // TaxonomyItemCreationInfo | 
        try {
            apiInstance.fotowebApiTaxonomiesFieldIdPost(fieldId, taxonomyItemCreationInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
taxonomyItemCreationInfo TaxonomyItemCreationInfo [optional]

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-item-creation-info+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Taxonomy item has been created * Location - URL of the new taxonomy item
401 Unauthorized -
403 User is not allowed to create taxonomy item -
404 Metadata field not valid, or taxonomy not enabled -

fotowebApiTaxonomiesFieldIdPostWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdPost fotowebApiTaxonomiesFieldIdPostWithHttpInfo(fieldId, taxonomyItemCreationInfo)

Create a new taxonomy item at the root of the taxonomy

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        TaxonomyItemCreationInfo taxonomyItemCreationInfo = new TaxonomyItemCreationInfo(); // TaxonomyItemCreationInfo | 
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesFieldIdPostWithHttpInfo(fieldId, taxonomyItemCreationInfo);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
taxonomyItemCreationInfo TaxonomyItemCreationInfo [optional]

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-item-creation-info+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Taxonomy item has been created * Location - URL of the new taxonomy item
401 Unauthorized -
403 User is not allowed to create taxonomy item -
404 Metadata field not valid, or taxonomy not enabled -

fotowebApiTaxonomiesFieldIdPpGet

Taxonomy fotowebApiTaxonomiesFieldIdPpGet(fieldId, p, q)

Get taxonomy of a metadata field, list root items

Returns the description of the taxonomy and/or a paged list of top level items in the taxonomy. The page URLs of this paged list can also be obtained from the paging information of each page. If a paging parameter is specified,then this request always returns a taxonomy item list, and other content types are not acceptable.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        Integer p = 56; // Integer | Page Number
        String q = "q_example"; // String | Query string
        try {
            Taxonomy result = apiInstance.fotowebApiTaxonomiesFieldIdPpGet(fieldId, p, q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdPpGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
p Integer Page Number
q String Query string [optional]

Return type

Taxonomy

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy+json, application/vnd.fotoware.taxonomy-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Metadata field is not valid, or taxonomy not enabled -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesFieldIdPpGetWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdPpGet fotowebApiTaxonomiesFieldIdPpGetWithHttpInfo(fieldId, p, q)

Get taxonomy of a metadata field, list root items

Returns the description of the taxonomy and/or a paged list of top level items in the taxonomy. The page URLs of this paged list can also be obtained from the paging information of each page. If a paging parameter is specified,then this request always returns a taxonomy item list, and other content types are not acceptable.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        Integer p = 56; // Integer | Page Number
        String q = "q_example"; // String | Query string
        try {
            ApiResponse<Taxonomy> response = apiInstance.fotowebApiTaxonomiesFieldIdPpGetWithHttpInfo(fieldId, p, q);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdPpGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
p Integer Page Number
q String Query string [optional]

Return type

ApiResponse<Taxonomy>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy+json, application/vnd.fotoware.taxonomy-info+json, application/vnd.fotoware.taxonomy-item-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy -
404 Metadata field is not valid, or taxonomy not enabled -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesFieldIdPut

void fotowebApiTaxonomiesFieldIdPut(fieldId, taxonomyUpdate)

Update a taxonomy field

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        TaxonomyUpdate taxonomyUpdate = new TaxonomyUpdate(); // TaxonomyUpdate | 
        try {
            apiInstance.fotowebApiTaxonomiesFieldIdPut(fieldId, taxonomyUpdate);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdPut");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
taxonomyUpdate TaxonomyUpdate [optional]

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-update+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy has been updated -
401 Unauthorized -
403 User is not allowed to update taxonomy -

fotowebApiTaxonomiesFieldIdPutWithHttpInfo

ApiResponse fotowebApiTaxonomiesFieldIdPut fotowebApiTaxonomiesFieldIdPutWithHttpInfo(fieldId, taxonomyUpdate)

Update a taxonomy field

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer fieldId = 56; // Integer | Numeric ID of the metadata field
        TaxonomyUpdate taxonomyUpdate = new TaxonomyUpdate(); // TaxonomyUpdate | 
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesFieldIdPutWithHttpInfo(fieldId, taxonomyUpdate);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesFieldIdPut");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
fieldId Integer Numeric ID of the metadata field
taxonomyUpdate TaxonomyUpdate [optional]

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-update+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Taxonomy has been updated -
401 Unauthorized -
403 User is not allowed to update taxonomy -

fotowebApiTaxonomiesGet

TaxonomyList fotowebApiTaxonomiesGet()

List all fields with taxonomy enabled

A paged list of taxononmies is returned. The list has one item for each metadata field with taxonomy enabled. The page URLs of this paged list can be obtained from the paging information in the result.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        try {
            TaxonomyList result = apiInstance.fotowebApiTaxonomiesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

TaxonomyList

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy list -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesGetWithHttpInfo

ApiResponse fotowebApiTaxonomiesGet fotowebApiTaxonomiesGetWithHttpInfo()

List all fields with taxonomy enabled

A paged list of taxononmies is returned. The list has one item for each metadata field with taxonomy enabled. The page URLs of this paged list can be obtained from the paging information in the result.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        try {
            ApiResponse<TaxonomyList> response = apiInstance.fotowebApiTaxonomiesGetWithHttpInfo();
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ApiResponse<TaxonomyList>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy list -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesInfoPost

List fotowebApiTaxonomiesInfoPost(requestBody)

Get a taxonomy item list by passing in an item id list

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        List<String> requestBody = Arrays.asList(); // List<String> | 
        try {
            List<TaxonomyItem> result = apiInstance.fotowebApiTaxonomiesInfoPost(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesInfoPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
requestBody List<String> [optional]

Return type

List<TaxonomyItem>

Authorization

FotoWareAccessToken

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Taxonomy item list -

fotowebApiTaxonomiesInfoPostWithHttpInfo

ApiResponse<List> fotowebApiTaxonomiesInfoPost fotowebApiTaxonomiesInfoPostWithHttpInfo(requestBody)

Get a taxonomy item list by passing in an item id list

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        List<String> requestBody = Arrays.asList(); // List<String> | 
        try {
            ApiResponse<List<TaxonomyItem>> response = apiInstance.fotowebApiTaxonomiesInfoPostWithHttpInfo(requestBody);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesInfoPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
requestBody List<String> [optional]

Return type

ApiResponse<List<TaxonomyItem>>

Authorization

FotoWareAccessToken

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Taxonomy item list -

fotowebApiTaxonomiesPost

void fotowebApiTaxonomiesPost(taxonomyCreationInfo)

Create a new taxonomy

Creates a new taxonomy and enables the taxonomy for a field. The url to the new taxonomy is returned in the Location header in the response.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        TaxonomyCreationInfo taxonomyCreationInfo = new TaxonomyCreationInfo(); // TaxonomyCreationInfo | 
        try {
            apiInstance.fotowebApiTaxonomiesPost(taxonomyCreationInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
taxonomyCreationInfo TaxonomyCreationInfo [optional]

Return type

null (empty response body)

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-creation-info+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Taxonomy created * Location - URL of the new taxonomy item
401 Unauthorized -
403 User is not allowed to create taxonomy -

fotowebApiTaxonomiesPostWithHttpInfo

ApiResponse fotowebApiTaxonomiesPost fotowebApiTaxonomiesPostWithHttpInfo(taxonomyCreationInfo)

Create a new taxonomy

Creates a new taxonomy and enables the taxonomy for a field. The url to the new taxonomy is returned in the Location header in the response.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        TaxonomyCreationInfo taxonomyCreationInfo = new TaxonomyCreationInfo(); // TaxonomyCreationInfo | 
        try {
            ApiResponse<Void> response = apiInstance.fotowebApiTaxonomiesPostWithHttpInfo(taxonomyCreationInfo);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
taxonomyCreationInfo TaxonomyCreationInfo [optional]

Return type

ApiResponse

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: application/json, application/vnd.fotoware.taxonomy-creation-info+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Taxonomy created * Location - URL of the new taxonomy item
401 Unauthorized -
403 User is not allowed to create taxonomy -

fotowebApiTaxonomiesPpGet

TaxonomyList fotowebApiTaxonomiesPpGet(p)

List all fields with taxonomy enabled

This request returns a paged list of taxonomies with one item for each metadata field for which taxonomy is enabled. The page URLs of this paged list can also be obtained from the paging information of each page.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer p = 56; // Integer | Page Number
        try {
            TaxonomyList result = apiInstance.fotowebApiTaxonomiesPpGet(p);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesPpGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
p Integer Page Number

Return type

TaxonomyList

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy list -
406 Invalid type requested and paging header specified -

fotowebApiTaxonomiesPpGetWithHttpInfo

ApiResponse fotowebApiTaxonomiesPpGet fotowebApiTaxonomiesPpGetWithHttpInfo(p)

List all fields with taxonomy enabled

This request returns a paged list of taxonomies with one item for each metadata field for which taxonomy is enabled. The page URLs of this paged list can also be obtained from the paging information of each page.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.TaxonomiesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        TaxonomiesApi apiInstance = new TaxonomiesApi(defaultClient);
        Integer p = 56; // Integer | Page Number
        try {
            ApiResponse<TaxonomyList> response = apiInstance.fotowebApiTaxonomiesPpGetWithHttpInfo(p);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomiesApi#fotowebApiTaxonomiesPpGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
p Integer Page Number

Return type

ApiResponse<TaxonomyList>

Authorization

FotoWareAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.fotoware.taxonomy-list+json

HTTP response details

Status code Description Response headers
200 Taxonomy list -
406 Invalid type requested and paging header specified -