AgentsListOptimizationCandidatesOptionalParams interface
Valfria parametrar.
- Extends
Egenskaper
| after | Candidate-ID markör som identifierar det sista objektet från föregående sida. |
| before | Candidate-ID markör identifierar det första objektet från nästa sida. |
| expand | Kommaseparerad lista över expand-tangenter. Passa |
| limit | En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20. |
| order | Sortera ordning efter kandidatens |
Ärvda egenskaper
| abort |
Den signal som kan användas för att avbryta begäranden. |
| on |
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger. |
| request |
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden. |
| tracing |
Alternativ som används när spårning är aktiverat. |
Egenskapsinformation
after
Candidate-ID markör som identifierar det sista objektet från föregående sida.
after?: stringEgenskapsvärde
string
before
Candidate-ID markör identifierar det första objektet från nästa sida.
before?: stringEgenskapsvärde
string
expand
Kommaseparerad lista över expand-tangenter. Passa mutations för att fylla mutationsfält value ; utelämna att ta emot mutationsobjekt som endast typeinnehåller . Ytterligare expand-tangenter kan läggas till i framtida förhandsvisningar.
expand?: "mutations"[]Egenskapsvärde
"mutations"[]
limit
En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20.
limit?: numberEgenskapsvärde
number
order
Sortera ordning efter kandidatens started_at tidsstämpel.
order?: PageOrderEgenskapsvärde
Information om ärvda egenskaper
abortSignal
Den signal som kan användas för att avbryta begäranden.
abortSignal?: AbortSignalLikeEgenskapsvärde
ärvd från OperationOptions.abortSignal
onResponse
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
onResponse?: RawResponseCallbackEgenskapsvärde
ärvd från OperationOptions.onResponse
requestOptions
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
requestOptions?: OperationRequestOptionsEgenskapsvärde
ärvd från OperationOptions.requestOptions
tracingOptions
Alternativ som används när spårning är aktiverat.
tracingOptions?: OperationTracingOptionsEgenskapsvärde
ärvd från OperationOptions.tracingOptions