Skip to content

MappingsApi.md

Latest commit

 

History

History
354 lines (275 loc) · 11.6 KB

MappingsApi.md

File metadata and controls

354 lines (275 loc) · 11.6 KB

MappingsApi

All URIs are relative to http://localhost

Method HTTP request Description
addMapping POST /mappings Add New Mapping
deleteMapping DELETE /mappings/{mappingId} Delete Mapping
getMapping GET /mappings/{mappingId} Get Mapping
getMappings GET /mappings Get Mappings
setMapping PUT /mappings/{mappingId} Set Mapping

addMapping

AddMappingResponse addMapping(addMappingRequest, siteId)

Add New Mapping

Creates a new mapping; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.MappingsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    MappingsApi apiInstance = new MappingsApi(defaultClient);
    AddMappingRequest addMappingRequest = new AddMappingRequest(); // AddMappingRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      AddMappingResponse result = apiInstance.addMapping(addMappingRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MappingsApi#addMapping");
      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
addMappingRequest AddMappingRequest
siteId String Site Identifier [optional]

Return type

AddMappingResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 201 CREATED * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -

deleteMapping

DeleteResponse deleteMapping(mappingId, siteId)

Delete Mapping

Delete Mapping; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.MappingsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    MappingsApi apiInstance = new MappingsApi(defaultClient);
    String mappingId = "mappingId_example"; // String | Mapping Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      DeleteResponse result = apiInstance.deleteMapping(mappingId, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MappingsApi#deleteMapping");
      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
mappingId String Mapping Identifier
siteId String Site Identifier [optional]

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

getMapping

GetMappingResponse getMapping(mappingId, siteId)

Get Mapping

Get a mapping; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.MappingsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    MappingsApi apiInstance = new MappingsApi(defaultClient);
    String mappingId = "mappingId_example"; // String | Mapping Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      GetMappingResponse result = apiInstance.getMapping(mappingId, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MappingsApi#getMapping");
      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
mappingId String Mapping Identifier
siteId String Site Identifier [optional]

Return type

GetMappingResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

getMappings

GetMappingsResponse getMappings(siteId, limit, next)

Get Mappings

Returns a list of mappings; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.MappingsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    MappingsApi apiInstance = new MappingsApi(defaultClient);
    String siteId = "siteId_example"; // String | Site Identifier
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetMappingsResponse result = apiInstance.getMappings(siteId, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MappingsApi#getMappings");
      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
siteId String Site Identifier [optional]
limit String Limit Results [optional] [default to 10]
next String Next page of results token [optional]

Return type

GetMappingsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

setMapping

SetResponse setMapping(mappingId, setMappingRequest, siteId)

Set Mapping

Sets an mapping; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.MappingsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    MappingsApi apiInstance = new MappingsApi(defaultClient);
    String mappingId = "mappingId_example"; // String | Mapping Identifier
    SetMappingRequest setMappingRequest = new SetMappingRequest(); // SetMappingRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      SetResponse result = apiInstance.setMapping(mappingId, setMappingRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MappingsApi#setMapping");
      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
mappingId String Mapping Identifier
setMappingRequest SetMappingRequest
siteId String Site Identifier [optional]

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 CREATED * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -