Method: tasks.list

מציגה רשימה של משימות שתואמות למסנן שצוין.

בקשת HTTP

GET https://ces.googleapis.com/tasks

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
tenant

string

זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך tenant מהכרטיס AgentInterface שנבחר, אם השדה הזה מוגדר.
contextId

string

אפשר לסנן את המשימות לפי מזהה ההקשר כדי לקבל משימות משיחה או מסשן ספציפיים.
status

enum (TaskState)

סינון משימות לפי הסטטוס הנוכחי שלהן.
pageToken

string

טוקן של דף שהתקבל מקריאה קודמת של tasks.list. ListTasksResponse.next_page_token. צריך להזין את הטוקן כדי לאחזר את הדף הבא.
statusTimestampAfter

string (Timestamp format)

סינון משימות שהסטטוס שלהן עודכן אחרי חותמת הזמן שצוינה בפורמט ISO 8601 (למשל, ‎"2023-10-27T10:00:00Z"‎). יוחזרו רק משימות שחותמת הזמן של הסטטוס שלהן גדולה מהערך הזה או שווה לו.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
pageSize

integer

מספר המשימות המקסימלי שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 משימות. הערך המינימלי הוא 1. הערך המקסימלי הוא 100.
historyLength

integer

מספר ההודעות המקסימלי שייכללו בהיסטוריה של כל משימה.
includeArtifacts

boolean

האם לכלול ארטיפקטים במשימות שמוחזרות. ברירת המחדל היא false כדי להקטין את גודל המטען הייעודי (payload).

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אובייקט התוצאה של שיטת tasks.list שמכיל מערך של משימות ומידע על חלוקה לדפים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "pageSize": integer,
  "totalSize": integer
}
שדות
tasks[]

object (Task)

חובה. מערך של משימות שתואמות לקריטריונים שצוינו.
nextPageToken

string

חובה. אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין יותר תוצאות ברשימה.
pageSize

integer

חובה. גודל הדף ששימש לתשובה הזו.
totalSize

integer

חובה. המספר הכולל של המשימות שזמינות (לפני חלוקה לדפים).

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

ניתן למצוא מידע נוסף כאן: Authentication Overview.