Skip to content

DataProviderCollApi.md

Latest commit

 

History

History
214 lines (162 loc) · 6.85 KB

DataProviderCollApi.md

File metadata and controls

214 lines (162 loc) · 6.85 KB
Raw

DataProviderCollApi

All URIs are relative to http://localhost

Method HTTP request Description
fetchDataProviderColl GET /api/v1/data_provider_colls/{id} DataProviderColl@show
fetchDataProviderCollSummary GET /api/v1/data_provider_colls/{id}/summary DataProviderColl@showSummary
fetchDataProviderColls GET /api/v1/data_provider_colls DataProviderColl@index

fetchDataProviderColl

FetchDataProviderColl200Response fetchDataProviderColl(id)

DataProviderColl@show

Return a single DataProviderColl

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.DataProviderCollApi;

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

    DataProviderCollApi apiInstance = new DataProviderCollApi(defaultClient);
    Integer id = 1; // Integer | DataProviderColl ID
    try {
      FetchDataProviderColl200Response result = apiInstance.fetchDataProviderColl(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataProviderCollApi#fetchDataProviderColl");
      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
id Integer DataProviderColl ID

Return type

FetchDataProviderColl200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
404 Not found response -

fetchDataProviderCollSummary

FetchDataProviderCollSummary200Response fetchDataProviderCollSummary(id)

DataProviderColl@showSummary

Return a single DataProviderColl - summary

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.DataProviderCollApi;

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

    DataProviderCollApi apiInstance = new DataProviderCollApi(defaultClient);
    Integer id = 1; // Integer | DataProviderColl ID - summary
    try {
      FetchDataProviderCollSummary200Response result = apiInstance.fetchDataProviderCollSummary(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataProviderCollApi#fetchDataProviderCollSummary");
      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
id Integer DataProviderColl ID - summary

Return type

FetchDataProviderCollSummary200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
404 Not found response -

fetchDataProviderColls

FetchDataProviderColls200Response fetchDataProviderColls(perPage)

DataProviderColl@index

Returns a list of DataProviderColls enabled on the system

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.DataProviderCollApi;

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

    DataProviderCollApi apiInstance = new DataProviderCollApi(defaultClient);
    Integer perPage = 1; // Integer | per page
    try {
      FetchDataProviderColls200Response result = apiInstance.fetchDataProviderColls(perPage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataProviderCollApi#fetchDataProviderColls");
      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
perPage Integer per page [optional]

Return type

FetchDataProviderColls200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -