Versions Compared

Key

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

The metadata formats that are available for packaging are all standards based XML documents. Specifically they are either DDI Codebook or Lifecycle, or Triple-S XML. 

Table of Contents

DDI Codebook

The following is true for all the DDI codebook formats (DDI_C122, DDI_C21, DDI_CNES, DDI_C25) 

Code Block
titleGet Codebook Options
http://host/rds/api/package/types/DDI_C25
Code Block
titleCodebook Options
collapsetrue
{
    "objectId": "7511c981-ae3f-4e28-9ba8-2b1d9ad80b25",
    "type": "DDI_C25",
    "optionProperties": [
        {
            "description": "File name",
            "enumValues": [],
            "label": "File name",
            "name": "fileName",
            "type": "TEXT",
            "value": "",
            "repeatable": false,
            "required": true,
            "readOnly": false
        },
        {// specifies that the XML should be output in a human readable format (not all on one line)
            "description": "Is pretty print",
            "enumValues": [],
            "label": "Is pretty print",
            "name": "isPrettyPrint",
            "type": "BOOLEAN",
            "value": true,
            "repeatable": false,
            "required": false,
            "readOnly": false
        },
        {
            "description": "DDI Codebook ID",
            "enumValues": [],
            "label": "DDI ID",
            "name": "DDiID",
            "type": "TEXT",
            "value": "BOY2PCRafNsG3Ig6",
            "repeatable": false,
            "required": false,
            "readOnly": false
        },
        {
            "description": "Language",
            "enumValues": [],
            "label": "Language",
            "name": "language",
            "type": "TEXT",
            "value": "en",
            "repeatable": false,
            "required": true,
            "readOnly": false
        },
        {// the object id of the data file to document if available
            "description": "The ID of a FIXED | CSV | DELIM file being packaged that this Codebook is documenting.",
            "enumValues": [],
            "label": "Data File ID",
            "name": "dataInstanceId",
            "type": "TEXT",
            "value": "",
            "repeatable": false,
            "required": false,
            "readOnly": false
        }
    ]
}