Key Type Description Required A Pseudonymous Key representing the requesting ConsumerID String Yes Consumer who is the subject of the query. A Pseudonymous Key representing the OperatorID String Yes Consumer’s Operator. TimeWindow Object Indicates start and end time for Atom selection. No Start of time interval to be included in the query. Time in seconds since 1/1/1970 UTC. If absent, StartTime Number 1/1/1970 is assumed. Atoms SHALL be included if No their time stamp is between the StartTime and the EndTime. End of time interval to be included in the query. Time in seconds since 1/1/1970 UTC. If absent, EndTime Number infinity is assumed. Atoms SHALL be included if No their time stamp is between the StartTime and the EndTime. The element describing the overall structure of the Object No query. The element describing Atoms to use in the Filter Object No query. ColName String Column name. No Comparator String One of "=", ">", ">=", "<", "<=", "!=". No Value String Comparison value. No The element describing how to aggregate values Aggregate Object No selected in the query. Array of An indicating which columns to aggregate and Columns No Object how to aggregate them. Aggregator String One of AVG, SUM, COUNT, MIN, MAX, STDDEV. No ColName String Column name. No One or more Column Names to group by. Each Array of unique combination of the values included in the GroupBy No String GroupBy element SHALL result in a separate row in the Table element. Response (200) Content of the response body JSON object when a 200 (OK) status code is returned is either: An array of Atoms; or A table of data (resulting from an aggregate query). Note: Atoms MAY be returned either in the version in which they were originally stored or in the currently supported version. The following JSON Schema defines the structure, spelling and basic type of each element and The response body MUST comply with this schema, and with the additional constraints specified in the remainder of this section. { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object",
Key Type Description Required ConsumerID String A Pseudonymous Key representing the requesting Consumer who is the subject of the query. Yes OperatorID String A Pseudonymous Key representing the Consumer’s Operator. Yes TimeWindow Object Indicates start and end time for Atom selection. No StartTime Number Start of time interval to be included in the query. Time in seconds since 1/1/1970 UTC. If absent, 1/1/1970 is assumed. Atoms SHALL be included if their time stamp is between the StartTime and the EndTime. No EndTime Number End of time interval to be included in the query. Time in seconds since 1/1/1970 UTC. If absent, infinity is assumed. Atoms SHALL be included if their time stamp is between the StartTime and the EndTime. No Object The element describing the overall structure of the query. No Filter Object The element describing Atoms to use in the query. No ColName String Column name. No Comparator String One of "=", ">", ">=", "<", "<=", "!=". No Value String Comparison value. No Aggregate Object The element describing how to aggregate values selected in the query. No Columns Array of Object An indicating which columns to aggregate and how to aggregate them. No Aggregator String One of AVG, SUM, COUNT, MIN, MAX, STDDEV. No ColName String Column name. No GroupBy Array of String One or more Column Names to group by. Each unique combination of the values included in the GroupBy element SHALL result in a separate row in the Table element. No Response (200) Content of the response body JSON object when a 200 (OK) status code is returned is either: An array of Atoms; or A table of data (resulting from an aggregate query). Note: Atoms MAY be returned either in the version in which they were originally stored or in the currently supported version. The following JSON Schema defines the structure, spelling and basic type of each element and The response body MUST comply with this schema, and with the additional constraints specified in the remainder of this section. { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object",
COEL-v1.0-csprd02.docx