Skip to content
STORM API
/
/
/
Request

Documentation ExposeService (1.1)

The Expose namespace has Entities and Operations common to all namespaces or things that does not fit under any other namespace.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1

Schemas

Schemas

File

Idinteger(int32)

The internal id of the File.

Typeinteger(int32)

The type id of the File. Depending on context and Client. Can be used by Applications to differentiate files for different usages.

Namestring

The Name of the File. MaxLength: 50.

Descriptionstring

The Description of the File. MaxLength: max.

Keystring or null(guid)

A unique id for the File at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

{
  "Id": 0,
  "Type": 0,
  "Name": "string",
  "Description": "string",
  "Key": "string"
}

IdNameDescription

Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Codestring

The Code of the Entity. MaxLength: 50.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "ImageKey": "string",
  "Code": "string"
}

IdValue

Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

{
  "Id": 0,
  "Value": "string",
  "Code": "string"
}

NameValue

Namestring

The Name of the Entity. MaxLength: 50.

Valuestring

The Value of the Entity. MaxLength: max.

{
  "Name": "string",
  "Value": "string"
}

Request

No response example

Response

No response example

ErrorMessages

Operations

Ping

Operations

Process

Operations