Skip to content

ReferenceObject ​

Reference object controller. For testing and development purposes only. This controller is a typical CRUD controller for business objects. The implementation is based on the current development conventions. The reference objects have no meaning or use outside development or testing environments, and they should not be used in production for any business purpose.

Salaxy API v03, Finland only. 10 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 /v03/api/reference-objects ​

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: PageResultOfReferenceObjectListItem

Try it: interactive reference

POST /v03/api/reference-objects ​

Updates or creates a new object.

Request body: ReferenceObject (required)

Response: ReferenceObject

Try it: interactive reference

GET /v03/api/reference-objects/{id} ​

Gets a single object based on identier.

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: ReferenceObject

Try it: interactive reference

DELETE /v03/api/reference-objects/{id} ​

Deletes an object from the storage.

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v03/api/reference-objects/new ​

Factory method that creates a new object.

Response: ReferenceObject

Try it: interactive reference

GET /v03/api/reference-objects/delete-containers ​

Response: string

Try it: interactive reference

GET /v03/api/reference-objects/create-containers/{count} ​

ParameterInTypeRequiredDescription
countpathintegeryes

Response: string

Try it: interactive reference

GET /v03/api/reference-objects/update-containers/{count} ​

ParameterInTypeRequiredDescription
countpathintegeryes

Response: string

Try it: interactive reference

GET /v03/api/reference-objects/get-containers/{count} ​

ParameterInTypeRequiredDescription
countpathintegeryes

Response: string

Try it: interactive reference

GET /v03/api/reference-objects/find-containers/{count} ​

ParameterInTypeRequiredDescription
countpathintegeryes

Response: string

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.