State Solutions

CSV to Json

Provides the ability to transform a text, comma separated data source into a JSON array structure.

Version 1

HTTP Request
POST /ado/v1/CsvToJson

Header

ParameterDescription
Ocp-Apim-Subscription-KeyThe subscription key you received when you purchased a plan.

Request Body

Mandatory

ParameterTypeDescription
datastringThe data.

Optional

ParameterTypeDescription
delimiterstringDefault is a , (comma) but can be changed to any separator as specified in your data set.
rowSeparatorstringThe characters used to delimit each row. The default value is \n
headerRowbooleanDo the contents in the data source contain a header row with field names? Default is true
escapeCharacterstringThe escape character is required in situations where the value of a field contains the character that delimits one field from the others. Default is "
encodingstringUse this in cases where the contents of the file are not encoded in a UTF8 format. All possible values are:
– ASCII
– UTF8
– UTF16LittleEndian
– UTF16BigEndian
– ISO-8859-1

Common

Further Documentation: Common Parameters

ParameterTypeDescription
filterStringA fully functioning SQL based WHERE statement that will filter the outgoing dataset to the records it determines as being included.
sortOrderObjectSorts the resulting dataset by the criteria provided.
The object should contain property names that represent properties contained within the resulting dataset with a value corresponding to the desired sort direction (i.e. ASC or DESC).
schemaObjectYou can use this parameter to override the inferred schema for properties in the incoming dataset(s).
A field will be inferred unless specific explicitly within this object.
advancedOptionsObjectIs an object with the following properties.

cultureName (String)
The specified culture determines the behaviour for aspects related to formatting numeric values and dates. Is extremely important when converting strings to dates, e.g. 05/03/2022 will be treated differently between locales. For more information on the accepted values for this property, please consult the documentation from Microsoft … https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-6.0#culture-names-and-identifiers

isBoolean (string[])
A list of strings that are the names of all properties in the resulting dataset that should be treated as boolean values.

By default, the framework treats boolean values as 1 (true) or 0 (false). In order to differentiate the integer as a boolean, the property in question needs to be called out explicitly in this list.

Notes

The field delimiter for the contents contained within the data parameter is a comma.

Examples

With Header Row
Without Header Row

This example demonstrates a simple data set with a header row and a single data record.

Request

{
    "headerRow": true,
    "data": "Header 1,Header 2,Header 3,Header 4\nValue1,Value,Value 3,Test\nValue2.1,Value 3.1,Value 4.1,Value Test"
}
Code language: JSON / JSON with Comments (json)

Response

[
    {
        "Header 1": "Value1",
        "Header 2": "Value",
        "Header 3": "Value 3",
        "Header 4": "Test"
    },
    {
        "Header 1": "Value2.1",
        "Header 2": "Value 3.1",
        "Header 3": "Value 4.1",
        "Header 4": "Value Test"
    }
]
Code language: JSON / JSON with Comments (json)