api_data_urlmust be provided for the Resource.
access_methodof the Resource is an optional parameter, and can be either
file, it indicates all responses are available in a static JSON file. (The default if this parameter is not provided is
file.) When data is available via file semantics, the Resource
pathshall be a file reference or URL for the complete response data.
schemaproperty of the resource must be provided inline, and must not use an external schema file or URL.
schemaproperty must contain a
fieldsobject describing the 6 columns within the Resource data. These fields are common to all Flow Results Packages, but are provided here for compatibility with software designed to dynamically read Tabular Data Resources:
schemaproperty must additionally contain a
questionsobject describing metadata for all the Questions pertaining to Responses in this package. The object identifier (e.g.: 'ae54d3') of questions in this object connects to the Question ID found in each Response row:
schemaproperty may optionally contain a
languageproperty. If provided, this must be in the form of ISO 639-3, describing the language of the labels in the
questionsobject. Localization of these labels is left outside the scope of the Flow Results specification.
id; each change to a flow creates a new package
id. The implementation would serve separate results for different package
ids. Client software or external services could examine the Descriptor of each Package and determine, with additional user information, how to aggregate the responses together.
id; changes to a flow create new versions under the same
id, according to the following constraints. Specifically, newer versions of the same package
idmay add additional
questionswithin the schema; however, questions may not be removed, and the metadata for existing questions may not be changed. This implies that if a newer version of a flow removes a question from a previous version, the old question will continue to be listed in the schema for the new version. (This ensures that the schema of the most recent version contains a complete set of questions describing all responses in the aggregated resource data, including responses collected under older verions.) The
modifiedtimestamp is used as a version control indicator for the Package.
max-versionto allow clients to selectively retrieve responses from specific versions. (If a client has cached a version of the schema from a Package descriptor, it is recommended to supply the Package's
modifieddescriptor as the
max-versionwhen querying the API for responses, to ensure it does not receive responses from newer versions without a corresponding
questionin the cached schema.)
ids are required; external clients are responsible for more advanced forms of aggregation across versions of flows.
schemametadata, and within the Response Metadata for each row:
typeis identified within the response metadata.)
schemalevel. (Refer to the
type_optionswithin each row.)
[lat, long, elevation]
[lat, long, elevation, accuracy]
date-timeformat with timezone extension: