# 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](https://code.salaxy.com/reference/rest-api-v04.md). Machine-readable: [OpenAPI document](https://code.salaxy.com/openapi/salaxy-04.json).

**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](https://code.salaxy.com/reference/errors.md).

## `GET /v04/api/usecases`

**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: `PageResultOfUsecaseListItem`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/usecases/GET/v04/api/usecases)

## `POST /v04/api/usecases`

**Updates or creates a new object**

Request body: `Usecase` (required)

Response: `Usecase`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/usecases/POST/v04/api/usecases)

## `GET /v04/api/usecases/{id}`

**Gets a single object based on identier**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Unique 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](https://code.salaxy.com/reference/rest-api-v04.md#tag/usecases/GET/v04/api/usecases/{id})

## `DELETE /v04/api/usecases/{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](https://code.salaxy.com/reference/rest-api-v04.md#tag/usecases/DELETE/v04/api/usecases/{id})

## `GET /v04/api/usecases/{id}/views/{ix}`

**Gets an html view from a usecase.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Unique 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. |
| `ix` | path | integer | yes | Index number of the view if there are several. Default is 0. |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/usecases/GET/v04/api/usecases/{id}/views/{ix})

## `GET /v04/api/usecases/new`

**Factory method that creates a new object**

Response: `Usecase`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/usecases/GET/v04/api/usecases/new)
