You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/html/classcom_1_1adobe_1_1sign_1_1api_1_1_groups_api.html
+12Lines changed: 12 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
144
144
<dlclass="params"><dt>Parameters</dt><dd>
145
145
<tableclass="params">
146
146
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
147
+
<br/>
147
148
Access-Token(key) An OAuth Access Token with scopes: user_write
149
+
<br/>
148
150
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
@@ -181,7 +183,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
181
183
<dlclass="params"><dt>Parameters</dt><dd>
182
184
<tableclass="params">
183
185
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
186
+
<br/>
184
187
Access-Token(key) An OAuth Access Token with scopes: user_write
188
+
<br/>
185
189
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
186
190
<tr><tdclass="paramname">groupId</td><td>The group identifier, as returned by the group creation API or retrieved from the API to fetch groups </td></tr>
187
191
</table>
@@ -218,7 +222,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
218
222
<dlclass="params"><dt>Parameters</dt><dd>
219
223
<tableclass="params">
220
224
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
225
+
<br/>
221
226
Access-Token(key) An OAuth Access Token with scopes: user_read
227
+
<br/>
222
228
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
223
229
<tr><tdclass="paramname">groupId</td><td>The group identifier, as returned by the group creation API or retrieved from the API to fetch groups </td></tr>
224
230
</table>
@@ -245,7 +251,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
245
251
<dlclass="params"><dt>Parameters</dt><dd>
246
252
<tableclass="params">
247
253
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
254
+
<br/>
248
255
Access-Token(key) An OAuth Access Token with scopes: user_read
256
+
<br/>
249
257
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
250
258
</table>
251
259
</dd>
@@ -281,7 +289,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
281
289
<dlclass="params"><dt>Parameters</dt><dd>
282
290
<tableclass="params">
283
291
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
292
+
<br/>
284
293
Access-Token(key) An OAuth Access Token with scopes: user_read
294
+
<br/>
285
295
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
286
296
<tr><tdclass="paramname">groupId</td><td>The group identifier, as returned by the group creation API or retrieved from the API to fetch groups </td></tr>
287
297
</table>
@@ -324,7 +334,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
324
334
<dlclass="params"><dt>Parameters</dt><dd>
325
335
<tableclass="params">
326
336
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
337
+
<br/>
327
338
Access-Token(key) An OAuth Access Token with scopes: user_write
339
+
<br/>
328
340
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
329
341
<tr><tdclass="paramname">groupId</td><td>The group identifier, as returned by the group creation API or retrieved from the API to fetch groups </td></tr>
Copy file name to clipboardExpand all lines: docs/html/classcom_1_1adobe_1_1sign_1_1api_1_1_library_documents_api.html
+16Lines changed: 16 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
148
148
<dlclass="params"><dt>Parameters</dt><dd>
149
149
<tableclass="params">
150
150
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
151
+
<br/>
151
152
Access-Token(key) An OAuth Access Token with scopes: library_write user_login - Required additionally if the autoLoginUser parameter is set to true
153
+
<br/>
152
154
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
153
155
<tr><tdclass="paramname">libraryCreationInfo</td><td>Information about the library document that you want to create and authoring options that you want to apply at the time of creation. </td></tr>
154
156
</table>
@@ -184,7 +186,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
184
186
<p>Deletes a library document. Library document will no longer be visible in the Manage Page of the user. This API will delete the library document. However, the agreements created using this library document will not be impacted. </p><dlclass="params"><dt>Parameters</dt><dd>
185
187
<tableclass="params">
186
188
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
189
+
<br/>
187
190
Access-Token(key) An OAuth Access Token with scopes: library_retention
191
+
<br/>
188
192
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
189
193
<tr><tdclass="paramname">libraryDocumentId</td><td>The document identifier, as retrieved from the API to fetch library documents. </td></tr>
190
194
</table>
@@ -226,7 +230,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
226
230
<p>Retrieves the combined document associated with a library document. File Stream of PDF file </p><dlclass="params"><dt>Parameters</dt><dd>
227
231
<tableclass="params">
228
232
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
233
+
<br/>
229
234
Access-Token(key) An OAuth Access Token with scopes: library_read
235
+
<br/>
230
236
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
231
237
<tr><tdclass="paramname">libraryDocumentId</td><td>The document identifier, as retrieved from the API to fetch library documents. </td></tr>
232
238
<tr><tdclass="paramname">auditReport</td><td>When set to YES attach an audit report to the library document PDF. Default value will be false. </td></tr>
@@ -264,7 +270,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
264
270
<dlclass="params"><dt>Parameters</dt><dd>
265
271
<tableclass="params">
266
272
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
273
+
<br/>
267
274
Access-Token(key) An OAuth Access Token with scopes: library_read
275
+
<br/>
268
276
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
269
277
<tr><tdclass="paramname">libraryDocumentId</td><td>The document identifier, as retrieved from the API to fetch library documents. </td></tr>
270
278
</table>
@@ -306,7 +314,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
306
314
<p>Retrieves the file stream of a library document. Raw stream of the file </p><dlclass="params"><dt>Parameters</dt><dd>
307
315
<tableclass="params">
308
316
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
317
+
<br/>
309
318
Access-Token(key) An OAuth Access Token with scopes: library_read
319
+
<br/>
310
320
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
311
321
<tr><tdclass="paramname">libraryDocumentId</td><td>The document identifier, as retrieved from the API to fetch library documents. </td></tr>
312
322
<tr><tdclass="paramname">documentId</td><td>The document identifier, as retrieved from the API which fetches the documents of a specified library document </td></tr>
@@ -343,7 +353,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
343
353
<p>Retrieves the audit trail associated with a library document. File Stream of PDF file </p><dlclass="params"><dt>Parameters</dt><dd>
344
354
<tableclass="params">
345
355
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
356
+
<br/>
346
357
Access-Token(key) An OAuth Access Token with scopes: library_read
358
+
<br/>
347
359
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
348
360
<tr><tdclass="paramname">libraryDocumentId</td><td>The document identifier, as retrieved from the API to fetch library documents. </td></tr>
349
361
</table>
@@ -380,7 +392,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
380
392
<dlclass="params"><dt>Parameters</dt><dd>
381
393
<tableclass="params">
382
394
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
395
+
<br/>
383
396
Access-Token(key) An OAuth Access Token with scopes: library_read
397
+
<br/>
384
398
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
385
399
<tr><tdclass="paramname">libraryDocumentId</td><td>The document identifier, as retrieved from the API to fetch library documents. </td></tr>
386
400
</table>
@@ -407,7 +421,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
407
421
<dlclass="params"><dt>Parameters</dt><dd>
408
422
<tableclass="params">
409
423
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
424
+
<br/>
410
425
Access-Token(key) An OAuth Access Token with scopes: library_read
426
+
<br/>
411
427
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
Copy file name to clipboardExpand all lines: docs/html/classcom_1_1adobe_1_1sign_1_1api_1_1_mega_signs_api.html
+13Lines changed: 13 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
144
144
<dlclass="params"><dt>Parameters</dt><dd>
145
145
<tableclass="params">
146
146
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
147
+
<br/>
147
148
Access-Token(key) An OAuth Access Token with scopes: agreement_send
149
+
<br/>
148
150
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
149
151
<tr><tdclass="paramname">megaSignCreationRequest</td><td>Information about the MegaSign that you want to send. </td></tr>
150
152
</table>
@@ -181,7 +183,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
181
183
<dlclass="params"><dt>Parameters</dt><dd>
182
184
<tableclass="params">
183
185
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
186
+
<br/>
184
187
Access-Token(key) An OAuth Access Token with scopes: agreement_read
188
+
<br/>
185
189
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
186
190
<tr><tdclass="paramname">megaSignId</td><td>The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements </td></tr>
187
191
</table>
@@ -217,8 +221,11 @@ <h2 class="groupheader">Member Function Documentation</h2>
217
221
<p>Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement CSV file stream containing form data information </p><dlclass="params"><dt>Parameters</dt><dd>
218
222
<tableclass="params">
219
223
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
224
+
<br/>
220
225
Access-Token(key) An OAuth Access Token with scopes: agreement_read
226
+
<br/>
221
227
accept(key) Specify media types which are acceptable for the response. Currently only text/csv is supported.
228
+
<br/>
222
229
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
223
230
<tr><tdclass="paramname">megaSignId</td><td>The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements </td></tr>
224
231
</table>
@@ -255,7 +262,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
255
262
<dlclass="params"><dt>Parameters</dt><dd>
256
263
<tableclass="params">
257
264
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
265
+
<br/>
258
266
Access-Token(key) An OAuth Access Token with scopes: agreement_read
267
+
<br/>
259
268
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
260
269
<tr><tdclass="paramname">megaSignId</td><td>The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements </td></tr>
261
270
</table>
@@ -292,7 +301,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
292
301
<dlclass="params"><dt>Parameters</dt><dd>
293
302
<tableclass="params">
294
303
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
304
+
<br/>
295
305
Access-Token(key) An OAuth Access Token with scopes: agreement_read
306
+
<br/>
296
307
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
297
308
<tr><tdclass="paramname">query</td><td>The query string used for the search. Multiple search terms can be provided, separated by spaces. Some of the search terms include document name, participant name or company, and form data </td></tr>
298
309
</table>
@@ -335,7 +346,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
335
346
<dlclass="params"><dt>Parameters</dt><dd>
336
347
<tableclass="params">
337
348
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
349
+
<br/>
338
350
Access-Token(key) An OAuth Access Token with scopes: agreement_write
351
+
<br/>
339
352
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
340
353
<tr><tdclass="paramname">megaSignId</td><td>The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements </td></tr>
341
354
<tr><tdclass="paramname">megaSignStatusUpdateInfo</td><td>MegaSign status update information object. </td></tr>
Copy file name to clipboardExpand all lines: docs/html/classcom_1_1adobe_1_1sign_1_1api_1_1_reminders_api.html
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -133,7 +133,9 @@ <h2 class="groupheader">Member Function Documentation</h2>
133
133
<p>Sends a reminder for an agreement. Sends a reminder for an agreement. </p><dlclass="params"><dt>Parameters</dt><dd>
134
134
<tableclass="params">
135
135
<tr><tdclass="paramname">headers</td><td>Multivalued map containing key value pair for below parameters and custom parameters. <pre>
136
+
<br/>
136
137
Access-Token(key) An OAuth Access Token with scopes: agreement_write
138
+
<br/>
137
139
x-api-user(key) The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. </pre></td></tr>
0 commit comments