ย้อนกลับเวอร์ชัน Workflow

ย้อนกลับเวอร์ชัน Workflow

รองรับการย้อนกลับเวอร์ชันประวัติของ Workflow ที่ระบุ โดยบันทึกเป็นเวอร์ชันใหม่ และเลือกที่จะเผยแพร่ทันทีได้

อินเทอร์เฟซนี้ใช้ API Key ของ Workflow เป้าหมายในการยืนยันตัวตน และอนุญาตให้เรียกใช้ได้เฉพาะ Workflow ที่เปิดสิทธิ์การจัดการเวอร์ชันเท่านั้น

วิธีการร้องขอ

POST

URL สำหรับร้องขอ

https://api.${endpoint}/v1/workflow/version/rollback

การยืนยันตัวตนในการร้องขอ

ดูรายละเอียดได้ที่คำอธิบายวิธีการยืนยันตัวตนใน API Overview โปรดใช้ API Key ของ Workflow เป้าหมายเป็น token

การร้องขอ

ตัวอย่างการร้องขอ

curl -X POST 'https://api.${endpoint}/v1/workflow/version/rollback' \ -H 'Authorization: Bearer ${token}' \ -H 'Content-Type: application/json' \ -d '{ "version": "v1", "new_version": "v3", "release": true, "version_desc": "Rollback to stable workflow" }'
                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/rollback' \
  -H 'Authorization: Bearer ${token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "v1",
    "new_version": "v3",
    "release": true,
    "version_desc": "Rollback to stable workflow"
  }'

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

Header สำหรับร้องขอ

ฟิลด์ ประเภท คำอธิบาย
Authorization Bearer ${token} ใช้ API Key ของ Workflow เป้าหมายในการยืนยันตัวตนของการเรียกใช้
Content-Type application/json รูปแบบของเนื้อหาคำขอ

พารามิเตอร์การร้องขอ (Body Parameters)

พารามิเตอร์ ประเภท คำอธิบาย required
version String หมายเลขเวอร์ชันต้นทางที่ต้องการย้อนกลับ true
new_version String หมายเลขเวอร์ชันใหม่ที่บันทึกหลังการย้อนกลับ หากเว้นว่างจะสร้างให้อัตโนมัติ false
release Boolean หลังจากบันทึกการย้อนกลับแล้ว จะเผยแพร่ทันทีหรือไม่ false
version_desc String คำอธิบายเวอร์ชันใหม่ false

การตอบกลับ

เนื้อหาการตอบกลับ

{ "code": 0, "message": "OK", "data": { "source_version": "v1", "new_version": "v3", "created": true, "released": true, "warnings": [] } }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "source_version": "v1",
    "new_version": "v3",
    "created": true,
    "released": true,
    "warnings": []
  }
}

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ฟิลด์ ประเภท คำอธิบาย
source_version String หมายเลขเวอร์ชันต้นทางของการย้อนกลับ
new_version String หมายเลขเวอร์ชันใหม่ที่บันทึกได้
created Boolean มีการสร้างเวอร์ชันใหม่หรือไม่
released Boolean เผยแพร่แล้วหรือไม่
warnings String[] ข้อควรระวังในการย้อนกลับ

การตอบกลับเมื่อผิดพลาด

ฟิลด์ ประเภท คำอธิบาย
code int รหัสข้อผิดพลาด
message string ข้อความแสดงข้อผิดพลาด

รหัสสถานะ

รหัสสถานะ คำอธิบาย
200 สำเร็จ
400 พารามิเตอร์ไม่ถูกต้อง
401 ไม่ได้รับอนุญาต
403 สิทธิ์ไม่เพียงพอ หรือ API Key ยังไม่ได้เปิดสิทธิ์การจัดการเวอร์ชัน
429 คำขอถี่เกินไป
500 ข้อผิดพลาดของเซิร์ฟเวอร์