org.openapitools.client.api

Class LinkedObjectApi

java.lang.Object

org.openapitools.client.api.LinkedObjectApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.LinkedObjectApi")
public class LinkedObjectApi
extends Object

Constructor Summary

Constructors

Constructor and Description
LinkedObjectApi()
LinkedObjectApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createLinkedObjectDefinition(Class<?> T, LinkedObject linkedObject) Create a Linked Object Definition Creates a linked object definition
LinkedObject	createLinkedObjectDefinition(LinkedObject linkedObject) Create a Linked Object Definition Creates a linked object definition
PagedList	createLinkedObjectDefinitionWithPaginationInfo(LinkedObject linkedObject) Create a Linked Object Definition Creates a linked object definition
void	deleteLinkedObjectDefinition(String linkedObjectName) Delete a Linked Object Definition Deletes a linked object definition
ApiClient	getApiClient()
LinkedObject	getLinkedObjectDefinition(String linkedObjectName) Retrieve a Linked Object Definition Retrieves a linked object definition
PagedList	getLinkedObjectDefinitionWithPaginationInfo(String linkedObjectName) Retrieve a Linked Object Definition Retrieves a linked object definition
List<LinkedObject>	listLinkedObjectDefinitions() List all Linked Object Definitions Lists all linked object definitions
PagedList	listLinkedObjectDefinitionsWithPaginationInfo() List all Linked Object Definitions Lists all linked object definitions
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkedObjectApi

public LinkedObjectApi()

LinkedObjectApi

@Autowired
public LinkedObjectApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createLinkedObjectDefinition

public LinkedObject createLinkedObjectDefinition(LinkedObject linkedObject)
                                          throws org.springframework.web.client.RestClientException

Create a Linked Object Definition Creates a linked object definition

201 - Created

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

linkedObject - (required)

Returns:

LinkedObject

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createLinkedObjectDefinition

public <T> T createLinkedObjectDefinition(Class<?> T,
                                          LinkedObject linkedObject)
                                   throws org.springframework.web.client.RestClientException

Create a Linked Object Definition Creates a linked object definition

201 - Created

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

linkedObject - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createLinkedObjectDefinitionWithPaginationInfo

public PagedList createLinkedObjectDefinitionWithPaginationInfo(LinkedObject linkedObject)
                                                         throws org.springframework.web.client.RestClientException

Create a Linked Object Definition Creates a linked object definition

201 - Created

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

linkedObject - (required)

Returns:

ResponseEntity<LinkedObject>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteLinkedObjectDefinition

public void deleteLinkedObjectDefinition(String linkedObjectName)
                                  throws org.springframework.web.client.RestClientException

Delete a Linked Object Definition Deletes a linked object definition

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

linkedObjectName - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getLinkedObjectDefinition

public LinkedObject getLinkedObjectDefinition(String linkedObjectName)
                                       throws org.springframework.web.client.RestClientException

Retrieve a Linked Object Definition Retrieves a linked object definition

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

linkedObjectName - (required)

Returns:

LinkedObject

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getLinkedObjectDefinitionWithPaginationInfo

public PagedList getLinkedObjectDefinitionWithPaginationInfo(String linkedObjectName)
                                                      throws org.springframework.web.client.RestClientException

Retrieve a Linked Object Definition Retrieves a linked object definition

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

linkedObjectName - (required)

Returns:

ResponseEntity<LinkedObject>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLinkedObjectDefinitions

public List<LinkedObject> listLinkedObjectDefinitions()
                                               throws org.springframework.web.client.RestClientException

List all Linked Object Definitions Lists all linked object definitions

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

List<LinkedObject>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLinkedObjectDefinitionsWithPaginationInfo

public PagedList listLinkedObjectDefinitionsWithPaginationInfo()
                                                        throws org.springframework.web.client.RestClientException

List all Linked Object Definitions Lists all linked object definitions

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<List<LinkedObject>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API