STORM QUERY
/
Reporting
/
Reporting

Storm Query API Documentation (2.0)

Storm Query API is an API based on OData V4. It is an API to fill the need for data from Storm in integration services that do not have direct access to Storm’s data and data models.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://query.storm.io/Query/2.0/

Schemas

Reporting

Operations

Get OrderSummaryByDay

Request

Get OrderSummaryByDay

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/OrderSummaryByDay

Responses

Success

Bodyapplication/jsonArray [
Clientstring

Client. MaxLength: 100. Key property.

Applicationstring

Application. MaxLength: 50. Key property.

Yearinteger(int32)

Year. Key property.

Monthinteger(int32)

Month. Key property.

Dayinteger(int32)

Day. Key property.

OrderQtyinteger(int32)

OrderQty.

FreightCostExVatnumber(decimal)

FreightCostExVat.

FreightCostIncVatnumber(decimal)

FreightCostIncVat.

OrderFeeExVatnumber(decimal)

OrderFeeExVat.

OrderFeeIncVatnumber(decimal)

OrderFeeIncVat.

ItemQtynumber(decimal)

ItemQty.

ItemAmountExVatnumber(decimal)

ItemAmountExVat.

ItemAmountIncVatnumber(decimal)

ItemAmountIncVat.

OrderSumExVatnumber(decimal)

OrderSumExVat.

OrderSumIncVatnumber(decimal)

OrderSumIncVat.

]
Response
application/json
[
  {
    "Client": "string",
    "Application": "string",
    "Year": 0,
    "Month": 0,
    "Day": 0,
    "OrderQty": 0,
    "FreightCostExVat": 0,
    "FreightCostIncVat": 0,
    "OrderFeeExVat": 0,
    "OrderFeeIncVat": 0,
    "ItemQty": 0,
    "ItemAmountExVat": 0,
    "ItemAmountIncVat": 0,
    "OrderSumExVat": 0,
    "OrderSumIncVat": 0
  }
]

Get OrderSummaryByMonth

Request

Get OrderSummaryByMonth

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/OrderSummaryByMonth

Responses

Success

Bodyapplication/jsonArray [
Clientstring

Client. MaxLength: 100. Key property.

Applicationstring

Application. MaxLength: 50. Key property.

Yearinteger(int32)

Year. Key property.

Monthinteger(int32)

Month. Key property.

OrderQtyinteger(int32)

OrderQty.

FreightCostExVatnumber(decimal)

FreightCostExVat.

FreightCostIncVatnumber(decimal)

FreightCostIncVat.

OrderFeeExVatnumber(decimal)

OrderFeeExVat.

OrderFeeIncVatnumber(decimal)

OrderFeeIncVat.

ItemQtynumber(decimal)

ItemQty.

ItemAmountExVatnumber(decimal)

ItemAmountExVat.

ItemAmountIncVatnumber(decimal)

ItemAmountIncVat.

OrderSumExVatnumber(decimal)

OrderSumExVat.

OrderSumIncVatnumber(decimal)

OrderSumIncVat.

]
Response
application/json
[
  {
    "Client": "string",
    "Application": "string",
    "Year": 0,
    "Month": 0,
    "OrderQty": 0,
    "FreightCostExVat": 0,
    "FreightCostIncVat": 0,
    "OrderFeeExVat": 0,
    "OrderFeeIncVat": 0,
    "ItemQty": 0,
    "ItemAmountExVat": 0,
    "ItemAmountIncVat": 0,
    "OrderSumExVat": 0,
    "OrderSumIncVat": 0
  }
]

Get OrderSummaryByPaymentAndMonth

Request

Get OrderSummaryByPaymentAndMonth

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/OrderSummaryByPaymentAndMonth

Responses

Success

Bodyapplication/jsonArray [
Clientstring

Client. MaxLength: 100. Key property.

Applicationstring

Application. MaxLength: 50. Key property.

PaymentServicestring

PaymentService. MaxLength: 50. Key property.

PaymentMethodTypestring

PaymentMethodType. MaxLength: 50. Key property.

PaymentMethodstring

PaymentMethod. MaxLength: 50. Key property.

Yearinteger(int32)

Year. Key property.

Monthinteger(int32)

Month. Key property.

OrderQtyinteger(int32)

OrderQty.

FreightCostExVatnumber(decimal)

FreightCostExVat.

FreightCostIncVatnumber(decimal)

FreightCostIncVat.

OrderFeeExVatnumber(decimal)

OrderFeeExVat.

OrderFeeIncVatnumber(decimal)

OrderFeeIncVat.

ItemQtynumber(decimal)

ItemQty.

ItemAmountExVatnumber(decimal)

ItemAmountExVat.

ItemAmountIncVatnumber(decimal)

ItemAmountIncVat.

OrderSumExVatnumber(decimal)

OrderSumExVat.

OrderSumIncVatnumber(decimal)

OrderSumIncVat.

]
Response
application/json
[
  {
    "Client": "string",
    "Application": "string",
    "PaymentService": "string",
    "PaymentMethodType": "string",
    "PaymentMethod": "string",
    "Year": 0,
    "Month": 0,
    "OrderQty": 0,
    "FreightCostExVat": 0,
    "FreightCostIncVat": 0,
    "OrderFeeExVat": 0,
    "OrderFeeIncVat": 0,
    "ItemQty": 0,
    "ItemAmountExVat": 0,
    "ItemAmountIncVat": 0,
    "OrderSumExVat": 0,
    "OrderSumIncVat": 0
  }
]

Get OrderSummaryByWeek

Request

