Skip to content

Commit dba0c0a

Browse files
committed
minor fix to history PATCH documentation
1 parent 9243481 commit dba0c0a

2 files changed

Lines changed: 27 additions & 3 deletions

File tree

api-usage-docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
A subscription connects a data source product, a storage destination, and data source credentials (remote identity). This guide walks you through the full sequence — from looking up your account details to optionally backfilling historical data.
3+
A subscription connects a data source product, data source credentials (remote identity), and a storage destination. This guide walks you through the full sequence — from looking up your account details to optionally backfilling historical data.
44

55
---
66

api-usage-docs/history-api.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,10 @@ GET https://service.api.openbridge.io/service/history/production/history/status/
120120

121121
### Update Transaction Status
122122

123-
Updates the status of a specific transaction. The primary use case is cancellation.
123+
Updates the status of the specified history transaction. The primary use case is cancellation.
124124

125125
```
126-
PATCH https://service.api.openbridge.io/service/history/production/history/status/{transaction_id}
126+
PATCH https://service.api.openbridge.io/service/history/production/history/{transaction_id}
127127
```
128128

129129
**Request body:**
@@ -142,6 +142,30 @@ PATCH https://service.api.openbridge.io/service/history/production/history/statu
142142

143143
---
144144

145+
### Update Transaction Status by Subscription ID
146+
147+
Updates the status of all history transactions associated with the specified subscription. The primary use case is cancellation.
148+
149+
```
150+
PATCH https://service.api.openbridge.io/service/history/production/history/status/{subscription_id}
151+
```
152+
153+
**Request body:**
154+
155+
```json
156+
{
157+
"data": {
158+
"type": "HistoryTransaction",
159+
"id": 999999,
160+
"attributes": {
161+
"status": "cancelled"
162+
}
163+
}
164+
}
165+
```
166+
167+
---
168+
145169
### Get Max Request Metadata
146170

147171
Returns the maximum number of history requests permitted.

0 commit comments

Comments
 (0)