Method: Propertyware::DocumentsApi#retrieve_all_documents

Defined in:
lib/propertyware/api/documents_api.rb

#retrieve_all_documents(entity_type, opts = {}) ⇒ Array<Document>

Retrieve all documents Retrieves a list of documents associated with a specific entity.<br/><br/>Required permission:<br/><span class="permissionBlock">DOCUMENTS</span> - Read <br/><br/>Sortable by: createddate, lastmodifieddatetime, id

Parameters:

  • entity_type (String) —

    Filters results to documents associated with a specific entity type.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :entity_id (Integer) —

    Filters results to documents associated with a specific entity id. entity ID is not required for DESKTOP and OTHER. Remaining entities need entity ID.

Returns:



159
160
161
162
 
# File 'lib/propertyware/api/documents_api.rb', line 159

def retrieve_all_documents(entity_type, opts = {})
  data, _status_code, _headers = retrieve_all_documents_with_http_info(entity_type, opts)
  data
end