module DocumentCloud::API::Entities

Constants

DOCUMENT_PATH
ENTITIES_PATH

Public Instance Methods

entities(id) click to toggle source

Fetch document entities

@param id [String] The document id @returns [Hash] The fetched document entities

# File lib/document_cloud/api/entities.rb, line 12
def entities(id)
  parse_json(get(entities_path(id)))[:entities]
end

Private Instance Methods

entities_path(document_id) click to toggle source
# File lib/document_cloud/api/entities.rb, line 18
def entities_path(document_id)
  "#{DOCUMENT_PATH}/#{document_id.to_i}/#{ENTITIES_PATH}"
end