Skip to content

Latest commit

 

History

History
256 lines (185 loc) · 8.29 KB

PicklistsApi.md

File metadata and controls

256 lines (185 loc) · 8.29 KB
Raw

PicklistsApi

Method HTTP request Description
addPickListOptionToPickList POST /picklists/{picklistId}/options Create a new pick list option for the pick list with the specified ID
getPickList GET /picklists/{picklistId} Get the pick list with the specified ID
getPickListOptions GET /picklists/{picklistId}/options Get all pick list options for the pick list with the specified ID
getPickLists GET /picklists Get all pick lists

addPickListOptionToPickList

CreatedResponse addPickListOptionToPickList(body, picklistId)

Create a new pick list option for the pick list with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PicklistsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PicklistsApi apiInstance = new PicklistsApi();
RequestPickListOption body = new RequestPickListOption(); // RequestPickListOption | 
Integer picklistId = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addPickListOptionToPickList(body, picklistId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PicklistsApi#addPickListOptionToPickList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestPickListOption
picklistId Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

getPickList

PickListDataWrapper getPickList(picklistId, include)

Get the pick list with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PicklistsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PicklistsApi apiInstance = new PicklistsApi();
Integer picklistId = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    PickListDataWrapper result = apiInstance.getPickList(picklistId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PicklistsApi#getPickList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
picklistId Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

PickListDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getPickListOptions

PickListOptionDataListWrapper getPickListOptions(picklistId, startAt, maxResults, include)

Get all pick list options for the pick list with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PicklistsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PicklistsApi apiInstance = new PicklistsApi();
Integer picklistId = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    PickListOptionDataListWrapper result = apiInstance.getPickListOptions(picklistId, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PicklistsApi#getPickListOptions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
picklistId Integer
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

PickListOptionDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getPickLists

PickListDataListWrapper getPickLists(startAt, maxResults, include)

Get all pick lists

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PicklistsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PicklistsApi apiInstance = new PicklistsApi();
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    PickListDataListWrapper result = apiInstance.getPickLists(startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PicklistsApi#getPickLists");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

PickListDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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