openapi: 3.2.0
info:
title: ERCOT Public API Client/Developer Documentation NP3 911 ER API
description: Client/Developer RESTFul web services documentation for ERCOT Market Information List (EMIL) products.
version: '1.0'
servers:
- url: https://api.ercot.com/api/public-reports
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: NP3-911-ER
description: 2-Day Ancillary Services Reports
This report will contain all 48 Hour disclosure data related to DAM. The following individual files are included in the report:NP3-959-EX 48-hour Aggregate AS Offers; NP3-960-EX 48-hour Self-Arranged AS; NP3-961-EX 48-hour Cleared DAM AS (previously named 48 Hour Ancillary Services Reports).
paths:
/np3-911-er/2d_self_arranged_as_rrsufr:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service RRSUFR
description: 2 Day Self Arranged Ancillary Service RRSUFR
operationId: getData_57
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASRRSUFRFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASRRSUFRTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_rrspfr:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service RRSPFR
description: 2 Day Self Arranged Ancillary Service RRSPFR
operationId: getData_58
parameters:
- name: totalSelfArrangedASRRSPFRFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASRRSPFRTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_rrsffr:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service RRSFFR
description: 2 Day Self Arranged Ancillary Service RRSFFR
operationId: getData_59
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASRRSFFRFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASRRSFFRTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_regup:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service REGUP
description: 2 Day Self Arranged Ancillary Service REGUP
operationId: getData_60
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASREGUPFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASREGUPTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_regdn:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service REGDN
description: 2 Day Self Arranged Ancillary Service REGDN
operationId: getData_61
parameters:
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASREGDNFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASREGDNTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_nspnm:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service NSPNM
description: 2 Day Self Arranged Ancillary Service NSPNM
operationId: getData_62
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASNSPNMFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASNSPNMTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_nspin:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service NSPIN
description: 2 Day Self Arranged Ancillary Service NSPIN
operationId: getData_63
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASNSPINFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASNSPINTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_ecrss:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service ECRSS
description: 2 Day Self Arranged Ancillary Service ECRSS
operationId: getData_64
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASECRSSFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASECRSSTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_self_arranged_as_ecrsm:
get:
tags:
- NP3-911-ER
summary: 2 Day Self Arranged Ancillary Service ECRSM
description: 2 Day Self Arranged Ancillary Service ECRSM
operationId: getData_65
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalSelfArrangedASECRSMFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalSelfArrangedASECRSMTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_rrsufr:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service RRSUFR
description: 2 Day Cleared DAM Ancillary Service RRSUFR
operationId: getData_66
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASRRSUFRFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASRRSUFRTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_rrspfr:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service RRSPFR
description: 2 Day Cleared DAM Ancillary Service RRSPFR
operationId: getData_67
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASRRSPFRFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASRRSPFRTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_rrsffr:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service RRSFFR
description: 2 Day Cleared DAM Ancillary Service RRSFFR
operationId: getData_68
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASRRSFFRFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASRRSFFRTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_regup:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service REGUP
description: 2 Day Cleared DAM Ancillary Service REGUP
operationId: getData_69
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASREGUPFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASREGUPTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_regdn:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service REGDN
description: 2 Day Cleared DAM Ancillary Service REGDN
operationId: getData_70
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASREGDNFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASREGDNTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_nspin:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service NSPIN
description: 2 Day Cleared DAM Ancillary Service NSPIN
operationId: getData_71
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASNSPINFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASNSPINTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_ecrss:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service ECRSS
description: 2 Day Cleared DAM Ancillary Service ECRSS
operationId: getData_72
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASECRSSFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASECRSSTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_cleared_dam_as_ecrsm:
get:
tags:
- NP3-911-ER
summary: 2 Day Cleared DAM Ancillary Service ECRSM
description: 2 Day Cleared DAM Ancillary Service ECRSM
operationId: getData_73
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: totalClearedASECRSMFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: totalClearedASECRSMTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_rrsufr:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers RRSUFR
description: 2 Day Aggregated Ancillary Service Offers RRSUFR
operationId: getData_74
parameters:
- name: RRSUFROfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: RRSUFROfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_rrspfr:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers RRSPFR
description: 2 Day Aggregated Ancillary Service Offers RRSPFR
operationId: getData_75
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: RRSPFROfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: RRSPFROfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_rrsffr:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers RRSFFR
description: 2 Day Aggregated Ancillary Service Offers RRSFFR
operationId: getData_76
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: RRSFFROfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: RRSFFROfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_regup:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers REGUP
description: 2 Day Aggregated Ancillary Service Offers REGUP
operationId: getData_77
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: REGUPOfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: REGUPOfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_regdn:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers REGDN
description: 2 Day Aggregated Ancillary Service Offers REGDN
operationId: getData_78
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: REGDNOfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: REGDNOfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_onns:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers ONNS
description: 2 Day Aggregated Ancillary Service Offers ONNS
operationId: getData_79
parameters:
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: ONNSOfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: ONNSOfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_offns:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers OFFNS
description: 2 Day Aggregated Ancillary Service Offers OFFNS
operationId: getData_80
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: OFFNSOfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: OFFNSOfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_ecrss:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers ECRSS
description: 2 Day Aggregated Ancillary Service Offers ECRSS
operationId: getData_81
parameters:
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: ECRSSOfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: ECRSSOfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
/np3-911-er/2d_agg_as_offers_ecrsm:
get:
tags:
- NP3-911-ER
summary: 2 Day Aggregated Ancillary Service Offers ECRSM
description: 2 Day Aggregated Ancillary Service Offers ECRSM
operationId: getData_82
parameters:
- name: ECRSMOfferPriceFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: ECRSMOfferPriceTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: deliveryDateFrom
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: deliveryDateTo
in: query
description: Format - yyyy-MM-dd.
schema:
type: string
format: yyyy-MM-dd
- name: hourEndingFrom
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: hourEndingTo
in: query
description: 'Format - ###.'
schema:
type: integer
format: '###'
- name: MWOfferedFrom
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: MWOfferedTo
in: query
description: 'Format - ####.###.'
schema:
type: number
format: '####.###'
- name: page
in: query
description: 'Format - ###. Page number of returned values in the collection.'
schema:
type: integer
format: '###'
- name: size
in: query
description: 'Format - ###. Number of returned items per page.'
schema:
type: integer
format: '###'
- name: sort
in: query
description: Format - abc123. Defines field by which to sort the returned resource values.
schema:
type: string
format: abc123
- name: dir
in: query
description: Format - abc123. Defines sort order of returned values based on the primary business key of the resource.
schema:
type: string
format: abc123
responses:
'200':
description: OK The operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
example:
_meta:
totalRecords: 0
pageSize: 0
totalPages: 0
currentPage: 0
query:
parameterCount: 0
parameters: {}
sortedBy: string
report:
reportName: string
reportDisplayName: string
reportId: string
reportEMIL: string
fields:
- name: string
label: string
cardinality: 0
dataType: BOOLEAN
searchable: true
sortable: true
hasRange: true
data: {}
links:
- rel: string
href: string
hreflang: string
media: string
title: string
type: string
deprecation: string
profile: string
name: string
'400':
description: The request operation failed. The request and/or one or more of its parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'403':
description: The request operation failed. You do not have access to the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
'404':
description: The request operation failed. The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
example:
timestamp: string
code: 0
status: string
message: string
data: {}
components:
schemas:
ReportMetadata:
type: object
properties:
reportName:
type: string
reportDisplayName:
type: string
reportId:
type: string
reportEMIL:
type: string
description: Represents metadata for the specified object.
Field:
type: object
properties:
name:
type: string
label:
type: string
cardinality:
type: integer
format: int32
dataType:
enum:
- BOOLEAN
- VARCHAR
- INTEGER
- LONG
- DOUBLE
- DATE
- DATETIME
- TIME
type: string
searchable:
type: boolean
sortable:
type: boolean
hasRange:
type: boolean
description: Represents report data field.
Exception:
type: object
properties:
timestamp:
type: string
format: date-time
code:
type: integer
format: int32
status:
type: string
message:
type: string
data:
type: object
description: Represents any exception encountered while access API endpoints.
QueryMetadata:
type: object
properties:
parameterCount:
type: integer
format: int32
parameters:
type: object
additionalProperties:
type: object
sortedBy:
type: string
description: Represents query parameter summary for the specified query results.
ResultMetadata:
type: object
properties:
totalRecords:
type: integer
format: int64
pageSize:
type: integer
format: int32
totalPages:
type: integer
format: int32
currentPage:
type: integer
format: int32
query:
$ref: '#/components/schemas/QueryMetadata'
description: Represents record and paging summary for the specified query results.
Report:
type: object
properties:
_meta:
$ref: '#/components/schemas/ResultMetadata'
report:
$ref: '#/components/schemas/ReportMetadata'
fields:
type: array
items:
$ref: '#/components/schemas/Field'
data:
type: object
links:
type: array
items:
$ref: '#/components/schemas/Link'
description: Represents report data search results from any EMIL artifact report query.
Link:
type: object
properties:
rel:
type: string
href:
type: string
hreflang:
type: string
media:
type: string
title:
type: string
type:
type: string
deprecation:
type: string
profile:
type: string
name:
type: string
securitySchemes:
apiKeyHeader:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
apiKeyQuery:
type: apiKey
name: subscription-key
in: query