# 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](https://code.salaxy.com/reference/rest-api.md). Machine-readable: [OpenAPI document](https://code.salaxy.com/openapi/salaxy-03.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 /v03/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](https://code.salaxy.com/reference/rest-api.md#tag/referenceobject/GET/v03/api/reference-objects)

## `POST /v03/api/reference-objects`

**Updates or creates a new object.**

Request body: `ReferenceObject` (required)

Response: `ReferenceObject`

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

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

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

## `GET /v03/api/reference-objects/new`

**Factory method that creates a new object.**

Response: `ReferenceObject`

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

## `GET /v03/api/reference-objects/delete-containers`

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/referenceobject/GET/v03/api/reference-objects/delete-containers)

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

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `count` | path | integer | yes |  |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/referenceobject/GET/v03/api/reference-objects/create-containers/{count})

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

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `count` | path | integer | yes |  |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/referenceobject/GET/v03/api/reference-objects/update-containers/{count})

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

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `count` | path | integer | yes |  |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/referenceobject/GET/v03/api/reference-objects/get-containers/{count})

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

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `count` | path | integer | yes |  |

Response: `string`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api.md#tag/referenceobject/GET/v03/api/reference-objects/find-containers/{count})
