Provides the ability to transform a text, comma separated data source into a JSON array structure.
Version 1
HTTP RequestPOST /ado/v1/CsvToJson
Header
| Parameter | Description |
|---|---|
| Ocp-Apim-Subscription-Key | The subscription key you received when you purchased a plan. |
Request Body
Mandatory
| Parameter | Type | Description |
|---|---|---|
| data | string | The data. |
Optional
| Parameter | Type | Description |
|---|---|---|
| delimiter | string | Default is a , (comma) but can be changed to any separator as specified in your data set. |
| rowSeparator | string | The characters used to delimit each row. The default value is \n |
| headerRow | boolean | Do the contents in the data source contain a header row with field names? Default is true |
| escapeCharacter | string | The escape character is required in situations where the value of a field contains the character that delimits one field from the others. Default is " |
| encoding | string | Use 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
| Parameter | Type | Description |
|---|---|---|
| filter | String | A fully functioning SQL based WHERE statement that will filter the outgoing dataset to the records it determines as being included. |
| sortOrder | Object | Sorts 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). |
| schema | Object | You 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. |
| advancedOptions | Object | Is 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