Skip to content

DataAccessTemplateApi.md

Latest commit

 

History

History
432 lines (332 loc) · 14.3 KB

DataAccessTemplateApi.md

File metadata and controls

432 lines (332 loc) · 14.3 KB
Raw

DataAccessTemplateApi

All URIs are relative to http://localhost

Method HTTP request Description
createDarTemplate POST /api/v1/dar/templates DataAccessTemplate@store
deleteDarTemplate DELETE /api/v1/dar/templates/{id} DataAccessTemplate@destroy
fetchDarTemplate GET /api/v1/dar/templates/{id} DataAccessTemplate@show
fetchDarTemplates GET /api/v1/dar/templates DataAccessTemplate@index
patchDarTemplate PATCH /api/v1/dar/templates/{id} DataAccessTemplate@update
updateDarTemplate PUT /api/v1/dar/templates/{id} DataAccessTemplate@update

createDarTemplate

CreateDarIntegration201Response createDarTemplate(createDarTemplateRequest)

DataAccessTemplate@store

Creates a new DAR template

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.DataAccessTemplateApi;

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");

    DataAccessTemplateApi apiInstance = new DataAccessTemplateApi(defaultClient);
    CreateDarTemplateRequest createDarTemplateRequest = new CreateDarTemplateRequest(); // CreateDarTemplateRequest | DataAccessTemplate definition
    try {
      CreateDarIntegration201Response result = apiInstance.createDarTemplate(createDarTemplateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataAccessTemplateApi#createDarTemplate");
      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
createDarTemplateRequest CreateDarTemplateRequest DataAccessTemplate definition

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
500 Error -

deleteDarTemplate

DeleteApplications200Response deleteDarTemplate(id)

DataAccessTemplate@destroy

Delete a system DAR template

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.DataAccessTemplateApi;

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");

    DataAccessTemplateApi apiInstance = new DataAccessTemplateApi(defaultClient);
    Integer id = 1; // Integer | DAR template id
    try {
      DeleteApplications200Response result = apiInstance.deleteDarTemplate(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataAccessTemplateApi#deleteDarTemplate");
      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 DAR template id

Return type

DeleteApplications200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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

fetchDarTemplate

FetchDarTemplate200Response fetchDarTemplate(id)

DataAccessTemplate@show

Return a single DAR template

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.DataAccessTemplateApi;

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");

    DataAccessTemplateApi apiInstance = new DataAccessTemplateApi(defaultClient);
    Integer id = 1; // Integer | DAR template id
    try {
      FetchDarTemplate200Response result = apiInstance.fetchDarTemplate(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataAccessTemplateApi#fetchDarTemplate");
      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 DAR template id

Return type

FetchDarTemplate200Response

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 -

fetchDarTemplates

FetchDarTemplates200Response fetchDarTemplates(withQuestions, published)

DataAccessTemplate@index

List of DAR templates

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.DataAccessTemplateApi;

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");

    DataAccessTemplateApi apiInstance = new DataAccessTemplateApi(defaultClient);
    Integer withQuestions = 1; // Integer | Include questions in response
    String published = "true"; // String | Template publication status to filter by (true, false)
    try {
      FetchDarTemplates200Response result = apiInstance.fetchDarTemplates(withQuestions, published);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataAccessTemplateApi#fetchDarTemplates");
      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
withQuestions Integer Include questions in response [optional]
published String Template publication status to filter by (true, false) [optional]

Return type

FetchDarTemplates200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -

patchDarTemplate

PatchDarTemplate200Response patchDarTemplate(id, patchDarTemplateRequest, sectionId)

DataAccessTemplate@update

Edit a system DAR template

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.DataAccessTemplateApi;

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");

    DataAccessTemplateApi apiInstance = new DataAccessTemplateApi(defaultClient);
    Integer id = 1; // Integer | DAR template id
    PatchDarTemplateRequest patchDarTemplateRequest = new PatchDarTemplateRequest(); // PatchDarTemplateRequest | DataAccessTemplate definition
    Integer sectionId = 1; // Integer | Section id
    try {
      PatchDarTemplate200Response result = apiInstance.patchDarTemplate(id, patchDarTemplateRequest, sectionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataAccessTemplateApi#patchDarTemplate");
      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 DAR template id
patchDarTemplateRequest PatchDarTemplateRequest DataAccessTemplate definition
sectionId Integer Section id [optional]

Return type

PatchDarTemplate200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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

updateDarTemplate

FetchDarTemplate200Response updateDarTemplate(id, updateDarTemplateRequest)

DataAccessTemplate@update

Update a system DAR template

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.DataAccessTemplateApi;

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");

    DataAccessTemplateApi apiInstance = new DataAccessTemplateApi(defaultClient);
    Integer id = 1; // Integer | DAR template id
    UpdateDarTemplateRequest updateDarTemplateRequest = new UpdateDarTemplateRequest(); // UpdateDarTemplateRequest | DataAccessTemplate definition
    try {
      FetchDarTemplate200Response result = apiInstance.updateDarTemplate(id, updateDarTemplateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataAccessTemplateApi#updateDarTemplate");
      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 DAR template id
updateDarTemplateRequest UpdateDarTemplateRequest DataAccessTemplate definition

Return type

FetchDarTemplate200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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