R: Returns the metadata for an existing LabKey domain

labkey.domain.get {Rlabkey} | R Documentation

## Returns the metadata for an existing LabKey domain

### Description

Get the data structure for a domain.

### Usage

    labkey.domain.get(baseUrl=NULL, folderPath, schemaName, queryName)

### Arguments

`baseUrl` | a string specifying the `baseUrl`for the labkey server
`folderPath` | a string specifying the `folderPath`
`schemaName` | a string specifying the name of the schema of the domain
`queryName` | a string specifying the query name

### Details

Returns the domain design of an existing domain. The returned domain design can be used for reporting purposes or it can be modified and used to create a new domain or update the domain source.

### Value

A list containing elements describing the domain. The structure is the same as a domain design created by `labkey.createDomainDesign`

### Author(s)

Karl Lum

### See Also

`labkey.domain.create`, `labkey.domain.inferFields`, `labkey.domain.createDesign`, `labkey.domain.save`, `labkey.domain.drop`

### Examples

    ## retrieve an existing domain
    library(Rlabkey)

    labkey.domain.get(baseUrl="http://labkey/", folderPath="home",
        schemaName="lists", queryName="test list")

[Package Rlabkey version 2.3.2 Index]