Get a list of sheets by object type and object ID

get/documents/{objectTypeName}/{objectId}/sheets

Internal-Use Only

Gets a list of the sheets that are associated with the object specified in the path. To modify a sheet, update the sheets property on the object using a separate endpoint.

Request Samples

Response Samples

200
application/json
1[
2  {
3    "id": 201,
4    "type": "WORKSHEET",
5    "name": "Workspace-1",
6    "version": 2,
7    "created": "2020-04-13T19:27:08.105Z",
8    "createdBy": "viuser",
9    "lastModified": "2020-04-13T19:27:26.175Z",
10    "lastModifiedBy": "viuser",
11    "tabOrder": 0,
12    "uxState": {
13      "commonToolPane": {
14        "expanded": true,
15        "width": 340
16      },
17      "filterPanel": {
18        "expanded": true,
19        "width": 200
20      }
21    },
22    "cells": [
23      {
24        "type": "LIVE",
25        "id": 301,
26        "row": 0,
27        "position": 0,
28        "height": 0,
29        "width": 0,
30        "version": 1,
31        "documents": [
32          {
33            "type": "person",
34            "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",
35            "uniqueId": "person#2f21e644-089a-47d8-a503-bbdd4d8dac3d"
36          },
37          {
38            "type": "person",
39            "id": "ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
40            "uniqueId": "person#ba0f8afd-b6e0-4763-91a8-9c6810d0156b"
41          }
42        ],
43        "visualizationType": "Network",
44        "resultsPerPage": 0,
45        "networkData": {
46          "links": [],
47          "nodes": {
48            "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d": {
49              "id": "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d",
50              "transitionStart": {
51                "x": 667,
52                "y": 206.5
53              },
54              "type": "person",
55              "typeLabel": "Person",
56              "x": 711.99394815911,
57              "y": 220.234232742122
58            },
59            "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b": {
60              "id": "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
61              "transitionStart": {
62                "x": 339.81315560960843,
63                "y": 106.62745147130762
64              },
65              "type": "person",
66              "typeLabel": "Person",
67              "x": 621.6305200034983,
68              "y": 192.65113758282533
69            }
70          },
71          "numNodes": 2,
72          "options": {
73            "activeNodes": false,
74            "centralityType": null,
75            "displayableTransactionType": null,
76            "groupCtr": 1,
77            "layout": {
78              "charge": 25,
79              "linkDistance": 130,
80              "linkStrength": 0.4,
81              "velocityDecay": 0.45
82            },
83            "nodeCtr": 1,
84            "scale": 2.0766116941529233,
85            "showLegend": true,
86            "showLinkLabels": false,
87            "showNodeAnnotation": true,
88            "showNodeLabels": true,
89            "showTimeline": false,
90            "showTransactionDetails": false,
91            "showTransactionLinks": false,
92            "toolsPane": {
93              "activeTool": "Object Inspector",
94              "open": true
95            },
96            "transactionTypeIndex": 0,
97            "translate": [
98              -872.0999999999999,
99              -222.32031484257868
100            ]
101          }
102        }
103      }
104    ]
105  },
106  {
107    "id": 305,
108    "type": "WORKSHEET",
109    "name": "Workspace-2",
110    "version": 2,
111    "created": "2020-05-13T19:27:08.105Z",
112    "createdBy": "viuser",
113    "lastModified": "2020-05-13T19:27:26.175Z",
114    "lastModifiedBy": "viuser",
115    "tabOrder": 0,
116    "uxState": {
117      "commonToolPane": {
118        "expanded": true,
119        "width": 340
120      },
121      "filterPanel": {
122        "expanded": true,
123        "width": 200
124      }
125    },
126    "cells": [
127      {
128        "type": "LIVE",
129        "id": 401,
130        "row": 0,
131        "position": 0,
132        "height": 0,
133        "width": 0,
134        "version": 1,
135        "documents": [
136          {
137            "type": "person",
138            "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",
139            "uniqueId": "person#2f21e644-089a-47d8-a503-bbdd4d8dac3d"
140          },
141          {
142            "type": "person",
143            "id": "ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
144            "uniqueId": "person#ba0f8afd-b6e0-4763-91a8-9c6810d0156b"
145          }
146        ],
147        "visualizationType": "Network",
148        "resultsPerPage": 0,
149        "networkData": {
150          "links": [],
151          "nodes": {
152            "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d": {
153              "id": "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d",
154              "transitionStart": {
155                "x": 667,
156                "y": 206.5
157              },
158              "type": "person",
159              "typeLabel": "Person",
160              "x": 711.99394815911,
161              "y": 220.234232742122
162            },
163            "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b": {
164              "id": "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
165              "transitionStart": {
166                "x": 339.81315560960843,
167                "y": 106.62745147130762
168              },
169              "type": "person",
170              "typeLabel": "Person",
171              "x": 621.6305200034983,
172              "y": 192.65113758282533
173            }
174          },
175          "numNodes": 2,
176          "options": {
177            "activeNodes": false,
178            "centralityType": null,
179            "displayableTransactionType": null,
180            "groupCtr": 1,
181            "layout": {
182              "charge": 25,
183              "linkDistance": 130,
184              "linkStrength": 0.4,
185              "velocityDecay": 0.45
186            },
187            "nodeCtr": 1,
188            "scale": 2.0766116941529233,
189            "showLegend": true,
190            "showLinkLabels": false,
191            "showNodeAnnotation": true,
192            "showNodeLabels": true,
193            "showTimeline": false,
194            "showTransactionDetails": false,
195            "showTransactionLinks": false,
196            "toolsPane": {
197              "activeTool": "Object Inspector",
198              "open": true
199            },
200            "transactionTypeIndex": 0,
201            "translate": [
202              -872.0999999999999,
203              -222.32031484257868
204            ]
205          }
206        }
207      }
208    ]
209  }
210]

Path Parameters

Name	Type	Required	Description
objectId	string	true	The ID of the object.
objectTypeName	string	true	The name of the object type.

Responses

Status	Meaning	Description
200	OK	The request succeeded. A list of sheets was returned.	Schema
400	Bad Request	The request failed. The parameters cannot be null or empty.	Schema
404	Not Found	The request failed. The object was not found or the user did not have permission to view the object.	Schema