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