Column Codes

When using certain JSON-RPC API methods, you may be given or asked for column vectors or column codes and data source codes.

🚧

Please note, the old legacy shortnames will still work for the time being, but we would strongly recommend you change the API methods to use the below notations as soon as possible.

Example

If you want to output the information from the creation date, computer name, used storage and active data sources columns for a list of devices. Use the Enumerating Account Statistics method.

Using the "Columns" parameter in the old notation, this would be written as:

"Columns": ["CD", "MN", "US", "AP"],

Using the new notation, you are replacing "CD", "MN", "US" and "AP" with "I4", "I18", "I14" and "I78". This would mean the parameter in your JSON call now looks as below:

"Columns": ["I4", "I18", "I14", "I78"],

📘

There is no limit to the number of column vectors that can be requested using this Column parameter.

The response showing this information will be displayed as:

"Settings": [
    {
	"I4": "1536906195"
    },
    {
	"I18": "ComputerName1"
    },
    {
	"I14": "188702358870"
    },
    {
	"I78": "D01D02"
    }
]

Example Breakdown

In the above example, the Columns parameter is calling the following Settings to be displayed:

• I4: Creation Date
  The response for this has come back as "1536906195", which is the date and time in Unix format. Converted, this is Sept 14th, 2018, 07:23:15 relative to my timezone
• I18: Computer Name
  This is the unique computer name for the device in question
• I14: Used Storage
  The response for this has come back as "188702358870", which is the total size of storage used for the device in Bytes. Converted, this is 188.7 GB.
• I78: Active Data Sources
  The active data sources on the device, returned as concatenated 3-character codes. The response "D01D02" contains two datasource codes: D01 (Files and Folders) and D02 (System State). Review the below Parsing I78 (Active Data Sources) section for more information.

Expressions for active data sources

See the list of Backup data sources here, with the legacy shortnames detailed for ease:

Column Codes

See the list of Backup column codes below:

Primary device properties

Installation details

Storage info

Feature usage

Data source statistics fields

Company Information

Miscellaneous

Parsing I78 (Active Data Sources)

I78 returns active datasource codes as a single concatenated string. Split the string into 3-character blocks to extract individual codes. Each block maps to a datasource ID in the Expressions for Active Data Sources table.

Parsing example:

Split the string into 3-character segments to extract individual datasource IDs.

Filter examples:

Use wildcard matching to filter devices by datasource:

Notes

• Do not use exact match for I78 unless filtering for a specific single-datasource configuration. I78=='D01D02' will not match devices with three or more datasources (for example, D01D15D02).
• Datasource codes in I78 appear in a fixed ascending order. I78=~'D02D01*' returns zero results because D01 always precedes D02.

Constructing D##F## Codes

D##F## codes combine a datasource ID from the Expressions for Active Data Sources table with a statistics field from the Data Source Statistics Fields table.

Format: D[datasource]F[field] - zero-padding is mandatory for both components.

Codes without zero-padding fail silently.