API Reference

Search

Description

Returns a list of all entities that match the provided criteria. Both name and description are fuzzy matches; they match any entity that contains the provided string. The type is used to filter results based on the provided type of entity. The consumer must have READ access on all returned entities.

GET /api/v1/entity

🚧

Required OAuth Scopes:

No OAuth scopes are required to use this endpoint.

Parameters

ParameterInTypeRequiredDescription
namequerystringfalseThe name to use when fuzzy-matching entities
descriptionquerystringfalseThe description to use when fuzzy-matching entities
typequeryarray[integer]falseTo limit the scope, the type of entity to return in the results
limitqueryinteger(int32)falseThe number of folders to return, from 1 to 1000; by default, 1000
cursorquerystringfalseA paging cursor; if included, limit is ignored
offsetqueryinteger(int64)falseThe item to start with on the page, greater than or equal to 0; by default, 0

Code Samples

curl -X GET https://h.app.wdesk.com/s/wdata/prep/api/v1/entity  \ 
-H 'Accept: */*' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://h.app.wdesk.com/s/wdata/prep/api/v1/entity  \ 
Accept:*/* \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://h.app.wdesk.com/s/wdata/prep/api/v1/entity" \
 --output-document -  \ 
 --header 'Accept: */*' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://h.app.wdesk.com/s/wdata/prep/api/v1/entity', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with body and cursor properties.

  • body contains an array of FolderableDto objects. If the request returns no results, body contains an empty array.
  • cursor contains a paging cursor, which can be included in the next call to the endpoint to retrieve the next set of results. If no additional results, cursor is null.

Example Responses

No example available