计划端点
计划端点和参数
要详细了解对象关系以及如何在 API 中使用对象关系,请参阅对象关系部分。
如需详细了解使用 GET 和 PUT 计划端点时可以输入的有效时区,请访问时区。
如需详细了解计划,请访问计划帮助页面。
创建新计划
要上传新工作流,请使用 POST {baseURL}/v3/workflows
端点。
注意
所有"日期时间"字段都需要作为 -0提交。
参数
合同 (正文):要创建新计划,需要提供合同参数。指定以下参数:
WorkflowId (字符串):输入要计划的工作流 ID。
迭代 (实体):
iterationType (string):指定是否计划以下列频率运行工作流:“一次”、“每小时”、“每日”、“每周”、“每月”和“自定义”。不要忘记为相应的迭代类型指定每小时 (hourlyContract)、每日 (dailyContract)、每周 (weeklyContract)、每月 (monthlyContract) 或自定义 (customContract) 频率。如需了解详情,请访问计划工作流帮助页面。
workflowCredentialType (string):必填。一次:选择运行工作流的具体日期和时间。开始日期必须是将来的日期。
name (string):可选。输入工作流运行应结束的特定日期和时间
hourlyContract (主体):可选。如果将iterationType指定为'hourly',则使用。
小时 (字符串):输入小时。
分钟 (字符串):输入分钟。
dailyContract (主体):可选。如果将iterationType指定为'daily',则使用。
hasPrivateDataExemption (boolean):可选。如果未指定,则默认值为false。
WeeklyContract (主体):可选。如果将迭代类型指定为"每周",则使用。
daysOfWeek (字符串):指定工作流应在一周中的哪一天运行。例如,"星期日"。
MonthlyContract (主体):可选。如果将迭代类型指定为"每月",则使用。
simpleDayOfMonth (布尔值):如果要指定一个月中运行工作流的特定日期,请输入"true"。
dayofmonth (字符串):输入要运行工作流的每月天数。例如,输入"1"作为月份的第一天。
事件 (字符串):如果要运行工作流,请输入以下选项之一,例如,每月的第一个星期日。可接受的值包括:'1'(第一次出现),'2'(第二次出现),'3'(第三次出现),'4'(第四次出现)和' -1 '(该月的最后一次出现)。
DayOfWeek (整数):指定应在一周中的哪一天运行工作流。例如,对于星期日,输入"0"或"Sunday"。
customContract (主体):可选。如果将迭代类型指定为"自定义",则使用。
daysOfMonth (数组):指定工作流应在每月的哪几天运行。例如,[1,15,28]。
月数 (数组):指定运行工作流的月份。例如,[1,5,7,9, 12]。
name (string):可选。输入计划的名称。
comments (string):可选。根据需要输入注释。
versionId (string):可选。指定运行计划的优先级。从以下选项中选择:"低","中","高"和"严重"。如果未指定,默认值将为"低"。
workerTag (string):可选。指定分配的工作程序。如果未指定,则值将为"无"。
credentialId (string):可选。
timeZone (string):可选。指定应在其中创建计划的时区。如需详细了解有效时区,请转至时区。
示例:“timeZone”: “Etc/GMT+4”
请求示例:cURL
创建计划的请求示例,该计划出现以下情况-一次,指定开始和结束时间:
创建具有每小时发生次数的计划的请求示例:
创建包含每周事件的计划的请求示例:
创建每月发生次数-每月第二个星期日的计划的请求示例:
创建每月发生次数的计划的请求示例-每月的15天:
创建自定义计划的请求示例:
获取有关所有计划的信息
要获取有关所有工作流记录的信息,请使用 GET {baseURL}/v3/workflows/
端点。使用各种参数过滤要显示的计划。
注意
当您使用 runsAfter 和 runsBefore过滤计划时,您之间的间隔时间限制为45天。
参数
view (string):可选。可以保留此参数但不为其提供值。您可以从以下值中选择:“默认值(Default)”和“全部(Full)”。如果此参数设置为“Default”,则将返回一个减小的视图对象。未指定时,将使用“默认值(Default)”。
ownerId (string):可选。输入要为其检索信息的的工作流 ID。
versionId (string):可选。输入要为其检索信息的的工作流 ID。
运行后 (日期时间):可选。输入日期和时间,工作流是在此之后创建的。以 ISO8601 格式输入日期和时间。
运行之前 (日期时间):可选。输入日期时间,工作流是在此之前创建的。以 ISO8601 格式输入日期和时间。
请求示例:cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
搜索特定时间表
要搜索特定计划,请使用 get {baseURL}/v3/schedules/{id}
终结点。
参数
workflowCredentialType (string):必填。输入计划ID以检索有关此计划的信息。
请求示例:cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
更新现有计划
要更新现有计划,请使用 put {baseURL}/v3/schedules/{id}
endpoint。
参数
workflowCredentialType (string):必填。输入计划ID以更新此计划。
合同 (主体):必填。要更新计划,需要"合同"参数。指定以下内容:
workflowCredentialType (string):必填。输入计划ID以更新此用户。
ownerId (string):必填。输入用户ID。
迭代 (实体):
iterationType (string):指定是否计划以下列频率运行工作流:“一次”、“每小时”、“每日”、“每周”、“每月”和“自定义”。不要忘记为相应的迭代类型指定每小时 (hourlyContract)、每日 (dailyContract)、每周 (weeklyContract)、每月 (monthlyContract) 或自定义 (customContract) 频率。如需了解详情,请访问计划工作流帮助页面。
workflowCredentialType (string):必填。一次:选择运行工作流的具体日期和时间。开始日期必须是将来的日期。
workflowCredentialType (string):必填。输入工作流运行应结束的特定日期和时间
hourlyContract (主体):可选。如果将iterationType指定为'hourly',则使用。
小时 (字符串):输入小时。
分钟 (字符串):输入分钟。
dailyContract (主体):可选。如果将iterationType指定为'daily',则使用。
hasPrivateDataExemption (boolean):可选。如果未指定,则默认值为false。
WeeklyContract (主体):可选。如果将迭代类型指定为"每周",则使用。
daysOfWeek (字符串):指定工作流应在一周中的哪一天运行。例如,"星期日"。
MonthlyContract (主体):可选。如果将迭代类型指定为"每月",则使用。
simpleDayOfMonth (布尔值):如果要指定一个月中运行工作流的特定日期,请输入"true"。
dayofmonth (字符串):输入要运行工作流的每月天数。例如,输入"1"作为月份的第一天。
事件 (字符串):如果要运行工作流,请输入以下选项之一,例如,每月的第一个星期日。可接受的值包括:'1'(第一次出现),'2'(第二次出现),'3'(第三次出现),'4'(第四次出现)和' -1 '(该月的最后一次出现)。
DayOfWeek (整数):指定应在一周中的哪一天运行工作流。例如,对于星期日,输入"0"或"Sunday"。
customContract (主体):可选。如果将迭代类型指定为"自定义",则使用。
daysOfMonth (数组):指定工作流应在每月的哪几天运行。例如,[1,15,28]。
月数 (数组):指定运行工作流的月份。例如,[1,5,7,9, 12]。
name (string):必填。输入计划的名称。
comments (string):必填。根据需要输入注释。
versionId (string):可选。指定运行计划的优先级。从以下选项中选择:"低","中","高"和"严重"。如果未指定,则默认值为"低"。
workerTag (string):必填。指定分配的工作程序。如果未指定,则值将为"无"。
hasPrivateDataExemption (boolean):可选。指定应启用还是禁用计划。
workflowCredentialType (string):必填。
timeZone (string):可选。指定应在其中创建计划的时区。如需详细了解有效时区,请转至时区。
示例:“timeZone”: “Etc/GMT+4”
请求示例:cURL
更新计划的请求示例-更改开始和结束时间,名称和注释(正文):
删除计划
要从系统中删除特定计划,请使用 delete {baseURL}/v3/schedules/{id}
endpoint。
参数
workflowCredentialType (string):必填。选择要删除的计划。
请求示例:cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
对象关系
如果您要上传工作流,则可以按如下方式使用创建的对象:
创建的对象:“workflowId”(例如,“id”: “7917969784f84bd09442f66996ecb8f3”)
您可以将其用作:
Postman 请求示例
获取/v3/schedules/
如需详细了解有关 Postman 请求的更多信息,请访问如何使用 Postman 帮助页面。
时区
此表格列出了使用以下端点时可以输入的有效时区:
POST {baseURL}/v3/schedules
PUT {baseURL}/v3/schedules
GET {baseURL}/v3/schedules/{id}
GET {baseURL}/v3/schedules
时区 | UTC 时区偏移量 |
---|---|
Etc/GMT+12 | -12:00 |
Etc/GMT+11 | -11:00 |
Pacific/Niue | -11:00 |
Pacific/Pago_Pago | -11:00 |
Etc/GMT+10 | -10:00 |
HST | -10:00 |
Pacific/Honolulu | -10:00 |
Pacific/Rarotonga | -10:00 |
Pacific/Tahiti | -10:00 |
Pacific/Marquesas | -09:30 |
America/Adak | -09:00 |
Etc/GMT+9 | -09:00 |
Pacific/Gambier | -09:00 |
America/Anchorage | -08:00 |
America/Juneau | -08:00 |
America/Metlakatla | -08:00 |
America/Nome | -08:00 |
America/Sitka | -08:00 |
America/Yakutat | -08:00 |
Etc/GMT+8 | -08:00 |
Pacific/Pitcairn | -08:00 |
America/Creston | -07:00 |
America/Dawson | -07:00 |
America/Dawson_Creek | -07:00 |
America/Fort_Nelson | -07:00 |
America/Hermosillo | -07:00 |
America/Los_Angeles | -07:00 |
America/Phoenix | -07:00 |
America/Tijuana | -07:00 |
America/Vancouver | -07:00 |
America/Whitehorse | -07:00 |
Etc/GMT+7 | -07:00 |
MST | -07:00 |
PST8PDT | -07:00 |
America/Belize | -06:00 |
America/Boise | -06:00 |
America/Cambridge_Bay | -06:00 |
America/Chihuahua | -06:00 |
America/Costa_Rica | -06:00 |
America/Denver | -06:00 |
America/Edmonton | -06:00 |
America/El_Salvador | -06:00 |
America/Guatemala | -06:00 |
America/Inuvik | -06:00 |
America/Managua | -06:00 |
America/Mazatlan | -06:00 |
America/Ojinaga | -06:00 |
America/Regina | -06:00 |
America/Swift_Current | -06:00 |
America/Tegucigalpa | -06:00 |
America/Yellowknife | -06:00 |
Etc/GMT+6 | -06:00 |
MST7MDT | -06:00 |
Pacific/Galapagos | -06:00 |
America/Atikokan | -05:00 |
America/Bahia_Banderas | -05:00 |
America/Bogota | -05:00 |
America/Cancun | -05:00 |
America/Chicago | -05:00 |
America/Eirunepe | -05:00 |
America/Guayaquil | -05:00 |
America/Indiana/Knox | -05:00 |
America/Indiana/Tell_City | -05:00 |
America/Jamaica | -05:00 |
America/Lima | -05:00 |
America/Matamoros | -05:00 |
America/Menominee | -05:00 |
America/Merida | -05:00 |
America/Mexico_City | -05:00 |
America/Monterrey | -05:00 |
America/North_Dakota/Beulah | -05:00 |
America/North_Dakota/Center | -05:00 |
America/North_Dakota/New_Salem | -05:00 |
America/Panama | -05:00 |
America/Rainy_River | -05:00 |
America/Rankin_Inlet | -05:00 |
America/Resolute | -05:00 |
America/Rio_Branco | -05:00 |
America/Winnipeg | -05:00 |
CST6CDT | -05:00 |
EST | -05:00 |
Etc/GMT+5 | -05:00 |
Pacific/Easter | -05:00 |
America/Asuncion | -04:00 |
America/Barbados | -04:00 |
America/Blanc-Sablon | -04:00 |
America/Boa_Vista | -04:00 |
America/Campo_Grande | -04:00 |
America/Caracas | -04:00 |
America/Cuiaba | -04:00 |
America/Curacao | -04:00 |
America/Detroit | -04:00 |
America/Grand_Turk | -04:00 |
America/Guyana | -04:00 |
America/Havana | -04:00 |
America/Indiana/Indianapolis | -04:00 |
America/Indiana/Marengo | -04:00 |
America/Indiana/Petersburg | -04:00 |
America/Indiana/Vevay | -04:00 |
America/Indiana/Vincennes | -04:00 |
America/Indiana/Winamac | -04:00 |
America/Iqaluit | -04:00 |
America/Kentucky/Louisville | -04:00 |
America/Kentucky/Monticello | -04:00 |
America/La_Paz | -04:00 |
America/Manaus | -04:00 |
America/Martinique | -04:00 |
America/Nassau | -04:00 |
America/New_York | -04:00 |
America/Nipigon | -04:00 |
America/Pangnirtung | -04:00 |
America/Port_of_Spain | -04:00 |
America/Port-au-Prince | -04:00 |
America/Porto_Velho | -04:00 |
America/Puerto_Rico | -04:00 |
America/Santo_Domingo | -04:00 |
America/Thunder_Bay | -04:00 |
America/Toronto | -04:00 |
EST5EDT | -04:00 |
Etc/GMT+4 | -04:00 |
America/Araguaina | -03:00 |
America/Argentina/Buenos_Aires | -03:00 |
America/Argentina/Catamarca | -03:00 |
America/Argentina/Cordoba | -03:00 |
America/Argentina/Jujuy | -03:00 |
America/Argentina/La_Rioja | -03:00 |
America/Argentina/Mendoza | -03:00 |
America/Argentina/Rio_Gallegos | -03:00 |
America/Argentina/Salta | -03:00 |
America/Argentina/San_Juan | -03:00 |
America/Argentina/San_Luis | -03:00 |
America/Argentina/Tucuman | -03:00 |
America/Argentina/Ushuaia | -03:00 |
America/Bahia | -03:00 |
America/Belem | -03:00 |
America/Cayenne | -03:00 |
America/Fortaleza | -03:00 |
America/Glace_Bay | -03:00 |
America/Goose_Bay | -03:00 |
America/Halifax | -03:00 |
America/Maceio | -03:00 |
America/Moncton | -03:00 |
America/Montevideo | -03:00 |
America/Paramaribo | -03:00 |
America/Punta_Arenas | -03:00 |
America/Recife | -03:00 |
America/Santarem | -03:00 |
America/Santiago | -03:00 |
America/Sao_Paulo | -03:00 |
America/Thule | -03:00 |
Antarctica/Palmer | -03:00 |
Antarctica/Rothera | -03:00 |
Atlantic/Bermuda | -03:00 |
Atlantic/Stanley | -03:00 |
Etc/GMT+3 | -03:00 |
America/St_Johns | -02:30 |
America/Godthab | -02:00 |
America/Miquelon | -02:00 |
America/Noronha | -02:00 |
Atlantic/South_Georgia | -02:00 |
Etc/GMT+2 | -02:00 |
Atlantic/Cape_Verde | -01:00 |
Etc/GMT+1 | -01:00 |
Africa/Abidjan | +00:00 |
Africa/Accra | +00:00 |
Africa/Bissau | +00:00 |
Africa/Monrovia | +00:00 |
Africa/Sao_Tome | +00:00 |
America/Danmarkshavn | +00:00 |
America/Scoresbysund | +00:00 |
Atlantic/Azores | +00:00 |
Atlantic/Reykjavik | +00:00 |
Etc/GMT | +00:00 |
Etc/UTC | +00:00 |
Africa/Algiers | +01:00 |
Africa/Casablanca | +01:00 |
Africa/El_Aaiun | +01:00 |
Africa/Lagos | +01:00 |
Africa/Ndjamena | +01:00 |
Africa/Tunis | +01:00 |
Atlantic/Canary | +01:00 |
Atlantic/Faroe | +01:00 |
Atlantic/Madeira | +01:00 |
Etc/GMT-1 | +01:00 |
Europe/Dublin | +01:00 |
Europe/Lisbon | +01:00 |
Europe/London | +01:00 |
WET | +01:00 |
Africa/Cairo | +02:00 |
Africa/Ceuta | +02:00 |
Africa/Johannesburg | +02:00 |
Africa/Khartoum | +02:00 |
Africa/Maputo | +02:00 |
Africa/Tripoli | +02:00 |
Africa/Windhoek | +02:00 |
Antarctica/Troll | +02:00 |
CET | +02:00 |
Etc/GMT-2 | +02:00 |
Europe/Amsterdam | +02:00 |
Europe/Andorra | +02:00 |
Europe/Belgrade | +02:00 |
Europe/Berlin | +02:00 |
Europe/Brussels | +02:00 |
Europe/Budapest | +02:00 |
Europe/Copenhagen | +02:00 |
Europe/Gibraltar | +02:00 |
Europe/Kaliningrad | +02:00 |
Europe/Luxembourg | +02:00 |
Europe/Madrid | +02:00 |
Europe/Malta | +02:00 |
Europe/Monaco | +02:00 |
Europe/Oslo | +02:00 |
Europe/Paris | +02:00 |
Europe/Prague | +02:00 |
Europe/Rome | +02:00 |
Europe/Stockholm | +02:00 |
Europe/Tirane | +02:00 |
Europe/Vienna | +02:00 |
Europe/Warsaw | +02:00 |
Europe/Zurich | +02:00 |
MET | +02:00 |
Africa/Juba | +03:00 |
Africa/Nairobi | +03:00 |
Antarctica/Syowa | +03:00 |
Asia/Amman | +03:00 |
Asia/Baghdad | +03:00 |
Asia/Beirut | +03:00 |
Asia/Damascus | +03:00 |
Asia/Famagusta | +03:00 |
Asia/Gaza | +03:00 |
Asia/Hebron | +03:00 |
Asia/Jerusalem | +03:00 |
Asia/Nicosia | +03:00 |
Asia/Qatar | +03:00 |
Asia/Riyadh | +03:00 |
EET | +03:00 |
Etc/GMT-3 | +03:00 |
Europe/Athens | +03:00 |
Europe/Bucharest | +03:00 |
Europe/Chisinau | +03:00 |
Europe/Helsinki | +03:00 |
Europe/Istanbul | +03:00 |
Europe/Kiev | +03:00 |
Europe/Kirov | +03:00 |
Europe/Minsk | +03:00 |
Europe/Moscow | +03:00 |
Europe/Riga | +03:00 |
Europe/Simferopol | +03:00 |
Europe/Sofia | +03:00 |
Europe/Tallinn | +03:00 |
Europe/Uzhgorod | +03:00 |
Europe/Vilnius | +03:00 |
Europe/Zaporozhye | +03:00 |
Asia/Baku | +04:00 |
Asia/Dubai | +04:00 |
Asia/Tbilisi | +04:00 |
Asia/Yerevan | +04:00 |
Etc/GMT-4 | +04:00 |
Europe/Astrakhan | +04:00 |
Europe/Samara | +04:00 |
Europe/Saratov | +04:00 |
Europe/Ulyanovsk | +04:00 |
Europe/Volgograd | +04:00 |
Indian/Mahe | +04:00 |
Indian/Mauritius | +04:00 |
Indian/Reunion | +04:00 |
Asia/Kabul | +04:30 |
Asia/Tehran | +04:30 |
Antarctica/Mawson | +05:00 |
Asia/Aqtau | +05:00 |
Asia/Aqtobe | +05:00 |
Asia/Ashgabat | +05:00 |
Asia/Atyrau | +05:00 |
Asia/Dushanbe | +05:00 |
Asia/Karachi | +05:00 |
Asia/Oral | +05:00 |
Asia/Qyzylorda | +05:00 |
Asia/Samarkand | +05:00 |
Asia/Tashkent | +05:00 |
Asia/Yekaterinburg | +05:00 |
Etc/GMT-5 | +05:00 |
Indian/Kerguelen | +05:00 |
Indian/Maldives | +05:00 |
Asia/Colombo | +05:30 |
Asia/Kolkata | +05:30 |
Asia/Kathmandu | +05:45 |
Antarctica/Vostok | +06:00 |
Asia/Almaty | +06:00 |
Asia/Bishkek | +06:00 |
Asia/Dhaka | +06:00 |
Asia/Omsk | +06:00 |
Asia/Qostanay | +06:00 |
Asia/Thimphu | +06:00 |
Asia/Urumqi | +06:00 |
Etc/GMT-6 | +06:00 |
Indian/Chagos | +06:00 |
Asia/Yangon | +06:30 |
Indian/Cocos | +06:30 |
Antarctica/Davis | +07:00 |
Asia/Bangkok | +07:00 |
Asia/Barnaul | +07:00 |
Asia/Ho_Chi_Minh | +07:00 |
Asia/Hovd | +07:00 |
Asia/Jakarta | +07:00 |
Asia/Krasnoyarsk | +07:00 |
Asia/Novokuznetsk | +07:00 |
Asia/Novosibirsk | +07:00 |
Asia/Pontianak | +07:00 |
Asia/Tomsk | +07:00 |
Etc/GMT-7 | +07:00 |
Indian/Christmas | +07:00 |
Antarctica/Casey | +08:00 |
Asia/Brunei | +08:00 |
Asia/Choibalsan | +08:00 |
Asia/Hong_Kong | +08:00 |
Asia/Irkutsk | +08:00 |
Asia/Kuala_Lumpur | +08:00 |
Asia/Kuching | +08:00 |
Asia/Macau | +08:00 |
Asia/Makassar | +08:00 |
Asia/Manila | +08:00 |
Asia/Shanghai | +08:00 |
Asia/Singapore | +08:00 |
Asia/Taipei | +08:00 |
Asia/Ulaanbaatar | +08:00 |
Australia/Perth | +08:00 |
Etc/GMT-8 | +08:00 |
Australia/Eucla | +08:45 |
Asia/Chita | +09:00 |
Asia/Dili | +09:00 |
Asia/Jayapura | +09:00 |
Asia/Khandyga | +09:00 |
Asia/Pyongyang | +09:00 |
Asia/Seoul | +09:00 |
Asia/Tokyo | +09:00 |
Asia/Yakutsk | +09:00 |
Etc/GMT-9 | +09:00 |
Pacific/Palau | +09:00 |
Australia/Adelaide | +09:30 |
Australia/Broken_Hill | +09:30 |
Australia/Darwin | +09:30 |
Antarctica/DumontDUrville | +10:00 |
Asia/Ust-Nera | +10:00 |
Asia/Vladivostok | +10:00 |
Australia/Brisbane | +10:00 |
Australia/Currie | +10:00 |
Australia/Hobart | +10:00 |
Australia/Lindeman | +10:00 |
Australia/Melbourne | +10:00 |
Australia/Sydney | +10:00 |
Etc/GMT-10 | +10:00 |
Pacific/Chuuk | +10:00 |
Pacific/Guam | +10:00 |
Pacific/Port_Moresby | +10:00 |
Australia/Lord_Howe | +10:30 |
Antarctica/Macquarie | +11:00 |
Asia/Magadan | +11:00 |
Asia/Sakhalin | +11:00 |
Asia/Srednekolymsk | +11:00 |
Etc/GMT-11 | +11:00 |
Pacific/Bougainville | +11:00 |
Pacific/Efate | +11:00 |
Pacific/Guadalcanal | +11:00 |
Pacific/Kosrae | +11:00 |
Pacific/Norfolk | +11:00 |
Pacific/Noumea | +11:00 |
Pacific/Pohnpei | +11:00 |
Asia/Anadyr | +12:00 |
Asia/Kamchatka | +12:00 |
Etc/GMT-12 | +12:00 |
Pacific/Auckland | +12:00 |
Pacific/Fiji | +12:00 |
Pacific/Funafuti | +12:00 |
Pacific/Kwajalein | +12:00 |
Pacific/Majuro | +12:00 |
Pacific/Nauru | +12:00 |
Pacific/Tarawa | +12:00 |
Pacific/Wake | +12:00 |
Pacific/Wallis | +12:00 |
Pacific/Chatham | +12:45 |
Etc/GMT-13 | +13:00 |
Pacific/Apia | +13:00 |
Pacific/Enderbury | +13:00 |
Pacific/Fakaofo | +13:00 |
Pacific/Tongatapu | +13:00 |
Etc/GMT-14 | +14:00 |
Pacific/Kiritimati | +14:00 |