Inicio Explorar Axuda
Iniciar sesión
LBP
/
OliveTin
réplica de https://github.com/OliveTin/OliveTin.git
4
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: 2ecedfbd22
Ramas Etiquetas
OliveTin
/
docs
/
modules
/
ROOT
/
partials
/
api
/
start_action_methods.adoc

start_action_methods.adoc 1.9 KB
Histórico Raw

123456789101112131415161718192021222324 
  1. There are 2 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. Like every OliveTin API method, they are called with an HTTP `POST` and a JSON request body (eg: `curl --json '{...}'`).
    2. 

  2. 

  3. .Webhook/API reference table
    4. 

  4. [%header]
    5. 

  5. |======================================================
    6. 

  6. | Function                     | HTTP Method | Request Type (How to select an action)             | Response Type
    7. 

  7. 

  8. | xref:api/method_StartAction.adoc[StartAction]
    9. 

  9. | POST
    10. 

  10. | xref:api/start_action.adoc#api-request-startaction[`bindingId`, arguments, tracking ID, justification]
    11. 

  11. | xref:api/start_action.adoc#api-response-trackingid[Execution Tracking ID]
    12. 

  12. 

  13. | xref:api/method_StartActionAndWait.adoc[StartActionAndWait]
    14. 

  14. | POST
    15. 

  15. | xref:api/start_action.adoc#api-request-startactionandwait[`actionId`, arguments, justification]
    16. 

  16. | xref:api/start_action.adoc#api-response-logentry[Log Entry (waits for the action to finish)]
    17. 

  17. 

  18. |======================================================
    19. 

  19. 

  20. NOTE: `StartActionAndWait` checks that the caller is allowed to view the action's logs *after* the action has finished. A caller that can start an action but cannot view its logs receives a permission error, even though the action has already run - so retrying on that error can run the action again. Use `StartAction` when you do not need the log entry.
    21. 

  21. 

  22. WARNING: `StartActionByGet` and `StartActionByGetAndWait` are xref:api/start_action.adoc#api-deprecated-byget[deprecated] and will be removed in a future version. Use `StartAction` or `StartActionAndWait` instead.
    23. 

  23. 

  24. You can also browse these methods in the link:https://docs.olivetin.app/api/swagger/3k/[OpenAPI/Swagger] docs if you prefer. The link:https://github.com/OliveTin/OliveTin/blob/main/proto/olivetin/api/v1/olivetin.proto[Protobuf definition] is the source of truth for all request and response fields.
    25.