com.fortanix.sdkms.v1.api

Class ApprovalRequestsApi

java.lang.Object

com.fortanix.sdkms.v1.api.ApprovalRequestsApi

public class ApprovalRequestsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApprovalRequestsApi()
ApprovalRequestsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	approve(String requestId, ApproveRequest body) Approve a request.
ApprovalRequest	createApprovalRequest(ApprovalRequestRequest body) Create approval request
void	deleteApprovalRequest(String requestId) Delete an approval request.
void	deny(String requestId) Deny a request.
ApiClient	getApiClient()
ApprovalRequest	getApprovalRequest(String requestId) Get an approval request.
List<ApprovalRequest>	getApprovalRequests(String requester, String reviewer, String subject, String status) Get all approval requests
ApprovableResult	getResult(String requestId) Get the result for an approved or failed request.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApprovalRequestsApi

public ApprovalRequestsApi()

ApprovalRequestsApi

public ApprovalRequestsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

approve

public void approve(String requestId,
                    ApproveRequest body)
             throws ApiException

Approve a request.

Parameters:

requestId - Approval Request Identifier (required)

body - Approve an approval request (optional)

Throws:

ApiException - if fails to make API call

createApprovalRequest

public ApprovalRequest createApprovalRequest(ApprovalRequestRequest body)
                                      throws ApiException

Create approval request

Parameters:

body - Request to create an approval request. (required)

Returns:

ApprovalRequest

Throws:

ApiException - if fails to make API call

deleteApprovalRequest

public void deleteApprovalRequest(String requestId)
                           throws ApiException

Delete an approval request.

Parameters:

requestId - Approval Request Identifier (required)

Throws:

ApiException - if fails to make API call

deny

public void deny(String requestId)
          throws ApiException

Deny a request.

Parameters:

requestId - Approval Request Identifier (required)

Throws:

ApiException - if fails to make API call

getApprovalRequest

public ApprovalRequest getApprovalRequest(String requestId)
                                   throws ApiException

Get an approval request. Get the details and status of a particular approval request.

Parameters:

requestId - Approval Request Identifier (required)

Returns:

ApprovalRequest

Throws:

ApiException - if fails to make API call

getApprovalRequests

public List<ApprovalRequest> getApprovalRequests(String requester,
                                                 String reviewer,
                                                 String subject,
                                                 String status)
                                          throws ApiException

Get all approval requests

Parameters:

requester - Only retrieve approval requests with the specified requester ID (optional)

reviewer - Only retrieve approval requests with the specified reviewer ID (optional)

subject - Only retrieve approval requests with the specified subject ID (optional)

status - Only retrieve approval requests with the specified approval status (optional)

Returns:

List<ApprovalRequest>

Throws:

ApiException - if fails to make API call

getResult

public ApprovableResult getResult(String requestId)
                           throws ApiException

Get the result for an approved or failed request.

Parameters:

requestId - Approval Request Identifier (required)

Returns:

ApprovableResult

Throws:

ApiException - if fails to make API call