[GET] Get Export Data

Use this request to get the exported data of a specific Task, including its general information and auditing details.

Get Export Data

GET/api/v1.0/external/sdtask/GetExportData/{taskid}

Path Parameters

Name

Type

Description

taskid

integer

The ID that identifies the task to retrieve data on. This ID is always unique and never changes after it has been created.

externalId

string (optional)

An optional External ID, valid for your organization and added to the Task at creation, that uniquely identifies it in your Organization.

At least one of taskId or externalId must be specified.

What is an "External ID"?

While you integrate with our API, you may wish to keep track of your Tasks using an already existing identifier which is meaningful for your system and your business.

This is the purpose of the External ID - you can populate it with any string of text, as long as it is unique in your organization.

Example Request

curl --location 'https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/GetExportData/{taskId}' 
--header 'Authorization: Bearer {your access token here}'

var client = new HttpClient();

var accessToken = "your access token here";
var request = new HttpRequestMessage(HttpMethod.Get, "https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/GetExportData/{taskId}");

request.Headers.Add("Authorization", $"Bearer {accessToken}");

var response = await client.SendAsync(request);

response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

import requests

url = "https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/GetExportData/{taskId}"
access_token = "your access token here"

payload = {}
headers = {
'Authorization': f'Bearer {access_token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

const myHeaders = new Headers();
const accessToken = "your access token here";
myHeaders.append("Authorization", `Bearer ${accessToken}`);

const requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};

