Get All SaaSDR Documents API

Get details of all SaaS documents.

GETsdr/api/v1/documents

Input ParametersInput Parameters

Parameter	Required/ Optional	Data Type	Description
size	Optional	Integer	Specify the number of records per page to be included in the response. If size is not specified in the request, 50 records will be fetched by default. The maximum value supported for size is 200.
page	Optional	Integer	Specify the page to be returned. Default page value is 0.
query	Optional	String	Filter the response by providing a query using Qualys QQL syntax.

Sample - To Get All DocumentsSample - To Get All Documents

API Request

curl-k -X <GET> -H <token> -i "<qualys_base_url>api/v1/documents"

Response

{
   "content":[
      {
         "customerId":"4eaa64f9-771c-745e-810a-37d3f4c38a49",
         "connector":{
            "id":2192,
            "type":"SALESFORCE"
         },
         "sourceId":"0690n000000rJJIAA2",
         "version":6,
         "entityType":"DOCUMENT",
         "name":"incr scan us3",
         "nameAlias":"incr scan us3",
         "type":"csv",
         "size":1049587,
         "owner":{
            "userId":"0050n000003Mg2eAAC",
            "email":"abc@xyz.com",
            "fullName":"user"
         },
         "lastUpdatedDate":"2021-09-27T10:18:49Z",
         "createdDate":"2021-09-27T10:17:37Z",
         "accessType":"Anyonewithlink",
         "webContentLink":"https:\/\/qualys--qlyssfengg.my.salesforce.com\/sfc\/p\/0n0000001N43\/a\/0n0000000HTm\/vAZfYfWa68XGH.RRZXOFD68UepRrT4bOtIa0kyJuJ24",
         "lastUpdatedBy":"abc@xyz.com",
         "externalDomains":"abc.com",
         "externalPermissionsCount":1,
         "isShared":true,
         "permissions":[
            {
               "sourceId":"06A0n000001Gu9iEAC",
               "documentId":"0690n000000rJJIAA2",
               "linkedEntityType":"User",
               "role":"reader",
               "accessType":"Trusted",
               "domain":"abc.com",
               "email":"testuser@xyz.com"
            },
            {
               "sourceId":"05D0n0000000HTmEAM",
               "documentId":"0690n000000rJJIAA2",
               "linkedEntityType":"Anyonewithlink",
               "role":"reader",
               "accessType":"Anyonewithlink",
               "domain":"anyonewithlink",
               "email":"anyonewithlink"
            }
         ]
      }
   ],
   "pageable":{
      "sort":{
         "unsorted":false,
         "sorted":true,
         "empty":false
      },
      "pageNumber":0,
      "pageSize":1,
      "offset":0,
      "paged":true,
      "unpaged":false
   },
   "last":false,
   "totalPages":92220,
   "totalElements":92220,
   "first":true,
   "sort":{
      "unsorted":false,
      "sorted":true,
      "empty":false
   },
   "numberOfElements":1,
   "size":1,
   "number":0,
   "empty":false
}