Skip to content

Workflow ​

Functionality to add and change workflow events for all the API objects that support workflows.

Salaxy API v03, Finland only. 4 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 /v03/api/{apiType}/{id}/workflows ​

Returns workflow data for the given API object.

ParameterInTypeRequiredDescription
apiTypepathstringyesAPI type for the object: calculations, payroll, workers
idpathstringyesUnique identifier for the API object

Response: WorkflowData

Try it: interactive reference

POST /v03/api/{apiType}/{id}/workflows ​

Adds or updates workflow event for the given API object.

ParameterInTypeRequiredDescription
apiTypepathstringyesAPI type for the object: calculations, payroll, workers
idpathstringyesUnique identifier for the API object

Request body: WorkflowEvent (required)

Response: WorkflowData

Try it: interactive reference

GET /v03/api/{apiType}/{id}/workflows/events/{eventId} ​

Returns workflow event for the given API object and event id.

ParameterInTypeRequiredDescription
apiTypepathstringyesAPI type for the object: calculations, payroll, workers
idpathstringyesUnique identifier for the API object
eventIdpathstringyesUnique id for the event.

Response: WorkflowEvent

Try it: interactive reference

DELETE /v03/api/{apiType}/{id}/workflows/{eventIdOrType} ​

Deletes the workflow event from the given API object.

ParameterInTypeRequiredDescription
apiTypepathstringyesAPI type for the object: calculations, payroll, workers
idpathstringyesUnique identifier for the API object
eventIdOrTypepathstringyesId or type of the event to delete.

Response: string

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.