Skip to content

Usecases ​

Beta

Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

Views and updates usecases. Usecases are a way to define custom functionality and data for partner pusposes.

Salaxy API v04 (beta), Finland only. 6 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v04/api/usecases ​

Performs an OData query to the search index.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfUsecaseListItem

Try it: interactive reference

POST /v04/api/usecases ​

Updates or creates a new object

Request body: Usecase (required)

Response: Usecase

Try it: interactive reference

GET /v04/api/usecases/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object. The indentifier may in format id@owner if the use case is a public read-only item owned by another owner.

Response: Usecase

Try it: interactive reference

DELETE /v04/api/usecases/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/usecases/{id}/views/{ix} ​

Gets an html view from a usecase.

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object. The indentifier may in format id@owner if the use case is a public read-only item owned by another owner.
ixpathintegeryesIndex number of the view if there are several. Default is 0.

Response: string

Try it: interactive reference

GET /v04/api/usecases/new ​

Factory method that creates a new object

Response: Usecase

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.