4
0

start_action_methods.adoc 1.6 KB

123456789101112131415161718192021222324252627282930
  1. There are 4 main methods to start an action in OliveTin, which can be used in scripts or other applications. These methods allow you to trigger actions either immediately or wait for them to complete, and they can be accessed via HTTP requests.
  2. .Webhook/API reference table
  3. [%header]
  4. |======================================================
  5. | Function | HTTP Method | Request Type (How to select an action) | Response Type
  6. | xref:api/method_StartAction.adoc[StartAction]
  7. | POST
  8. | xref:api/start_action.adoc#api-request-obj[OliveTin request object]
  9. | xref:api/start_action.adoc#api-response-trackingid[Execution Tracking ID]
  10. | xref:api/method_StartActionByGet.adoc[StartActionByGet]
  11. | GET
  12. | xref:api/start_action.adoc#api-request-idurl[Action ID in the URL]
  13. | xref:api/start_action.adoc#api-response-trackingid[Execution Tracking ID]
  14. | xref:api/method_StartActionAndWait.adoc[StartActionAndWait]
  15. | POST
  16. | xref:api/start_action.adoc#api-request-obj[OliveTin request object]
  17. | xref:api/start_action.adoc#api-response-logentry[Log Entry (waits for the action to finish)]
  18. | xref:api/method_StartActionByGetAndWait.adoc[StartActionByGetAndWait]
  19. | GET
  20. | xref:api/start_action.adoc#api-request-idurl[Action ID in the URL]
  21. | xref:api/start_action.adoc#api-response-logentry[Log Entry (waits for the action to finish)]
  22. |======================================================
  23. You can also browse these methods in the link:htts://docs.olivetin.app/api/swagger/[OpenAPI/Swagger] docs if you prefer.