Skip to content

Commit

Permalink
Link to response types
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesread committed Feb 27, 2024
1 parent 3d18d53 commit fff8f86
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 2 additions & 0 deletions api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,15 @@ If you need more control over the execution, then the only other option is to su

More detailed examples can be seen below.

[#api-response-trackingid]
==== Response type: Execution Tracking ID

Used by:

* `StartAction`
* `StartActionByGet`

[#api-response-logentry]
==== Response type: LogEntry

Used by:
Expand Down
10 changes: 5 additions & 5 deletions api_start_action_overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ There are several variants of this API call available which might be easier for
.Webhook/API reference table
[%header]
|======================================================
| Function | HTTP Method | Request Type (How to select an action) | Return Type
| `StartAction` | POST | <<api-request-obj,OliveTin request object>> | Execution Tracking ID
| `StartActionByGet` | GET | <<api-request-idurl,Action ID in the URL>> | Execution Tracking ID
| `StartActionAndWait` | POST | <<api-request-obj,OliveTin request object>> | Log Entry (waits for the action to finish)
| `StartActionByGetAndWait` | GET | <<api-request-idurl,Action ID in the URL>> | Log Entry (waits for the action to finish)
| Function | HTTP Method | Request Type (How to select an action) | Response Type
| `StartAction` | POST | <<api-request-obj,OliveTin request object>> | <<api-response-trackingid,Execution Tracking ID>>
| `StartActionByGet` | GET | <<api-request-idurl,Action ID in the URL>> | <<api-response-trackingid,Execution Tracking ID>>
| `StartActionAndWait` | POST | <<api-request-obj,OliveTin request object>> | <<api-response-logentry,Log Entry (waits for the action to finish)>>
| `StartActionByGetAndWait` | GET | <<api-request-idurl,Action ID in the URL>> | <<api-response-logentry,Log Entry (waits for the action to finish)>>
|======================================================

0 comments on commit fff8f86

Please sign in to comment.