Method: Appwrite::Databases#get_document

Defined in:

lib/appwrite/services/databases.rb

#get_document(database_id:, collection_id:, document_id:, queries: nil) ⇒ Document

Get a document by its unique ID. This endpoint response returns a JSON object with the document data.

Parameters:

• database_id (String) —

  Database ID.

• collection_id (String) —

  Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

• document_id (String) —

  Document ID.

• queries (Array) (defaults to: nil) —

  Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

Returns:

• (Document)

# File 'lib/appwrite/services/databases.rb', line 1764

def get_document(database_id:, collection_id:, document_id:, queries: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    api_params = {
        queries: queries,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end