API: CatDD

A database data dictionary (DD) describes the attributes of the columns of tables that are ingested into the IRSA archive from an IPAC ASCII table. It includes information such as the column description, units, and formats and relationships between columns.

IRSA provides a tool to generate an ASCII data dictionary from an IPAC ASCII table.

CatDD returns the data dictionary of a catalog hosted at IRSA, and output in XML, HTML, or ASCII format.

The general format of an HTTP GET query is:

[URL of program]?[keyword1=value1]&[keyword2=value2]&...[keywordn=valuen] The URL of the IRSA catalog data dictionary service, CatDD, is
https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-dd and its keywords are described below.

Keyword Description Allowed Values
mode (optional) Catalog listing output format: XML, HTML, or IPAC ASCII html (default)
xml
ascii
catalog (required) catalog name inside database list of catalogs in xml
short (optional) display mode : Short DD means the default list of columns on the Gator query page; long DD means full list of columns on the Gator query page. 1 = display short DD with default selected columns. (default)
0 = display long DD with all columns.
onlist (optional) whether or not the data are generally available. (Generally only set when users are supporting testing and evaluation of new catalogs at IRSA's request.) 1 = catalog is visible through Gator web interface (default).
0 = catalog has been ingested into IRSA but not yet visible through Gator web interface.

Examples

(1) Get the data dictionary of the 2MASS All-sky Point Source Catalog using default values of short, onlist and mode. Display contents of default columns (standard query form) in HTML format.
https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-dd?catalog=fp_psc.   View Result in HTML

(2) Get the data dictionary of the 2MASS All-sky Point Source Catalog and display the result in XML. https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-dd?mode=xml&catalog=fp_psc   View Result in XML

(3) Get the data dictionary of the 2MASS All-sky Point Source Catalog. Display in HTML the results for the full list of columns on the Gator query page. https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-dd?short=0&catalog=fp_psc   View Result in HTML