Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Panel

On this page:

Table of Contents

Step By Step

Data

DDI Codebook

DDI Lifecycle

Monet DB

MySql

Oracle

PDF Codebook

PostgreSql

R Syntax

SAS Syntax

SDA Syntax

SPSS Syntax

SQL Server

Stata Syntax

Triple-S XML

...

The packaging API allows users to package data of interest in many different formats. There is currently no way to package data through a graphical interface so users will need to be comfortable using the REST API directly. Rich Data Services tries to make it as easy as possible for users to use the packaging API, or to build their own interfaces that use it. 

View all Available Formats

To view all the available packaging formats:

Code Block
titleGet All Formats
http://host/rds/api/package/types
Code Block
titleAll Formats
collapsetrue
[
    "CSV",
    "DELIM",
    "FIXED",
    "DDI_C122",
    "DDI_C21",
    "DDI_CNES",
    "DDI_C25",
    "DDI_L31CO",
    "DDI_L31RP",
    "DDI_L31SU",
    "DDI_L32RP",
    "DDI_L32SU",
    "SSS11",
    "SSS20",
    "SAS",
    "SPSS",
    "STATA",
    "R",
    "MATHEMATICA",
    "STAT_TRANSFER",
    "MYSQL",
    "ORACLE",
    "MS_SQL",
    "HYPER_SQL",
    "POSTGRES_SQL",
    "MONET_DB",
    "GOOGLE_BQ",
    "GOOGLE_FUSION",
    "SDA",
    "VERTICA"
] 

View Format by Category

The formats that RDS supports can be broken down into three categories, data (flat files), metadata (standards compliant metadata XML), and scripts (syntax to recreate the data in databases or statistical packages). To view the formats that are in each category use the category parameter.

Code Block
titleGet Data Formats
http://host/rds/api/package/types?category=data
Code Block
titleData Formats
collapsetrue
[
    "CSV",
    "DELIM",
    "FIXED"
]
Code Block
titleGet Metadata Formats
http://host/rds/api/package/types?category=metadata
Code Block
titleMetadata Formats
collapsetrue
[
    "DDI_C122",
    "DDI_C21",
    "DDI_CNES",
    "DDI_C25",
    "DDI_L31CO",
    "DDI_L31RP",
    "DDI_L31SU",
    "DDI_L32RP",
    "DDI_L32SU",
    "SSS11",
    "SSS20"
]
Code Block
titleGet Script Formats
http://host/rds/api/package/types?category=scripts
Code Block
titleScript Formats
collapsetrue
[
    "SAS",
    "SPSS",
    "STATA",
    "R",
    "MATHEMATICA",
    "STAT_TRANSFER",
    "MYSQL",
    "ORACLE",
    "MS_SQL",
    "HYPER_SQL",
    "POSTGRES_SQL",
    "MONET_DB",
    "GOOGLE_BQ",
    "GOOGLE_FUSION",
    "SDA",
    "VERTICA"
]