Appearance
ReferenceObject
Beta
Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.
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 v04 (beta), 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 /v04/api/reference-objects
Performs an OData query to the search index.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
$search | query | string | ||
$filter | query | string | Specifies the logic to pull back a subset of records. | |
$orderby | query | string | Specifies the values used to sort the collection of entries. | |
$select | query | string | The $select system query option allows the clients to requests a limited set of properties for each entry. | |
$top | query | number | Specifies the subset of entries by count. | |
$skip | query | number | Specifies the count of entries to skip. | |
$count | query | boolean | Indicates whether or not to include a total entry count. |
Response: PageResultOfReferenceObjectListItem
Try it: interactive reference
POST /v04/api/reference-objects
Updates or creates a new object.
Request body: ReferenceObject (required)
Response: ReferenceObject
Try it: interactive reference
GET /v04/api/reference-objects/{id}
Gets a single object based on identier.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique identifier for the object. |
Response: ReferenceObject
Try it: interactive reference
DELETE /v04/api/reference-objects/{id}
Deletes an object from the storage.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique identifier for the object. |
Response: string
Try it: interactive reference
GET /v04/api/reference-objects/new
Factory method that creates a new object.
Response: ReferenceObject
Try it: interactive reference
GET /v04/api/reference-objects/delete-containers
Response: string
Try it: interactive reference
GET /v04/api/reference-objects/create-containers/{count}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
count | path | integer | yes |
Response: string
Try it: interactive reference
GET /v04/api/reference-objects/update-containers/{count}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
count | path | integer | yes |
Response: string
Try it: interactive reference
GET /v04/api/reference-objects/get-containers/{count}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
count | path | integer | yes |
Response: string
Try it: interactive reference
GET /v04/api/reference-objects/find-containers/{count}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
count | path | integer | yes |
Response: string
Try it: interactive reference

