Appearance
docusign.workspace-items.get-workspace-file-pages ​
This method returns a workspace file as rasterized pages.
List File Pages
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-docusign |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Docusign API root, e.g. https://<host>/api |
api_token | string | No | — | Bearer token; omit to use the workflow's token env var |
accountid | string | Yes | — | The external account number (int) or account ID GUID. |
fileid | string | Yes | — | The ID of the file. |
folderid | string | Yes | — | The ID of the folder. |
workspaceid | string | Yes | — | The ID of the workspace. |
count | string | No | — | The maximum number of results to return. Use start_position to specify the number of results to skip. |
dpi | string | No | — | The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
max_height | string | No | — | Sets the maximum height of the returned images in pixels. |
max_width | string | No | — | Sets the maximum width of the returned images in pixels. |
start_position | string | No | — | The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Docusign API root, e.g. https://<host>/api |
api_token | string | No | — | Bearer token; omit to use the workflow's token env var |
accountid | string | Yes | — | The external account number (int) or account ID GUID. |
fileid | string | Yes | — | The ID of the file. |
folderid | string | Yes | — | The ID of the folder. |
workspaceid | string | Yes | — | The ID of the workspace. |
count | string | No | — | The maximum number of results to return. Use start_position to specify the number of results to skip. |
dpi | string | No | — | The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
max_height | string | No | — | Sets the maximum height of the returned images in pixels. |
max_width | string | No | — | Sets the maximum width of the returned images in pixels. |
start_position | string | No | — | The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0. |
status_code | integer | No | — | HTTP status code of the completed call |
response | json | No | — | Parsed JSON response body |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_at | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | Waiting to call GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages |
completed | No | Yes | Yes | — | HTTP call succeeded |
failed | No | Yes | No | — | HTTP call failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | Perform GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages |
* (any state) | fail | failed | Record the failure reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "docusign.workspace-items.get-workspace-file-pages",
"initial_data": {
"base_url": "value",
"accountid": "value",
"fileid": "value",
"folderid": "value"
}
}