get-available-dataset-fields

Specification Version

Version: "1"

Context and rules

Required for the StructuredData capability.

Called when a user is setting up a data extract or visualisation, to indicate which fields are available to the user.

Which fields are available may depend upon the options the user has chosen. These options are passed in as input to this endpoint. The structure of these options is determined by the schema returned from the endpoint endpoint-prefix-aireframe-get-dataset-options-schema.

Endpoint specification

• Name: endpoint-prefix-aireframe-get-available-dataset-fields
• Verb: POST
• Authentication: Client credentials

Input

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-available-dataset-fields-input",
	"type": "object"
}

• Example:

{
	"info-type": "sales"
}

Response

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-available-dataset-fields-response",
	"type": "object",
	"properties": {
		"AvailableFields": {
			"type": "array",
			"items": {
				"required": [
					"Key",
					"DataType"
				],
				"properties": {
					"Key": {
						"type": "string"
					},
					"DataType": {
						"type": "string",
						"enum": [
									"String",
									"Decimal",
									"Integer",
									"DateTime",
									"Date",
									"Time",
									"Boolean"
								]
					}
				}
			}
		}
	},
	"required": [
		"AvailableFields"
	]
}

• Example

{
	"AvailableFields": [
		{
			"Key": "NAME",
			"DataType": "String"
		}
	]
}

Previous versions

None