RequestsService

A list of all methods in the RequestsService service. Click on the method name to view detailed information about that method.

Methods	Description
listRequests	Returns a list of requests. Requests are sorted by creation date, descending.
createRequest	Creates a new request. You will need to pass in a Grant Kit ID as the target of this request. This will create a request against the latest version of the Grant Kit. Grant Kit Versions are immutable and you won't be able to create a request against an older Grant Kit Version. If you want to do this, you will have to roll forward by creating a new Grant Kit Version.
getRequestById	Returns the details of a request.
cancelRequestById	Cancels the specified request.

listRequests

Returns a list of requests. Requests are sorted by creation date, descending.

• HTTP Method: GET
• Endpoint: /requests

Return Type

List<Request>

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Request;
import java.util.List;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val response: List<Request> = testSdk.requests.listRequests();
    
    println(response);
}

createRequest

Creates a new request. You will need to pass in a Grant Kit ID as the target of this request. This will create a request against the latest version of the Grant Kit. Grant Kit Versions are immutable and you won't be able to create a request against an older Grant Kit Version. If you want to do this, you will have to roll forward by creating a new Grant Kit Version.

• HTTP Method: POST
• Endpoint: /requests

Parameters

Name	Type	Required	Description
requestParams	RequestParams	✅	Request Body

Return Type

Request

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Request;
import com.swagger.petstore.models.RequestParams;
import com.swagger.petstore.models.UserInput;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val userInput: UserInput = UserInput.builder()
			.expireIn("78488667m")
			.expireAt("expire_at")
			.build();
		
		val requestParams: RequestParams = RequestParams.builder()
			.grantKitId("grant_kit_id")
			.reason("reason")
			.userInput(userInput)
			.build();

    val response: Request = testSdk.requests.createRequest(requestParams);
    
    println(response);
}

getRequestById

Returns the details of a request.

• HTTP Method: GET
• Endpoint: /requests/{request_id}

Parameters

Name	Type	Required	Description
requestId	String	✅	The ID of the request to retrieve

Return Type

Request

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Request;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val response: Request = testSdk.requests.getRequestById("request_id");
    
    println(response);
}

cancelRequestById

Cancels the specified request.

• HTTP Method: PUT
• Endpoint: /requests/{request_id}/cancel

Parameters

Name	Type	Required	Description
requestId	String	✅	The ID of the request to cancel
requestCancelParams	RequestCancelParams	✅	Request Body

Return Type

Request

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Request;
import com.swagger.petstore.models.RequestCancelParams;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val requestCancelParams: RequestCancelParams = RequestCancelParams.builder()
			.reason("reason")
			.build();

    val response: Request = testSdk.requests.cancelRequestById("request_id", requestCancelParams);
    
    println(response);
}