Skip to content

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
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/query/2.0/

Schemas

Schemas

Enferno.Storm.Query.Api.DataContexts.ReportingModel.SubscriptionSourceGroup

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.

{ "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": { "GroupId": 0, "CultureCode": "string", "Name": "string", "Description": "string", "Updated": "2019-08-24T14:15:22Z", "UpdatedBy": 0 }, "Sources": [ {} ] }

Enferno.Storm.Query.Api.DataContexts.StormCore.SC3Task

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.

{ "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": [ {} ] }

Enferno.Storm.Query.Api.DataContexts.StormCore.SC3TaskHistory

TaskIdinteger(int32)

TaskId. Key property.

Idstring

Id.

BatchIdstring(guid)

BatchId. Nullable.

ResultCodestring

ResultCode. MaxLength: 50. Nullable.

ResultMessagestring

ResultMessage. MaxLength: 500. Nullable.

ProcessStartedstring(date-time)

ProcessStarted. Nullable.

ScRowsinteger(int32)

ScRows. Nullable.

DataRowsinteger(int32)

DataRows. Nullable.

StatusMessagestring

StatusMessage. MaxLength: 500. Nullable.

Durationinteger(int32)

Duration. Nullable.

ProcessEndedstring(date-time)

ProcessEnded. Nullable.

Timestampstring(date-time)

Timestamp.

{ "TaskId": 0, "Id": "string", "BatchId": "string", "ResultCode": "string", "ResultMessage": "string", "ProcessStarted": "2019-08-24T14:15:22Z", "ScRows": 0, "DataRows": 0, "StatusMessage": "string", "Duration": 0, "ProcessEnded": "2019-08-24T14:15:22Z", "Timestamp": "2019-08-24T14:15:22Z" }

Reporting

Operations