Get OrderSummaryByWeek

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/OrderSummaryByWeek

Responses

Success

Bodyapplication/jsonArray [
Clientstring

Client. MaxLength: 100. Key property.

Applicationstring

Application. MaxLength: 50. Key property.

Yearinteger(int32)

Year. Key property.

Weekinteger(int32)

Week. Key property.

OrderQtyinteger(int32)

OrderQty.

FreightCostExVatnumber(decimal)

FreightCostExVat.

FreightCostIncVatnumber(decimal)

FreightCostIncVat.

OrderFeeExVatnumber(decimal)

OrderFeeExVat.

OrderFeeIncVatnumber(decimal)

OrderFeeIncVat.

ItemQtynumber(decimal)

ItemQty.

ItemAmountExVatnumber(decimal)

ItemAmountExVat.

ItemAmountIncVatnumber(decimal)

ItemAmountIncVat.

OrderSumExVatnumber(decimal)

OrderSumExVat.

OrderSumIncVatnumber(decimal)

OrderSumIncVat.

]
Response
application/json
[
  {
    "Client": "string",
    "Application": "string",
    "Year": 0,
    "Week": 0,
    "OrderQty": 0,
    "FreightCostExVat": 0,
    "FreightCostIncVat": 0,
    "OrderFeeExVat": 0,
    "OrderFeeIncVat": 0,
    "ItemQty": 0,
    "ItemAmountExVat": 0,
    "ItemAmountIncVat": 0,
    "OrderSumExVat": 0,
    "OrderSumIncVat": 0
  }
]

Get OrderSummaryRolling

Request

Get OrderSummaryRolling

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/OrderSummaryRolling

Responses

Success

Bodyapplication/jsonArray [
Clientstring

Client. MaxLength: 100. Key property.

Applicationstring

Application. MaxLength: 50. Key property.

OrderQtyinteger(int32)

OrderQty.

ItemQtynumber(decimal)

ItemQty.

OrderSumExVatnumber(decimal)

OrderSumExVat.

OrderSumIncVatnumber(decimal)

OrderSumIncVat.

]
Response
application/json
[
  {
    "Client": "string",
    "Application": "string",
    "OrderQty": 0,
    "ItemQty": 0,
    "OrderSumExVat": 0,
    "OrderSumIncVat": 0
  }
]

Get Subscription

Request

Get Subscription

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/Subscriptions

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

SourceIdinteger(int32)

SourceId.

DestinationIdinteger(int32)

DestinationId.

WarningMinuteCountinteger(int32)

WarningMinuteCount. Nullable.

IsActiveboolean

IsActive.

IsTestboolean

IsTest.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

PublicationsArray of objects(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionPublication)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionPublication)

Publications.

]
Response
application/json
[
  {
    "Id": 0,
    "ClientId": 0,
    "SourceId": 0,
    "DestinationId": 0,
    "WarningMinuteCount": 0,
    "IsActive": true,
    "IsTest": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Publications": [ … ]
  }
]

Get SubscriptionDestination

Request

Get SubscriptionDestination

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/SubscriptionDestinations

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

SubscriptionsArray of objects(Enferno.Storm.Query.Api.DataContexts.ReportingModel.Subscription)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.Subscription)

Subscriptions.

Culturesobject(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionDestinationCulture)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionDestinationCulture)
]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Subscriptions": [ … ],
    "Cultures": { … }
  }
]

Get SubscriptionSource

Request

Get SubscriptionSource

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/SubscriptionSources

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

GroupIdinteger(int32)

GroupId.

TypeIdinteger(int32)

TypeId.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceCulture)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceCulture)

Cultures.

SubscriptionsArray of objects(Enferno.Storm.Query.Api.DataContexts.ReportingModel.Subscription)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.Subscription)

Subscriptions.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "GroupId": 0,
    "TypeId": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ],
    "Subscriptions": [ … ]
  }
]

Get SubscriptionSourceType

Request

Get SubscriptionSourceType

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/SubscriptionSourceTypes

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

Culturesobject(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceTypeCulture)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceTypeCulture)
SourcesArray of objects(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSource)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSource)

Sources.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": { … },
    "Sources": [ … ]
  }
]

Get SubscriptionSourceGroup

Request

Get SubscriptionSourceGroup

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/SubscriptionSourceGroups

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

Culturesobject(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceGroupCulture)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceGroupCulture)
SourcesArray of objects(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSource)(Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSource)

Sources.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": { … },
    "Sources": [ … ]
  }
]

Get SC3Task

Request

Get SC3Task

curl -i -X GET \
  https://query.storm.io/Query/2.0/Reporting/Tasks

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Keystring(guid)

Key.

ClientKeystring(guid)

ClientKey.

SupplierKeystring(guid)

SupplierKey.

Namestring

Name. MaxLength: 255. Nullable.

Descriptionstring

Description. Nullable.

IsActiveboolean

IsActive.

SecretKeystring(guid)

SecretKey. Nullable.

Updatedstring(date-time)

Updated.

UpdatedByinteger(int32)

UpdatedBy.

RowIdstring

RowId. MaxLength: 8. Nullable.

HistoryArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.SC3TaskHistory)(Enferno.Storm.Query.Api.DataContexts.StormCore.SC3TaskHistory)

History.

]
Response
application/json
[
  {
    "Id": 0,
    "Key": "string",
    "ClientKey": "string",
    "SupplierKey": "string",
    "Name": "string",
    "Description": "string",
    "IsActive": true,
    "SecretKey": "string",
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "RowId": "string",
    "History": [ … ]
  }
]