# Record

**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 account and employment records.

Salaxy API v04 (beta), **Finland only**. 9 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/records`

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

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

## `POST /v04/api/records`

**Updates or creates a new object**

Request body: `Record` (required)

Response: `Record`

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

## `GET /v04/api/records/{entityType}/{entityId}`

**Lists records for employment.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `entityType` | path | string | yes | Entity type |
| `entityId` | path | string | yes | Entity id |

Response: `Record[]`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/record/GET/v04/api/records/{entityType}/{entityId})

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

**Gets a single object based on identier**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | Unique identifier for the object. |

Response: `Record`

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

## `DELETE /v04/api/records/{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/record/DELETE/v04/api/records/{id})

## `GET /v04/api/records/new`

**Factory method that creates a new object**

Response: `Record`

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

## `GET /v04/api/records/recordTypes`

**Lists all distinct employment record types for the employer**

Response: `string[]`

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

## `POST /v04/api/records/{entityType}/files`

**Saves an attachment file for the employment.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `entityType` | path | string | yes | Entity type |

Response: `Attachment[]`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/record/POST/v04/api/records/{entityType}/files)

## `POST /v04/api/records/{entityType}/{entityId}/files`

**Saves an attachment file for the employment.**

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `entityType` | path | string | yes | Entity type |
| `entityId` | path | string | yes | Entity id |

Response: `Attachment[]`

Try it: [interactive reference](https://code.salaxy.com/reference/rest-api-v04.md#tag/record/POST/v04/api/records/{entityType}/{entityId}/files)
