Get a collection of documents by entity type

get/documents/{entityTypeName}

Retrieves 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

1

Response Samples

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

Path Parameters

NameTypeRequiredDescription
entityTypeName
string
true

The name of the entity type to which the document belongs. Child entity types are not supported.

Query Parameters

NameTypeRequiredDescription
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

NameTypeRequiredDescription
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

StatusMeaningDescription
200OK

The request succeeded.

Schema
404Not Found

The entity type was not found.

Schema
415Unsupported Media Type

The endpoint cannot produce collection items of the type specified in the Accept-Item header.

Schema