Get a collection of documents by entity type

get/documents/{entityTypeName}

Internal-Use Only

Gets a collection of documents for the specified entity type. To filter the collection of documents, submit a GET via POST request. Requesting a collection of child documents is not supported.

Request Samples

Response Samples

200
application/json
enrichedDocumentCollectionExample
1[
2  {
3    "objectTypeName": "person",
4    "objectTypeId": 100515,
5    "objectTypeVersion": 4,
6    "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",
7    "fieldValues": {
8      "birthday": "2020-01-05T00:00:00Z",
9      "created_at_dttm": "2020-04-13T19:17:47.84Z",
10      "created_by_user_id": "viuser",
11      "first_name": "John",
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": 4
17    },
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": true
26          }
27        }
28      }
29    },
30    "sheets": [
31      {
32        "id": 201,
33        "type": "WORKSHEET",
34        "name": "Workspace-1",
35        "version": 2,
36        "created": "2020-04-13T19:27:08.105Z",
37        "createdBy": "viuser",
38        "lastModified": "2020-04-13T19:27:26.175Z",
39        "lastModifiedBy": "viuser",
40        "tabOrder": 0,
41        "uxState": {
42          "commonToolPane": {
43            "expanded": true,
44            "width": 340
45          },
46          "filterPanel": {
47            "expanded": true,
48            "width": 200
49          }
50        },
51        "cells": [
52          {
53            "type": "LIVE",
54            "id": 301,
55            "row": 0,
56            "position": 0,
57            "height": 0,
58            "width": 0,
59            "version": 1,
60            "documents": [
61              {
62                "type": "person",
63                "id": "2f21e644-089a-47d8-a503-bbdd4d8dac3d",
64                "uniqueId": "person#2f21e644-089a-47d8-a503-bbdd4d8dac3d"
65              },
66              {
67                "type": "person",
68                "id": "ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
69                "uniqueId": "person#ba0f8afd-b6e0-4763-91a8-9c6810d0156b"
70              }
71            ],
72            "visualizationType": "Network",
73            "resultsPerPage": 0,
74            "networkData": {
75              "links": [],
76              "nodes": {
77                "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d": {
78                  "id": "person~2f21e644-089a-47d8-a503-bbdd4d8dac3d",
79                  "transitionStart": {
80                    "x": 667,
81                    "y": 206.5
82                  },
83                  "type": "person",
84                  "typeLabel": "Person",
85                  "x": 711.99394815911,
86                  "y": 220.234232742122
87                },
88                "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b": {
89                  "id": "person~ba0f8afd-b6e0-4763-91a8-9c6810d0156b",
90                  "transitionStart": {
91                    "x": 339.81315560960843,
92                    "y": 106.62745147130762
93                  },
94                  "type": "person",
95                  "typeLabel": "Person",
96                  "x": 621.6305200034983,
97                  "y": 192.65113758282533
98                }
99              },
100              "numNodes": 2,
101              "options": {
102                "activeNodes": false,
103                "centralityType": null,
104                "displayableTransactionType": null,
105                "groupCtr": 1,
106                "layout": {
107                  "charge": 25,
108                  "linkDistance": 130,
109                  "linkStrength": 0.4,
110                  "velocityDecay": 0.45
111                },
112                "nodeCtr": 1,
113                "scale": 2.0766116941529233,
114                "showLegend": true,
115                "showLinkLabels": false,
116                "showNodeAnnotation": true,
117                "showNodeLabels": true,
118                "showTimeline": false,
119                "showTransactionDetails": false,
120                "showTransactionLinks": false,
121                "toolsPane": {
122                  "activeTool": "Object Inspector",
123                  "open": true
124                },
125                "transactionTypeIndex": 0,
126                "translate": [
127                  -872.0999999999999,
128                  -222.32031484257868
129                ]
130              }
131            }
132          }
133        ]
134      }
135    ],
136    "comments": [
137      {
138        "id": 1,
139        "author": {
140          "id": "viuser",
141          "name": "Test viuser"
142        },
143        "createDate": "2020-04-13T19:18:05.087Z",
144        "lastUpdatedAt": "2020-04-13T19:18:05.087Z",
145        "lastUpdatedBy": "viuser",
146        "detail": "Sample comment<br />"
147      }
148    ],
149    "attachmentsCount": 2
150  }
151]

Path Parameters

Name	Type	Required	Description
entityTypeName	string	true	The name of the entity type to which the document belongs. Child entity types are not supported.

Query Parameters

Name	Type	Required	Description
depth	string	false	The depth of child documents to return. The value can be either: Default: 0
includeDisplayLabel	boolean	false	Indicates whether to generate and include the display label in the document. Default: false
limit	integer	false	The maximum number of documents to return in this page of results. The actual number of returned documents is fewer if the collection is exhausted. Default: 40
start	integer	false	The starting index of the first document in a page. Default: 0

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	The media type that the client accepts for items within the response collection. Allowed values: application/jsonapplication/vnd.sas.investigation.data.enriched.documentapplication/vnd.sas.investigation.data.enriched.document+jsonapplication/vnd.sas.investigation.data.masked.enriched.documentapplication/vnd.sas.investigation.data.masked.enriched.document+jsonapplication/vnd.sas.investigation.data.minimally.masked.enriched.documentapplication/vnd.sas.investigation.data.minimally.masked.enriched.document+json

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
404	Not Found	The entity type was not found.	Schema
415	Unsupported Media Type	The endpoint cannot produce collection items of the type specified in the `Accept-Item` header.	Schema