get-dataset-options-schema

Specification Version

Version: "1"

Context and rules

Required for the StructuredData capability.

Provides the schema for the options that users can enter when they are setting up a data extract, which will then be passed into endpoint-prefix-get-available-dataset-fields.

Any changes to this schema should be backwards compatible as a user may have set up a data extract which is in use for a visualisation for a previous schema.

Endpoint specification

• Name: endpoint-prefix-aireframe-get-dataset-options-schema
• Verb: GET
• Authentication: Client credentials

Input

• Format: None

Response

• Format: JSON
• Schema:

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

• Example

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "",
	"type": "object",
	"oneOf":[
	    {
	        "properties": {
	            "info-type":{
	                "type": "string",
	                "enum": ["sales", "returns"]
	            }
	        },
	        "additionalProperties": false
	    }
	]
}

Previous versions

None