Get a sheet

get/documents/{objectTypeName}/{objectId}/sheets/{sheetId}
Internal-Use Only

Gets a sheet with the given ID from the object that is specified in the path. To modify a sheet, update the sheets property on the object using a separate endpoint.

Request Samples

1

Response Samples

1{
2  "id": 201,
3  "type": "WORKSHEET",
4  "name": "Workspace-1",
5  "version": 2,
6  "created": "2020-04-13T19:27:08.105Z",
7  "createdBy": "viuser",
8  "lastModified": "2020-04-13T19:27:26.175Z",
9  "lastModifiedBy": "viuser",
10  "tabOrder": 0,
11  "uxState": {
12    "commonToolPane": {
13      "expanded": true,
14      "width": 340
15    },
16    "filterPanel": {
17      "expanded": true,
18      "width": 200
19    }
20  },
21  "cells": [
22    {
23      "type": "LIVE",
24      "id": 301,
25      "row": 0,
26      "position": 0,
27      "height": 0,
28      "width": 0,
29      "version": 1,
30      "documents": [
31        {
32          "type": "person",
33          "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",
34          "uniqueId": "person#2f21e644-089a-47d8-a503-bbdd4d8dac3d"
35        },
36        {
37          "type": "person",
38          "id": "ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
39          "uniqueId": "person#ba0f8afd-b6e0-4763-91a8-9c6810d0156b"
40        }
41      ],
42      "visualizationType": "Network",
43      "resultsPerPage": 0,
44      "networkData": {
45        "links": [],
46        "nodes": {
47          "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d": {
48            "id": "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d",
49            "transitionStart": {
50              "x": 667,
51              "y": 206.5
52            },
53            "type": "person",
54            "typeLabel": "Person",
55            "x": 711.99394815911,
56            "y": 220.234232742122
57          },
58          "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b": {
59            "id": "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
60            "transitionStart": {
61              "x": 339.81315560960843,
62              "y": 106.62745147130762
63            },
64            "type": "person",
65            "typeLabel": "Person",
66            "x": 621.6305200034983,
67            "y": 192.65113758282533
68          }
69        },
70        "numNodes": 2,
71        "options": {
72          "activeNodes": false,
73          "centralityType": null,
74          "displayableTransactionType": null,
75          "groupCtr": 1,
76          "layout": {
77            "charge": 25,
78            "linkDistance": 130,
79            "linkStrength": 0.4,
80            "velocityDecay": 0.45
81          },
82          "nodeCtr": 1,
83          "scale": 2.0766116941529233,
84          "showLegend": true,
85          "showLinkLabels": false,
86          "showNodeAnnotation": true,
87          "showNodeLabels": true,
88          "showTimeline": false,
89          "showTransactionDetails": false,
90          "showTransactionLinks": false,
91          "toolsPane": {
92            "activeTool": "Object Inspector",
93            "open": true
94          },
95          "transactionTypeIndex": 0,
96          "translate": [
97            -872.0999999999999,
98            -222.32031484257868
99          ]
100        }
101      }
102    }
103  ]
104}

Path Parameters

NameTypeRequiredDescription
objectId
string
true

The ID of the object.

objectTypeName
string
true

The name of the object type.

sheetId
string
true

The ID of the sheet.

Responses

StatusMeaningDescription
200OKThe request succeeded. The sheet with the specified ID was returned.Schema
400Bad RequestThe request failed. The parameters cannot be null or empty.Schema
404Not FoundThe request failed. The object or sheet was not found or the user did not have permission to view the object.Schema