Class ByProjectKeyStatesRequestBuilder
Constructors
constructor
Parameters
- args: {
baseUri?: string;
executeRequest: executeRequest;
pathArgs: { projectKey: string };
}
Properties
Protected Readonlyargs
args: { baseUri?: string; executeRequest: executeRequest; pathArgs: { projectKey: string };} Methods
get
get( methodArgs?: { headers?: { [key: string]: string | string[] }; queryArgs?: { expand?: string | string[]; limit?: number; offset?: number; sort?: string | string[]; where?: string | string[]; withTotal?: boolean; [key: string]: QueryParam; }; },): ApiRequest<StatePagedQueryResponse> Parameters
OptionalmethodArgs: {
headers?: { [key: string]: string | string[] };
queryArgs?: {
expand?: string | string[];
limit?: number;
offset?: number;
sort?: string | string[];
where?: string | string[];
withTotal?: boolean;
[key: string]: QueryParam;
};
}
head
head( methodArgs?: { headers?: { [key: string]: string | string[] }; queryArgs?: { where?: string | string[]; [key: string]: QueryParam }; },): ApiRequest<void> Parameters
OptionalmethodArgs: {
headers?: { [key: string]: string | string[] };
queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
}
post
post( methodArgs: { body: StateDraft; headers?: { [key: string]: string | string[] }; queryArgs?: { expand?: string | string[]; [key: string]: QueryParam }; },): ApiRequest<State> Parameters
- methodArgs: {
body: StateDraft;
headers?: { [key: string]: string | string[] };
queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
}
withId
Parameters
- childPathArgs: { ID: string }
withKey
Parameters
- childPathArgs: { key: string }
Checks if a State exists for a given Query Predicate. Returns a
200 OKstatus if any States match the Query Predicate or a404 Not Foundotherwise.