/
Data Formats

Data Formats

Owned by Andrew DeCarlo
Last updated: Aug 24, 2016

The data formats that are available for packaging are all flat files ASCII files. This allows them to be used across systems with the expectation that they have some sort of metadata or syntax file that describes them. 

Fixed Width

Get Fixed Options
http://host/rds/api/package/types/FIXED
Fixed Options 
{
    "objectId": "26ac8903-c319-4e3d-874a-08f91673e1bb",
    "type": "FIXED",
    "optionProperties": [
        {
            "description": "File name", // The only option available for fixed width files is the file name. 
            "enumValues": [],
            "label": "File name",
            "name": "fileName",
            "type": "TEXT",
            "value": "",
            "repeatable": false,
            "required": true,
            "readOnly": false
        }
    ]
}

CSV

Get CSV Options
http://host/rds/api/package/types/CSV
CSV Options 
{
    "objectId": "80241600-bf8b-4be1-afd2-52c41fabbae5",
    "type": "CSV",
    "optionProperties": [
        {									// File name
            "description": "File name",  
            "enumValues": [],
            "label": "File name",
            "name": "fileName",
            "type": "TEXT",
            "value": "",
            "required": true,
            "repeatable": false,
            "readOnly": false
        },
        {									// Delimiter to be used
            "description": "Delimeter",
            "enumValues": [],
            "label": "Delimeter",
            "name": "delimeter",
            "type": "TEXT",
            "value": ",",					// Because this is a CSV file the default delimiter is ,
            "required": true,
            "repeatable": false,
            "readOnly": false
        },
        {									// Empty values can be replaced with "NULL"
            "description": "Replace blank values with \"NULL\", typically used for database scripts",
            "enumValues": [],
            "label": "Replace blank with NULL",
            "name": "replaceBlankWithNull",
            "type": "BOOLEAN",
            "value": false,
            "required": true,
            "repeatable": false,
            "readOnly": false
        },
        {									// This specifies if the user wants a header row of all the variable names on the first line of the file, true by default
            "description": "Includes variable names on first line of the file",
            "enumValues": [],
            "label": "Include variable names",
            "name": "includeVariableNames",
            "type": "BOOLEAN",
            "value": true,
            "required": true,
            "repeatable": false,
            "readOnly": false
        }
    ]
}

Delimited

Get Delimited Options
http://host/rds/api/package/types/DELIM
Delimited Options 
{
    "objectId": "95a4495a-5559-4631-93e2-b83548be83e1",
    "type": "DELIM",
    "optionProperties": [
        {									// File name
            "description": "File name",
            "enumValues": [],
            "label": "File name",
            "name": "fileName",
            "type": "TEXT",
            "value": "",
            "required": true,
            "repeatable": false,
            "readOnly": false
        },
        {									// Delimiter to be used
            "description": "Delimeter",
            "enumValues": [],
            "label": "Delimeter",
            "name": "delimeter",
            "type": "TEXT",
            "value": "\t",					// Tab delimited by default
            "required": true,
            "repeatable": false,
            "readOnly": false
        },
        {									// Empty values can be replaced with "NULL"
            "description": "Replace blank values with \"NULL\", typically used for database scripts",
            "enumValues": [],
            "label": "Replace blank with NULL",
            "name": "replaceBlankWithNull",
            "type": "BOOLEAN",
            "value": false,
            "required": true,
            "repeatable": false,
            "readOnly": false
        },
        {									// This specifies if the user wants a header row of all the variable names on the first line of the file, true by default
            "description": "Includes variable names on first line of the file",
            "enumValues": [],
            "label": "Include variable names",
            "name": "includeVariableNames",
            "type": "BOOLEAN",
            "value": true,
            "required": true,
            "repeatable": false,
            "readOnly": false
        }
    ]
}