fetch("https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/GetExportData/{taskId}", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Responses

{
  "taskId": 0,
  "originalFileUrl": "string",
  "workspaceId": 0,
  "batchId": 0,
  "taskNumber": 0,
  "externalId": "string",
  "displayName": "string",
  "description": "string",
  "totalPages": 0,
  "lastCheckoutByUserName": "string",
  "lastCheckedOutBy": 0,
  "lastCheckedOutUntil": "2025-12-31T09:57:08.824Z",
  "chunks": [
    {
      "entities": [
        {
          "type": "string",
          "category": "string",
          "groupName": "string",
          "pageNumber": 0,
          "chunkNumber": 0,
          "customFormValues": "string",
          "qrCode": {
            "boundingBox": {
              "height": 0,
              "width": 0,
              "left": 0,
              "bottom": 0,
              "x": 0,
              "y": 0,
              "right": 0,
              "top": 0
            },
            "points": [
              {
                "x": 0,
                "y": 0
              }
            ],
            "confidence": 0,
            "spans": [
              {
                "offset": 0,
                "length": 0
              }
            ],
            "keyValues": [
              {
                "boundingBox": {
                  "height": 0,
                  "width": 0,
                  "left": 0,
                  "bottom": 0,
                  "x": 0,
                  "y": 0,
                  "right": 0,
                  "top": 0
                },
                "points": [
                  {
                    "x": 0,
                    "y": 0
                  }
                ],
                "confidence": 0,
                "spans": [
                  {
                    "offset": 0,
                    "length": 0
                  }
                ],
                "pageNumber": 0,
                "category": "string",
                "categoryNormalized": "string",
                "content": "string",
                "contentNormalized": "string",
                "childTemporaryId": "string"
              }
            ],
            "qrCodeContent": "string",
            "invalidKeysCount": 0,
            "duplicatedKeys": [
              "string"
            ]
          },
          "table": {
            "boundingBox": {
              "height": 0,
              "width": 0,
              "left": 0,
              "bottom": 0,
              "x": 0,
              "y": 0,
              "right": 0,
              "top": 0
            },
            "points": [
              {
                "x": 0,
                "y": 0
              }
            ],
            "confidence": 0,
            "spans": [
              {
                "offset": 0,
                "length": 0
              }
            ],
            "rowCount": 0,
            "columnCount": 0,
            "tableHeaders": [
              {
                "boundingBox": {
                  "height": 0,
                  "width": 0,
                  "left": 0,
                  "bottom": 0,
                  "x": 0,
                  "y": 0,
                  "right": 0,
                  "top": 0
                },
                "points": [
                  {
                    "x": 0,
                    "y": 0
                  }
                ],
                "confidence": 0,
                "spans": [
                  {
                    "offset": 0,
                    "length": 0
                  }
                ],
                "rowIndex": 0,
                "columnIndex": 0,
                "content": "string",
                "contentNormalized": "string",
                "pageNumber": 0,
                "category": "string",
                "categoryNormalized": "string"
              }
            ],
            "tableRows": {
              "additionalProp1": [
                {
                  "boundingBox": {
                    "height": 0,
                    "width": 0,
                    "left": 0,
                    "bottom": 0,
                    "x": 0,
                    "y": 0,
                    "right": 0,
                    "top": 0
                  },
                  "points": [
                    {
                      "x": 0,
                      "y": 0
                    }
                  ],
                  "confidence": 0,
                  "spans": [
                    {
                      "offset": 0,
                      "length": 0
                    }
                  ],
                  "rowIndex": 0,
                  "columnIndex": 0,
                  "content": "string",
                  "contentNormalized": "string",
                  "pageNumber": 0
                }
              ],
              "additionalProp2": [
                {
                  "boundingBox": {
                    "height": 0,
                    "width": 0,
                    "left": 0,
                    "bottom": 0,
                    "x": 0,
                    "y": 0,
                    "right": 0,
                    "top": 0
                  },
                  "points": [
                    {
                      "x": 0,
                      "y": 0
                    }
                  ],
                  "confidence": 0,
                  "spans": [
                    {
                      "offset": 0,
                      "length": 0
                    }
                  ],
                  "rowIndex": 0,
                  "columnIndex": 0,
                  "content": "string",
                  "contentNormalized": "string",
                  "pageNumber": 0
                }
              ],
              "additionalProp3": [
                {
                  "boundingBox": {
                    "height": 0,
                    "width": 0,
                    "left": 0,
                    "bottom": 0,
                    "x": 0,
                    "y": 0,
                    "right": 0,
                    "top": 0
                  },
                  "points": [
                    {
                      "x": 0,
                      "y": 0
                    }
                  ],
                  "confidence": 0,
                  "spans": [
                    {
                      "offset": 0,
                      "length": 0
                    }
                  ],
                  "rowIndex": 0,
                  "columnIndex": 0,
                  "content": "string",
                  "contentNormalized": "string",
                  "pageNumber": 0
                }
              ]
            },
            "boundsAndPoints": [
              {
                "pageNumber": 0,
                "boundingBox": {
                  "height": 0,
                  "width": 0,
                  "left": 0,
                  "bottom": 0,
                  "x": 0,
                  "y": 0,
                  "right": 0,
                  "top": 0
                },
                "points": [
                  {
                    "x": 0,
                    "y": 0
                  }
                ]
              }
            ],
            "tableRowsTableContent": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "hasAlternativeHeaders": true
          },
          "templateBuilderField": {
            "boundingBox": {
              "height": 0,
              "width": 0,
              "left": 0,
              "bottom": 0,
              "x": 0,
              "y": 0,
              "right": 0,
              "top": 0
            },
            "points": [
              {
                "x": 0,
                "y": 0
              }
            ],
            "confidence": 0,
            "spans": [
              {
                "offset": 0,
                "length": 0
              }
            ],
            "fieldUniqueId": "string",
            "type": "string",
            "keyValues": [
              {
                "boundingBox": {
                  "height": 0,
                  "width": 0,
                  "left": 0,
                  "bottom": 0,
                  "x": 0,
                  "y": 0,
                  "right": 0,
                  "top": 0
                },
                "points": [
                  {
                    "x": 0,
                    "y": 0
                  }
                ],
                "confidence": 0,
                "spans": [
                  {
                    "offset": 0,
                    "length": 0
                  }
                ],
                "pageNumber": 0,
                "category": "string",
                "categoryNormalized": "string",
                "content": "string",
                "contentNormalized": "string",
                "childTemporaryId": "string"
              }
            ],
            "table": {
              "rowCount": 0,
              "columnCount": 0,
              "tableHeaders": [
                {
                  "boundingBox": {
                    "height": 0,
                    "width": 0,
                    "left": 0,
                    "bottom": 0,
                    "x": 0,
                    "y": 0,
                    "right": 0,
                    "top": 0
                  },
                  "points": [
                    {
                      "x": 0,
                      "y": 0
                    }
                  ],
                  "confidence": 0,
                  "spans": [
                    {
                      "offset": 0,
                      "length": 0
                    }
                  ],
                  "rowIndex": 0,
                  "columnIndex": 0,
                  "content": "string",
                  "contentNormalized": "string",
                  "pageNumber": 0,
                  "category": "string",
                  "categoryNormalized": "string",
                  "uniqueId": "string",
                  "fieldType": 50,
                  "isRequired": true
                }
              ],
              "tableRows": {
                "additionalProp1": [
                  {
                    "boundingBox": {
                      "height": 0,
                      "width": 0,
                      "left": 0,
                      "bottom": 0,
                      "x": 0,
                      "y": 0,
                      "right": 0,
                      "top": 0
                    },
                    "points": [
                      {
                        "x": 0,
                        "y": 0
                      }
                    ],
                    "confidence": 0,
                    "spans": [
                      {
                        "offset": 0,
                        "length": 0
                      }
                    ],
                    "rowIndex": 0,
                    "columnIndex": 0,
                    "content": "string",
                    "contentNormalized": "string",
                    "pageNumber": 0,
                    "uniqueId": "string",
                    "headerId": "string"
                  }
                ],
                "additionalProp2": [
                  {
                    "boundingBox": {
                      "height": 0,
                      "width": 0,
                      "left": 0,
                      "bottom": 0,
                      "x": 0,
                      "y": 0,
                      "right": 0,
                      "top": 0
                    },
                    "points": [
                      {
                        "x": 0,
                        "y": 0
                      }
                    ],
                    "confidence": 0,
                    "spans": [
                      {
                        "offset": 0,
                        "length": 0
                      }
                    ],
                    "rowIndex": 0,
                    "columnIndex": 0,
                    "content": "string",
                    "contentNormalized": "string",
                    "pageNumber": 0,
                    "uniqueId": "string",
                    "headerId": "string"
                  }
                ],
                "additionalProp3": [
                  {
                    "boundingBox": {
                      "height": 0,
                      "width": 0,
                      "left": 0,
                      "bottom": 0,
                      "x": 0,
                      "y": 0,
                      "right": 0,
                      "top": 0
                    },
                    "points": [
                      {
                        "x": 0,
                        "y": 0
                      }
                    ],
                    "confidence": 0,
                    "spans": [
                      {
                        "offset": 0,
                        "length": 0
                      }
                    ],
                    "rowIndex": 0,
                    "columnIndex": 0,
                    "content": "string",
                    "contentNormalized": "string",
                    "pageNumber": 0,
                    "uniqueId": "string",
                    "headerId": "string"
                  }
                ]
              }
            }
          },
          "keyValues": [
            {
              "boundingBox": {
                "height": 0,
                "width": 0,
                "left": 0,
                "bottom": 0,
                "x": 0,
                "y": 0,
                "right": 0,
                "top": 0
              },
              "points": [
                {
                  "x": 0,
                  "y": 0
                }
              ],
              "confidence": 0,
              "spans": [
                {
                  "offset": 0,
                  "length": 0
                }
              ],
              "pageNumber": 0,
              "category": "string",
              "categoryNormalized": "string",
              "content": "string",
              "contentNormalized": "string"
            }
          ],
          "addedOn": "2025-12-31T09:57:08.824Z",
          "addedBy": 0,
          "addedByExternal": "string",
          "editedOn": "2025-12-31T09:57:08.824Z",
          "viewerEditedOn": "2025-12-31T09:57:08.824Z",
          "editedBy": 0,
          "editedByExternal": "string",
          "integratedOn": "2025-12-31T09:57:08.824Z",
          "integratedBy": 0,
          "integratedByExternal": "string",
          "integrationFailedReason": "string",
          "integrationFailedReasonDetailed": "string",
          "markedAsSolved": true,
          "notDetected": true,
          "contentUnderstandingDetected": true,
          "confidence": 0
        }
      ],
      "version": "string",
      "retrievedOn": "2025-12-31T09:57:08.824Z",
      "lastModifiedBy": 0,
      "lastModifiedByExternal": "string",
      "lastModifiedOn": "2025-12-31T09:57:08.824Z",
      "averageConfidence": 0
    }
  ],
  "lastIntegratedBy": 0,
  "lastIntegratedByUserName": "string",
  "lastIntegratedOn": "2025-12-31T09:57:08.824Z",
  "averageConfidence": 0,
  "metadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Previous[GET] Task Status List Paginated Next[GET] Get Export Data Simplified

Last updated 1 month ago

hashtagGet Export Data

hashtagPath Parameters

hashtagExample Request

hashtagResponses

Get Export Data

Path Parameters

Example Request

Responses