Class ByProjectKeyStatesKeyByKeyRequestBuilder
Constructors
constructor
Parameters
- args: {
baseUri?: string;
executeRequest: executeRequest;
pathArgs: { key: string; projectKey: string };
}
Properties
Protected Readonlyargs
args: { baseUri?: string; executeRequest: executeRequest; pathArgs: { key: string; projectKey: string };} Methods
delete
delete( methodArgs: { headers?: { [key: string]: string | string[] }; queryArgs: { expand?: string | string[]; version: number; [key: string]: QueryParam; }; },): ApiRequest<State> Parameters
- methodArgs: {
headers?: { [key: string]: string | string[] };
queryArgs: {
expand?: string | string[];
version: number;
[key: string]: QueryParam;
};
}
get
get( methodArgs?: { headers?: { [key: string]: string | string[] }; queryArgs?: { expand?: string | string[]; [key: string]: QueryParam }; },): ApiRequest<State> Parameters
OptionalmethodArgs: {
headers?: { [key: string]: string | string[] };
queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
}
head
head( methodArgs?: { headers?: { [key: string]: string | string[] } },): ApiRequest<void> Parameters
OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }
post
post( methodArgs: { body: StateUpdate; headers?: { [key: string]: string | string[] }; queryArgs?: { expand?: string | string[]; [key: string]: QueryParam }; },): ApiRequest<State> Parameters
- methodArgs: {
body: StateUpdate;
headers?: { [key: string]: string | string[] };
queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
}
Checks if a State exists for a given
key. Returns a200 OKstatus if the State exists or a404 Not Foundotherwise.