Skip to content

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. 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/records ​

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

Try it: interactive reference

POST /v04/api/records ​

Updates or creates a new object

Request body: Record (required)

Response: Record

Try it: interactive reference

GET /v04/api/records/{entityType}/{entityId} ​

Lists records for employment.

ParameterInTypeRequiredDescription
entityTypepathstringyesEntity type
entityIdpathstringyesEntity id

Response: Record[]

Try it: interactive reference

GET /v04/api/records/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: Record

Try it: interactive reference

DELETE /v04/api/records/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/records/new ​

Factory method that creates a new object

Response: Record

Try it: interactive reference

GET /v04/api/records/recordTypes ​

Lists all distinct employment record types for the employer

Response: string[]

Try it: interactive reference

POST /v04/api/records/{entityType}/files ​

Saves an attachment file for the employment.

ParameterInTypeRequiredDescription
entityTypepathstringyesEntity type

Response: Attachment[]

Try it: interactive reference

POST /v04/api/records/{entityType}/{entityId}/files ​

Saves an attachment file for the employment.

ParameterInTypeRequiredDescription
entityTypepathstringyesEntity type
entityIdpathstringyesEntity id

Response: Attachment[]

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.