Get a document by ID
get/documents/{entityTypeName}/{documentId}
Retrieves a document by ID. You can use a parameter to specify whether child documents are returned. Both internal and external documents can be read.
1{2 "objectTypeName": "person",3 "objectTypeId": 100515,4 "objectTypeVersion": 4,5 "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",6 "fieldValues": {7 "birthday": "2020-01-05T00:00:00Z",8 "created_at_dttm": "2020-04-13T19:17:47.84Z",9 "created_by_user_id": "viuser",10 "first_name": "John",11 "height_mm": 17628,12 "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",13 "last_name": "Smith",14 "last_updated_at_dttm": "2020-04-13T19:31:37.097Z",15 "last_updated_by_user_id": "viuser",16 "version": 417 },18 "createdAt": "2020-04-13T19:17:47.840Z",19 "lastUpdatedAt": "2020-04-13T19:31:37.097Z",20 "validFrom": "2020-01-05T00:00:00.000Z",21 "fieldRestrictions": {22 "person": {23 "ssn": {24 "masked": {25 "currentUserIsAuthorizedToReveal": true26 }27 }28 }29 },30 "clientFieldProperties": {31 "person": {32 "height_mm": {33 "type": "numberField",34 "disableThousandsSeparator": true35 }36 }37 },38 "sheets": [39 {40 "id": 201,41 "type": "WORKSHEET",42 "name": "Workspace-1",43 "version": 2,44 "created": "2020-04-13T19:27:08.105Z",45 "createdBy": "viuser",46 "lastModified": "2020-04-13T19:27:26.175Z",47 "lastModifiedBy": "viuser",48 "tabOrder": 0,49 "uxState": {50 "commonToolPane": {51 "expanded": true,52 "width": 34053 },54 "filterPanel": {55 "expanded": true,56 "width": 20057 }58 },59 "cells": [60 {61 "type": "LIVE",62 "id": 301,63 "row": 0,64 "position": 0,65 "height": 0,66 "width": 0,67 "version": 1,68 "documents": [69 {70 "type": "person",71 "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",72 "uniqueId": "person#2f21e644-089a-47d8-a503-bbdd4d8dac3d"73 },74 {75 "type": "person",76 "id": "ba0f8afd-b6e0-4763-91a8-9c6810d0156b",77 "uniqueId": "person#ba0f8afd-b6e0-4763-91a8-9c6810d0156b"78 }79 ],80 "visualizationType": "Network",81 "resultsPerPage": 0,82 "networkData": {83 "links": [],84 "nodes": {85 "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d": {86 "id": "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d",87 "transitionStart": {88 "x": 667,89 "y": 206.590 },91 "type": "person",92 "typeLabel": "Person",93 "x": 711.99394815911,94 "y": 220.23423274212295 },96 "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b": {97 "id": "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b",98 "transitionStart": {99 "x": 339.81315560960843,100 "y": 106.62745147130762101 },102 "type": "person",103 "typeLabel": "Person",104 "x": 621.6305200034983,105 "y": 192.65113758282533106 }107 },108 "numNodes": 2,109 "options": {110 "activeNodes": false,111 "centralityType": null,112 "displayableTransactionType": null,113 "groupCtr": 1,114 "layout": {115 "charge": 25,116 "linkDistance": 130,117 "linkStrength": 0.4,118 "velocityDecay": 0.45119 },120 "nodeCtr": 1,121 "scale": 2.0766116941529233,122 "showLegend": true,123 "showLinkLabels": false,124 "showNodeAnnotation": true,125 "showNodeLabels": true,126 "showTimeline": false,127 "showTransactionDetails": false,128 "showTransactionLinks": false,129 "toolsPane": {130 "activeTool": "Object Inspector",131 "open": true132 },133 "transactionTypeIndex": 0,134 "translate": [135 -872.0999999999999,136 -222.32031484257868137 ]138 }139 }140 }141 ]142 }143 ],144 "comments": [145 {146 "id": 1,147 "author": {148 "id": "viuser",149 "name": "Test viuser"150 },151 "createDate": "2020-04-13T19:18:05.087Z",152 "lastUpdatedAt": "2020-04-13T19:18:05.087Z",153 "lastUpdatedBy": "viuser",154 "detail": "Sample comment<br />"155 }156 ],157 "attachmentsCount": 2158}
| Name | Type | Required | Description |
|---|---|---|---|
documentId | string | true | The ID for the document. |
entityTypeName | string | true | The name of the entity type to which the document belongs. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The request succeeded. | Schema | |
| 400 | Bad Request | The request was invalid. | Schema | |
| 404 | Not Found | The document was not found. | Schema |