Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

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. 

DDI Codebook

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

  • DDI_C122 - DDI Codebook 1.2.2
  • DDI_C21 - DDI Codebook 2.1
  • DDI_C25 - DDI Codebook 2.5
  • DDI_CNES - Nesstar compliant DDI Codebook

 

Get Codebook Options
http://host/rds/api/package/types/DDI_C25
Codebook Options
{
    "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
        }
    ]
}

DDI Lifecycle

The following is true for all the DDI Lifecycle formats (DDI_L31CO, DDI_L31RP, DDI_L31SU, DDI_L32RP, DDI_L32SU)

 

  • DDI_L31CO - Colectica compliant DDI Lifecycle 3.1
  • DDI_L31RP - DDI Lifecycle Resource Package 3.1
  • DDI_L31SU - DDI Lifecycle Study Unit 3.1
  • DDI_L32RP - DDI Lifecycle Resource Package 3.2
  • DDI_L32SU - DDI Lifecycle Study Unit 3.2

 

 

  • No labels