Chuyển tới nội dung chính

Execute rule

POST/api/automation/rules/{ruleId}/execute
Quản trị viên

Đọc thêm: RESTMã nguồn: AutomationRuleApiController#execute(mở trong thẻ mới)

Tham số đường dẫn​

TênKiểuBắt buộcGhi chú
ruleIdstring (uuid)Bắt buộc

Request body​

application/json

TrườngKiểuBắt buộcGhi chú
releaseIdstring (uuid)Bắt buộc
requestIdstring (uuid)Tùy chọn

Response​

Thành công: 202

TrườngKiểuBắt buộcGhi chú
idstring (uuid)Tùy chọn
ruleIdstring (uuid)Tùy chọn
ruleNamestringTùy chọn
releaseIdstring (uuid)Tùy chọn
releaseVersionstringTùy chọn
triggerTypeenum TriggerTypeTùy chọnRELEASE_PUBLISHEDMANUALSCHEDULED_CRONUPCOMING_RELEASE_REMINDEREXTERNAL_WEBHOOK
requestIdstring (uuid)Tùy chọn
initiatorNamestringTùy chọn
statusenum ExecutionStatusTùy chọnPENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED
cancellationRequestedbooleanTùy chọn
createdAtstring (date-time)Tùy chọn
startedAtstring (date-time)Tùy chọn
completedAtstring (date-time)Tùy chọn
actionsarray of AutomationActionRunViewTùy chọn
actions[].idstring (uuid)Tùy chọn
actions[].positionintegerTùy chọn
actions[].actionTypeenum ActionTypeTùy chọnGITHUB_RELEASESLACKEMAILPUBLIC_CHANGELOGNOTIONCONFLUENCEMICROSOFT_TEAMSZENDESK
actions[].audienceNamestringTùy chọn
actions[].languagestringTùy chọn
actions[].statusenum ExecutionStatusTùy chọnPENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED
actions[].externalReferencestringTùy chọn
actions[].errorCodestringTùy chọn
actions[].attemptsintegerTùy chọn
actions[].startedAtstring (date-time)Tùy chọn
actions[].completedAtstring (date-time)Tùy chọn

Lỗi​

Trạng tháiMãÁp dụng cho
400validation_failedthiếu trường hoặc giá trị nằm ngoài khoảng cho phépMọi endpoint
400malformed_requestkhông đọc được bodyMọi endpoint
400invalid_parametermột tham số trên đường dẫn hoặc query bị thiếu hoặc không chuyển đổi được, chẳng hạn một ID không phải UUIDMọi endpoint
401authentication_requiredchưa có phiên đăng nhậpMọi endpoint
403access_deniedendpoint dành cho quản trị viên, hoặc CSRF token thiếu hay đã cũMọi endpoint
404not_foundkhông có địa chỉ đóMọi endpoint
405method_not_allowedđịa chỉ không nhận phương thức đóMọi endpoint
415unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đóMọi endpoint
500internal_errormột lỗi ReleaseFlow không lường trước; body không bao giờ chứa exception gây ra nóMọi endpoint
400, 404, 409Xem hướng dẫnKhu vực Automation

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/automation/rules/$RULE_ID/execute" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"releaseId": "<uuid>",
"requestId": "<uuid>"
}'

Request body là ví dụ dựng từ schema; thay mọi giá trị giữ chỗ trước khi gửi.

Response

202

Ví dụ

{
  "id": "<uuid>",
  "ruleId": "<uuid>",
  "ruleName": "<string>",
  "releaseId": "<uuid>",
  "releaseVersion": "<string>",
  "triggerType": "RELEASE_PUBLISHED",
  "requestId": "<uuid>",
  "initiatorName": "<string>",
  "status": "PENDING",
  "cancellationRequested": false,
  "createdAt": "<date-time>",
  "startedAt": "<date-time>",
  "completedAt": "<date-time>",
  "actions": [
    {
      "id": "<uuid>",
      "position": 0,
      "actionType": "GITHUB_RELEASE",
      "audienceName": "<string>",
      "language": "<string>",
      "status": "PENDING",
      "externalReference": "<string>",
      "errorCode": "<string>",
      "attempts": 0,
      "startedAt": "<date-time>",
      "completedAt": "<date-time>"
    }
  ]
}