{ "openapi": "3.0.4", "info": { "title": "Payroll Engine Backend API v1", "description": "Payroll Engine API v0.10.0-beta.dev", "version": "1" }, "paths": { "/api/admin/application/stop": { "post": { "tags": [ "Administration" ], "operationId": "StopApplication", "responses": { "200": { "description": "OK" } } } }, "/api/admin/application/clearcache": { "post": { "tags": [ "Administration" ], "operationId": "ClearApplicationCache", "responses": { "200": { "description": "OK" } } } }, "/api/admin/reportmethods": { "get": { "tags": [ "Administration" ], "operationId": "GetApiReportMethods", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/admin/information": { "get": { "tags": [ "Administration" ], "operationId": "GetBackendInformation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackendInformation" } } } } } } }, "/api/admin": { "options": { "tags": [ "Administration" ], "operationId": "GetOptions", "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/calendars": { "get": { "tags": [ "Calendars" ], "operationId": "QueryCalendars", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Calendars" ], "operationId": "CreateCalendar", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Calendar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Calendars" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/calendars/{calendarId}": { "get": { "tags": [ "Calendars" ], "operationId": "GetCalendar", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "calendarId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Calendars" ], "operationId": "UpdateCalendar", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "calendarId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Calendar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Calendars" ], "operationId": "DeleteCalendar", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "calendarId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/calendars/period": { "get": { "tags": [ "Calendars" ], "operationId": "GetCalendarPeriod", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "calendarName", "in": "query", "schema": { "type": "string" } }, { "name": "cultureName", "in": "query", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "periodMoment", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatePeriod" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/calendars/cycle": { "get": { "tags": [ "Calendars" ], "operationId": "GetCalendarCycle", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "calendarName", "in": "query", "schema": { "type": "string" } }, { "name": "cultureName", "in": "query", "schema": { "type": "string" } }, { "name": "cycleMoment", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatePeriod" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/calendars/value": { "get": { "tags": [ "Calendars" ], "operationId": "CalculateCalendarValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "calendarName", "in": "query", "schema": { "type": "string" } }, { "name": "cultureName", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "evaluationPeriodDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number", "format": "double", "nullable": true } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}/fields": { "get": { "tags": [ "Case fields" ], "operationId": "QueryCaseFields", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Case fields" ], "operationId": "CreateCaseField", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseField" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseField" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Case fields" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}/fields/{fieldId}": { "get": { "tags": [ "Case fields" ], "operationId": "GetCaseField", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "caseFieldId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseField" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "put": { "tags": [ "Case fields" ], "operationId": "UpdateCaseField", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseField" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseField" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Case fields" ], "operationId": "DeleteCaseField", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/caserelations": { "get": { "tags": [ "Case relations" ], "operationId": "QueryCaseRelations", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Case relations" ], "operationId": "CreateCaseRelation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Case relations" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/caserelations/{relationId}": { "get": { "tags": [ "Case relations" ], "operationId": "GetCaseRelation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Case relations" ], "operationId": "UpdateCaseRelation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRelation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Case relations" ], "operationId": "DeleteCaseRelation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/caserelations/{relationId}/rebuild": { "put": { "tags": [ "Case relations" ], "operationId": "RebuildCaseRelation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/cases": { "get": { "tags": [ "Cases" ], "operationId": "QueryCases", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Cases" ], "operationId": "CreateCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Case" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Cases" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}": { "get": { "tags": [ "Cases" ], "operationId": "GetCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Cases" ], "operationId": "UpdateCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Case" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Cases" ], "operationId": "DeleteCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}/rebuild": { "put": { "tags": [ "Cases" ], "operationId": "RebuildCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/collectors": { "get": { "tags": [ "Collectors" ], "operationId": "QueryCollectors", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Collectors" ], "operationId": "CreateCollector", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collector" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Collector" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Collector" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collector" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Collectors" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/collectors/{collectorId}": { "get": { "tags": [ "Collectors" ], "operationId": "GetCollector", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "collectorId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collector" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "put": { "tags": [ "Collectors" ], "operationId": "UpdateCollector", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "collectorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collector" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Collector" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Collector" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collector" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Collectors" ], "operationId": "DeleteCollector", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "collectorId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/collectors/{collectorId}/rebuild": { "put": { "tags": [ "Collectors" ], "operationId": "RebuildCollector", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "collectorId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/companycases/changes": { "get": { "tags": [ "Company case changes" ], "operationId": "QueryCompanyCaseChanges", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Company case changes" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/companycases/changes/{caseChangeId}": { "get": { "tags": [ "Company case changes" ], "operationId": "GetCompanyCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseChangeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChange" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/companycases/changes/values": { "get": { "tags": [ "Company case changes" ], "operationId": "QueryCompanyCaseChangesValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/companycases/changes/{caseValueId}": { "delete": { "tags": [ "Company case changes" ], "operationId": "DeleteCompanyCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/companycases/{caseValueId}/documents": { "get": { "tags": [ "Company case documents" ], "operationId": "QueryCompanyCaseDocuments", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Company case documents" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/companycases/{caseValueId}/documents/{documentId}": { "get": { "tags": [ "Company case documents" ], "operationId": "GetCompanyCaseDocument", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDocument" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/companycases": { "get": { "tags": [ "Company case values" ], "operationId": "QueryCompanyCaseValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "caseFieldName", "in": "query", "schema": { "type": "string" } }, { "name": "caseName", "in": "query", "schema": { "type": "string" } }, { "name": "divisionScope", "in": "query", "schema": { "$ref": "#/components/schemas/DivisionScope" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Company case values" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/companycases/slots": { "get": { "tags": [ "Company case values" ], "operationId": "GetCompanyCaseValueSlots", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/tenants/{tenantId}/companycases/{caseValueId}": { "get": { "tags": [ "Company case values" ], "operationId": "GetCompanyCaseValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/divisions": { "get": { "tags": [ "Divisions" ], "operationId": "QueryDivisions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Divisions" ], "operationId": "CreateDivision", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Division" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Division" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Division" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Division" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Divisions" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/divisions/{divisionId}": { "get": { "tags": [ "Divisions" ], "operationId": "GetDivision", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Division" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Divisions" ], "operationId": "UpdateDivision", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Division" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Division" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Division" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Division" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Divisions" ], "operationId": "DeleteDivision", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}": { "get": { "tags": [ "Divisions" ], "operationId": "GetDivisionAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Divisions" ], "operationId": "SetDivisionAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Divisions" ], "operationId": "DeleteDivisionAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/changes": { "get": { "tags": [ "Employee case changes" ], "operationId": "QueryEmployeeCaseChanges", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Employee case changes" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/changes/{caseChangeId}": { "get": { "tags": [ "Employee case changes" ], "operationId": "GetEmployeeCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseChangeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChange" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/changes/values": { "get": { "tags": [ "Employee case changes" ], "operationId": "QueryEmployeeCaseChangesValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/changes/{caseValueId}": { "delete": { "tags": [ "Employee case changes" ], "operationId": "DeleteEmployeeCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/{caseValueId}/documents": { "get": { "tags": [ "Employee case documents" ], "operationId": "QueryEmployeeCaseDocuments", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Employee case documents" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/{caseValueId}/documents/{documentId}": { "get": { "tags": [ "Employee case documents" ], "operationId": "GetEmployeeCaseDocument", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDocument" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases": { "get": { "tags": [ "Employee case values" ], "operationId": "QueryEmployeeCaseValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "caseFieldName", "in": "query", "schema": { "type": "string" } }, { "name": "caseName", "in": "query", "schema": { "type": "string" } }, { "name": "divisionScope", "in": "query", "schema": { "$ref": "#/components/schemas/DivisionScope" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Employee case values" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/slots": { "get": { "tags": [ "Employee case values" ], "operationId": "GetEmployeeCaseValueSlots", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/cases/{caseValueId}": { "get": { "tags": [ "Employee case values" ], "operationId": "GetEmployeeCaseValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/employees": { "get": { "tags": [ "Employees" ], "operationId": "QueryEmployees", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Employees" ], "operationId": "CreateEmployee", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Employees" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/employees/{employeeId}": { "get": { "tags": [ "Employees" ], "operationId": "GetEmployee", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Employees" ], "operationId": "UpdateEmployee", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Employees" ], "operationId": "DeleteEmployee", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/employees/bulk": { "post": { "tags": [ "Employees" ], "operationId": "CreateEmployeesBulk", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/employees/{employeeId}/attributes/{attributeName}": { "get": { "tags": [ "Employees" ], "operationId": "GetEmployeeAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Employees" ], "operationId": "SetEmployeeAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Employees" ], "operationId": "DeleteEmployeeAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/globalcases/changes": { "get": { "tags": [ "Global case changes" ], "operationId": "QueryGlobalCaseChanges", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Global case changes" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/globalcases/changes/{caseChangeId}": { "get": { "tags": [ "Global case changes" ], "operationId": "GetGlobalCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseChangeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChange" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/globalcases/changes/values": { "get": { "tags": [ "Global case changes" ], "operationId": "QueryGlobalCaseChangesValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/globalcases/changes/{caseValueId}": { "delete": { "tags": [ "Global case changes" ], "operationId": "DeleteGlobalCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/globalcases/{caseValueId}/documents": { "get": { "tags": [ "Global case documents" ], "operationId": "QueryGlobalCaseDocuments", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Global case documents" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/globalcases/{caseValueId}/documents/{documentId}": { "get": { "tags": [ "Global case documents" ], "operationId": "GetGlobalCaseDocument", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDocument" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/globalcases": { "get": { "tags": [ "Global case values" ], "operationId": "QueryGlobalCaseValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "caseFieldName", "in": "query", "schema": { "type": "string" } }, { "name": "caseName", "in": "query", "schema": { "type": "string" } }, { "name": "divisionScope", "in": "query", "schema": { "$ref": "#/components/schemas/DivisionScope" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Global case values" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/globalcases/slots": { "get": { "tags": [ "Global case values" ], "operationId": "GetGlobalCaseValueSlots", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/tenants/{tenantId}/globalcases/{caseValueId}": { "get": { "tags": [ "Global case values" ], "operationId": "GetGlobalCaseValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/logs": { "get": { "tags": [ "Logs" ], "operationId": "QueryLogs", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Logs" ], "operationId": "CreateLog", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Log" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Log" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Logs" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/logs/{logId}": { "get": { "tags": [ "Logs" ], "operationId": "GetLog", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Logs" ], "operationId": "DeleteLog", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups/{lookupId}/values": { "get": { "tags": [ "Lookup values" ], "operationId": "QueryLookupValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Lookup values" ], "operationId": "CreateLookupValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LookupValue" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Lookup values" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups/{lookupId}/values/data": { "get": { "tags": [ "Lookup values" ], "operationId": "GetLookupValuesData", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupValueData" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups/{lookupId}/values/{lookupValueId}": { "get": { "tags": [ "Lookup values" ], "operationId": "GetLookupValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Lookup values" ], "operationId": "UpdateLookupValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupValueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LookupValue" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Lookup values" ], "operationId": "DeleteLookupValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups": { "get": { "tags": [ "Lookups" ], "operationId": "QueryLookups", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Lookups" ], "operationId": "CreateLookup", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Lookup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Lookup" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Lookups" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups/{lookupId}": { "get": { "tags": [ "Lookups" ], "operationId": "GetLookup", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Lookups" ], "operationId": "UpdateLookup", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Lookup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Lookup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Lookups" ], "operationId": "DeleteLookup", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups/sets": { "get": { "tags": [ "Lookups" ], "operationId": "QueryLookupSets", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Lookups" ], "operationId": "CreateLookupSets", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupSet" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupSet" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupSet" } } } } }, "responses": { "201": { "description": "Created" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/lookups/sets/{lookupId}": { "get": { "tags": [ "Lookups" ], "operationId": "GetLookupSet", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupSet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Lookups" ], "operationId": "DeleteLookupSet", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/nationalcases/changes": { "get": { "tags": [ "National case changes" ], "operationId": "QueryNationalCaseChanges", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "National case changes" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/nationalcases/changes/{caseChangeId}": { "get": { "tags": [ "National case changes" ], "operationId": "GetNationalCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseChangeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChange" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/nationalcases/changes/values": { "get": { "tags": [ "National case changes" ], "operationId": "QueryNationalCaseChangesValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/nationalcases/changes/{caseValueId}": { "delete": { "tags": [ "National case changes" ], "operationId": "DeleteNationalCaseChange", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/nationalcases/{caseValueId}/documents": { "get": { "tags": [ "National case documents" ], "operationId": "QueryNationalCaseDocuments", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "National case documents" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/nationalcases/{caseValueId}/documents/{documentId}": { "get": { "tags": [ "National case documents" ], "operationId": "GetNationalCaseDocument", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDocument" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/nationalcases": { "get": { "tags": [ "National case values" ], "operationId": "QueryNationalCaseValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "caseFieldName", "in": "query", "schema": { "type": "string" } }, { "name": "caseName", "in": "query", "schema": { "type": "string" } }, { "name": "divisionScope", "in": "query", "schema": { "$ref": "#/components/schemas/DivisionScope" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "National case values" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/nationalcases/slots": { "get": { "tags": [ "National case values" ], "operationId": "GetNationalCaseValueSlots", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/tenants/{tenantId}/nationalcases/{caseValueId}": { "get": { "tags": [ "National case values" ], "operationId": "GetNationalCaseValue", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseValueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseValue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/consolidated": { "get": { "tags": [ "Payroll consolidated results" ], "operationId": "GetConsolidatedPayrollResult", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "periodStart", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "periodEnd", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "forecast", "in": "query", "schema": { "type": "string" } }, { "name": "jobStatus", "in": "query", "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsolidatedPayrollResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "options": { "tags": [ "Payroll consolidated results" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payrollresults/consolidated/collectors": { "get": { "tags": [ "Payroll consolidated results" ], "operationId": "GetConsolidatedCollectorResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "periodStarts", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "date-time" } } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "collectorNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "forecast", "in": "query", "schema": { "type": "string" } }, { "name": "jobStatus", "in": "query", "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectorResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/consolidated/wagetypes": { "get": { "tags": [ "Payroll consolidated results" ], "operationId": "GetConsolidatedWageTypeResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "periodStarts", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "date-time" } } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "forecast", "in": "query", "schema": { "type": "string" } }, { "name": "jobStatus", "in": "query", "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "wageTypeNumbers", "in": "query", "schema": { "type": "array", "items": { "type": "number", "format": "double" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WageTypeResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/consolidated/payruns": { "get": { "tags": [ "Payroll consolidated results" ], "operationId": "GetConsolidatedPayrunResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "periodStarts", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "date-time" } } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "forecast", "in": "query", "schema": { "type": "string" } }, { "name": "jobStatus", "in": "query", "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } }, { "name": "resultNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/layers": { "get": { "tags": [ "Payroll layers" ], "operationId": "QueryPayrollLayers", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Payroll layers" ], "operationId": "CreatePayrollLayer", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Payroll layers" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/layers/{layerId}": { "get": { "tags": [ "Payroll layers" ], "operationId": "GetPayrollLayer", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Payroll layers" ], "operationId": "UpdatePayrollLayer", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollLayer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payroll layers" ], "operationId": "DeletePayrollLayer", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/layers/{layerId}/attributes/{attributeName}": { "get": { "tags": [ "Payroll layers" ], "operationId": "GetPayrollLayerAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Payroll layers" ], "operationId": "SetPayrollLayerAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payroll layers" ], "operationId": "DeletePayrollLayerAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/payrollresults": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryPayrollResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Payroll results" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payrollresults/{payrollResultId}": { "get": { "tags": [ "Payroll results" ], "operationId": "GetPayrollResult", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/{payrollResultId}/collectors": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryCollectorResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectorResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/{payrollResultId}/collectors/{collectorResultId}/custom": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryCollectorCustomResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "collectorResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectorCustomResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/{payrollResultId}/wagetypes": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryWageTypeResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WageTypeResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/{payrollResultId}/wagetypes/{wageTypeResultId}/custom": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryWageTypeCustomResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "wageTypeResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WageTypeCustomResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/{payrollResultId}/payruns": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryPayrunResults", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/values": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryPayrollResultValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/sets": { "get": { "tags": [ "Payroll results" ], "operationId": "QueryPayrollResultSets", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollResultSet" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrollresults/sets/{payrollResultId}": { "get": { "tags": [ "Payroll results" ], "operationId": "GetPayrollResultSet", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollResultSet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls": { "get": { "tags": [ "Payrolls" ], "operationId": "QueryPayrolls", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Payrolls" ], "operationId": "CreatePayroll", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Payroll" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Payroll" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Payrolls" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayroll", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Payrolls" ], "operationId": "UpdatePayroll", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Payroll" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Payroll" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payrolls" ], "operationId": "DeletePayroll", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/regulations": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollRegulations", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Regulation" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases/available": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollAvailableCases", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CaseType" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "caseNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "hidden", "in": "query", "schema": { "type": "boolean" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Case" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases/build/{caseName}": { "post": { "tags": [ "Payrolls" ], "operationId": "BuildPayrollCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChangeSetup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseChangeSetup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseChangeSetup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseSet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/changes/values": { "get": { "tags": [ "Payrolls" ], "operationId": "QueryPayrollCaseChangeValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CaseType" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "excludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollCaseValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "caseSlot", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseFieldValue" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/time": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollTimeCaseValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "caseType", "in": "query", "schema": { "$ref": "#/components/schemas/CaseType" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "valueDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseValue" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/periods": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollAvailableCaseFieldValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldNames", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseFieldValue" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases": { "post": { "tags": [ "Payrolls" ], "operationId": "AddPayrollCase", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChangeSetup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseChangeSetup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseChangeSetup" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChange" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollCases", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "caseType", "in": "query", "schema": { "$ref": "#/components/schemas/CaseType" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Case" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/cases/bulk": { "post": { "tags": [ "Payrolls" ], "operationId": "AddPayrollCasesBulk", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChangeSetup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChangeSetup" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChangeSetup" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/casefields": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollCaseFields", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseField" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/caserelations": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollCaseRelations", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sourceCaseName", "in": "query", "schema": { "type": "string" } }, { "name": "targetCaseName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRelation" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypes": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollWageTypes", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "wageTypeNumbers", "in": "query", "schema": { "type": "array", "items": { "type": "number", "format": "double" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WageType" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/collectors": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollCollectors", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "collectorNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Collector" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/lookups": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollLookups", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "lookupNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollLookupValues", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "lookupKeys", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "lookupNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupValue" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/data": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollLookupData", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupNames", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupData" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values/data": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollLookupValueData", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "lookupKey", "in": "query", "schema": { "type": "string" } }, { "name": "rangeValue", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupValueData" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/ranges": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollLookupRanges", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lookupNames", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "rangeValue", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRangeResult" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/reports": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollReports", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clusterSetName", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "reportNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "userType", "in": "query", "schema": { "$ref": "#/components/schemas/UserType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSet" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/reports/parameters": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollReportParameters", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "reportNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameter" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/reports/templates": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollReportTemplates", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "reportNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTemplate" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/scripts": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollScripts", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "scriptNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Script" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/actions": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollScriptActions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "evaluationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "functionType", "in": "query", "schema": { "$ref": "#/components/schemas/FunctionType" } }, { "name": "overrideType", "in": "query", "schema": { "$ref": "#/components/schemas/OverrideType" } }, { "name": "regulationDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "scriptNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInfo" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payrolls/{payrollId}/attributes/{attributeName}": { "get": { "tags": [ "Payrolls" ], "operationId": "GetPayrollAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Payrolls" ], "operationId": "SetPayrollAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payrolls" ], "operationId": "DeletePayrollAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/payruns/jobs": { "get": { "tags": [ "Payrun jobs" ], "operationId": "QueryPayrunJobs", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Payrun jobs" ], "operationId": "StartPayrunJob", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunJobInvocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrunJobInvocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrunJobInvocation" } } } }, "responses": { "202": { "description": "Accepted" }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Payrun jobs" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payruns/jobs/employees/{employeeId}": { "get": { "tags": [ "Payrun jobs" ], "operationId": "QueryEmployeePayrunJobs", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}": { "get": { "tags": [ "Payrun jobs" ], "operationId": "GetPayrunJob", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunJob" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Payrun jobs" ], "operationId": "DeletePayrunJob", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payruns/jobs/import": { "post": { "tags": [ "Payrun jobs" ], "operationId": "ImportPayrunJobSets", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunJobSet" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunJobSet" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunJobSet" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/payruns/jobs/preview": { "post": { "tags": [ "Payrun jobs" ], "operationId": "PreviewPayrunJob", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunJobInvocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrunJobInvocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrunJobInvocation" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollResultSet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/status": { "get": { "tags": [ "Payrun jobs" ], "operationId": "GetPayrunJobStatus", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Payrun jobs" ], "operationId": "ChangePayrunJobStatus", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reason", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "patchMode", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrunJobStatus" } } } }, "responses": { "201": { "description": "Created" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/attributes/{attributeName}": { "get": { "tags": [ "Payrun jobs" ], "operationId": "GetPayrunJobAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Payrun jobs" ], "operationId": "SetPayrunJobAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payrun jobs" ], "operationId": "DeletePayrunJobAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunJobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/payruns/{payrunId}/parameters": { "get": { "tags": [ "Payrun parameters" ], "operationId": "QueryPayrunParameters", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Payrun parameters" ], "operationId": "CreatePayrunParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Payrun parameters" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payruns/{payrunId}/parameters/{parameterId}": { "get": { "tags": [ "Payrun parameters" ], "operationId": "GetPayrunParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Payrun parameters" ], "operationId": "UpdatePayrunParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrunParameter" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payrun parameters" ], "operationId": "DeletePayrunParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payruns": { "get": { "tags": [ "Payruns" ], "operationId": "QueryPayruns", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Payruns" ], "operationId": "CreatePayrun", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payrun" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Payrun" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Payrun" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payrun" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Payruns" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payruns/{payrunId}": { "get": { "tags": [ "Payruns" ], "operationId": "GetPayrun", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payrun" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Payruns" ], "operationId": "UpdatePayrun", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payrun" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Payrun" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Payrun" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payrun" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Payruns" ], "operationId": "DeletePayrun", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/payruns/{payrunId}/rebuild": { "put": { "tags": [ "Payruns" ], "operationId": "RebuildPayrun", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "payrunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations": { "get": { "tags": [ "Regulations" ], "operationId": "QueryRegulations", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Regulations" ], "operationId": "CreateRegulation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regulation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Regulation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Regulation" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regulation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Regulations" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}": { "get": { "tags": [ "Regulations" ], "operationId": "GetRegulation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regulation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Regulations" ], "operationId": "UpdateRegulation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regulation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Regulation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Regulation" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regulation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Regulations" ], "operationId": "DeleteRegulation", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/cases/{caseFieldName}": { "get": { "tags": [ "Regulations" ], "operationId": "GetCaseOfCaseField", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "caseFieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/attributes/{attributeName}": { "get": { "tags": [ "Regulations" ], "operationId": "GetRegulationAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Regulations" ], "operationId": "SetRegulationAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Regulations" ], "operationId": "DeleteRegulationAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/reportlogs": { "get": { "tags": [ "Report logs" ], "operationId": "QueryReportLogs", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Report logs" ], "operationId": "CreateReportLog", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportLog" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportLog" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Report logs" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/reportlogs/{logId}": { "get": { "tags": [ "Report logs" ], "operationId": "GetReportLog", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportLog" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Report logs" ], "operationId": "DeleteReportLog", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/parameters": { "get": { "tags": [ "Report parameters" ], "operationId": "QueryReportParameters", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Report parameters" ], "operationId": "CreateReportParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Report parameters" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/parameters/{parameterId}": { "get": { "tags": [ "Report parameters" ], "operationId": "GetReportParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Report parameters" ], "operationId": "UpdateReportParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameter" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Report parameters" ], "operationId": "DeleteReportParameter", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/templates": { "get": { "tags": [ "Report templates" ], "operationId": "QueryReportTemplates", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "excludeContent", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Report templates" ], "operationId": "CreateReportTemplate", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Report templates" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/templates/{templateId}": { "get": { "tags": [ "Report templates" ], "operationId": "GetReportTemplate", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Report templates" ], "operationId": "UpdateReportTemplate", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Report templates" ], "operationId": "DeleteReportTemplate", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports": { "get": { "tags": [ "Reports" ], "operationId": "QueryReports", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Reports" ], "operationId": "CreateReport", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Report" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Reports" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}": { "get": { "tags": [ "Reports" ], "operationId": "GetReport", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Reports" ], "operationId": "UpdateReport", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Report" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Reports" ], "operationId": "DeleteReport", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/execute": { "post": { "tags": [ "Reports" ], "operationId": "ExecuteReport", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/sets/{reportId}": { "post": { "tags": [ "Reports" ], "operationId": "GetReportSet", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Reports" ], "operationId": "DeleteReportSet", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/sets": { "post": { "tags": [ "Reports" ], "operationId": "CreateReportSet", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportSet" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportSet" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSet" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/rebuild": { "put": { "tags": [ "Reports" ], "operationId": "RebuildReport", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/attributes/{attributeName}": { "get": { "tags": [ "Reports" ], "operationId": "GetReportAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Reports" ], "operationId": "SetReportAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Reports" ], "operationId": "DeleteReportAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/scripts": { "get": { "tags": [ "Scripts" ], "operationId": "QueryScripts", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Scripts" ], "operationId": "CreateScript", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Script" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Scripts" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/scripts/{scriptId}": { "get": { "tags": [ "Scripts" ], "operationId": "GetScript", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Scripts" ], "operationId": "UpdateScript", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Script" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Script" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Scripts" ], "operationId": "DeleteScript", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/tasks": { "get": { "tags": [ "Tasks" ], "operationId": "QueryTasks", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Tasks" ], "operationId": "CreateTask", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Tasks" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "operationId": "GetTask", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Tasks" ], "operationId": "UpdateTask", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Tasks" ], "operationId": "DeleteTask", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/tasks/{taskId}/attributes/{attributeName}": { "get": { "tags": [ "Tasks" ], "operationId": "GetTaskAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Tasks" ], "operationId": "SetTaskAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Tasks" ], "operationId": "DeleteTaskAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants": { "get": { "tags": [ "Tenants" ], "operationId": "QueryTenants", "parameters": [ { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Tenants" ], "operationId": "CreateTenant", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Tenant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Tenants" ], "operationId": "GetOptions", "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}": { "put": { "tags": [ "Tenants" ], "operationId": "UpdateTenant", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Tenant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Tenants" ], "operationId": "DeleteTenant", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Tenants" ], "operationId": "GetTenant", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/shared/regulations": { "get": { "tags": [ "Tenants" ], "operationId": "GetTenantSharedRegulations", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Regulation" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/system/actions": { "get": { "tags": [ "Tenants" ], "operationId": "GetSystemScriptActions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "functionType", "in": "query", "schema": { "$ref": "#/components/schemas/FunctionType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInfo" } } } } } } } }, "/api/tenants/{tenantId}/system/properties": { "get": { "tags": [ "Tenants" ], "operationId": "GetSystemScriptActionProperties", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "functionType", "in": "query", "schema": { "$ref": "#/components/schemas/FunctionType" } }, { "name": "readOnly", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInfo" } } } } } } } }, "/api/tenants/{tenantId}/queries": { "post": { "tags": [ "Tenants" ], "operationId": "ExecuteReportQuery", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "methodName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/attributes/{attributeName}": { "get": { "tags": [ "Tenants" ], "operationId": "GetTenantAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Tenants" ], "operationId": "SetTenantAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Tenants" ], "operationId": "DeleteTenantAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/users": { "get": { "tags": [ "Users" ], "operationId": "QueryUsers", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Users" ], "operationId": "CreateUser", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Users" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/users/{userId}": { "get": { "tags": [ "Users" ], "operationId": "GetUser", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Users" ], "operationId": "UpdateUser", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Users" ], "operationId": "DeleteUser", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/users/{userId}/password": { "post": { "tags": [ "Users" ], "operationId": "TestUserPassword", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Users" ], "operationId": "UpdateUserPassword", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PasswordChangeRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } } }, "/api/tenants/{tenantId}/users/{userId}/attributes/{attributeName}": { "get": { "tags": [ "Users" ], "operationId": "GetUserAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Users" ], "operationId": "SetUserAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Users" ], "operationId": "DeleteUserAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/wagetypes": { "get": { "tags": [ "Wage types" ], "operationId": "QueryWageTypes", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Wage types" ], "operationId": "CreateWageType", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WageType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WageType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WageType" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WageType" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Wage types" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/wagetypes/{wageTypeId}": { "get": { "tags": [ "Wage types" ], "operationId": "GetWageType", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "wageTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WageType" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Wage types" ], "operationId": "UpdateWageType", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "wageTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WageType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WageType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WageType" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WageType" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Wage types" ], "operationId": "DeleteWageType", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "wageTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/regulations/{regulationId}/wagetypes/{wageTypeId}/rebuild": { "put": { "tags": [ "Wage types" ], "operationId": "RebuildWageType", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "regulationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "wageTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tenants/{tenantId}/webhooks/{webhookId}/messages": { "get": { "tags": [ "Webhook messages" ], "operationId": "QueryWebhookMessages", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Webhook messages" ], "operationId": "CreateWebhookMessage", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Webhook messages" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/webhooks/{webhookId}/messages/{webhookMessageId}": { "get": { "tags": [ "Webhook messages" ], "operationId": "GetWebhookMessage", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Webhook messages" ], "operationId": "UpdateWebhookMessage", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookMessageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Webhook messages" ], "operationId": "DeleteWebhookMessage", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/webhooks": { "get": { "tags": [ "Webhooks" ], "operationId": "QueryWebhooks", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apply", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "$ref": "#/components/schemas/QueryResultType" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ObjectStatus" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "post": { "tags": [ "Webhooks" ], "operationId": "CreateWebhook", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "options": { "tags": [ "Webhooks" ], "operationId": "GetOptions", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/webhooks/{webhookId}": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhook", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Webhooks" ], "operationId": "UpdateWebhook", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Webhooks" ], "operationId": "DeleteWebhook", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tenants/{tenantId}/webhooks/{webhookId}/attributes/{attributeName}": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhookAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Webhooks" ], "operationId": "SetWebhookAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelStateEntry" } } } } } } }, "delete": { "tags": [ "Webhooks" ], "operationId": "DeleteWebhookAttribute", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } } }, "components": { "schemas": { "ActionInfo": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "functionType": { "$ref": "#/components/schemas/FunctionType" }, "namespace": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "source": { "$ref": "#/components/schemas/ActionSource" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ActionParameterInfo" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ActionIssueInfo" }, "nullable": true } }, "additionalProperties": false }, "ActionIssueInfo": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "message": { "type": "string", "nullable": true }, "parameterCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ActionParameterInfo": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "valueTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueSources": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueReferences": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ActionSource": { "enum": [ "Script", "System" ], "type": "string" }, "Assembly": { "type": "object", "properties": { "definedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "exportedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "codeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "entryPoint": { "$ref": "#/components/schemas/MethodInfo" }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "imageRuntimeVersion": { "type": "string", "nullable": true, "readOnly": true }, "isDynamic": { "type": "boolean", "readOnly": true }, "location": { "type": "string", "nullable": true, "readOnly": true }, "reflectionOnly": { "type": "boolean", "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "isFullyTrusted": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "escapedCodeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "manifestModule": { "$ref": "#/components/schemas/Module" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true, "readOnly": true }, "globalAssemblyCache": { "type": "boolean", "readOnly": true, "deprecated": true }, "hostContext": { "type": "integer", "format": "int64", "readOnly": true }, "securityRuleSet": { "$ref": "#/components/schemas/SecurityRuleSet" } }, "additionalProperties": false }, "BackendAuditTrailInformation": { "type": "object", "properties": { "script": { "type": "boolean" }, "lookup": { "type": "boolean" }, "input": { "type": "boolean" }, "payrun": { "type": "boolean" }, "report": { "type": "boolean" } }, "additionalProperties": false }, "BackendAuthInformation": { "type": "object", "properties": { "mode": { "type": "string", "nullable": true }, "oAuthAuthority": { "type": "string", "nullable": true }, "oAuthAudience": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackendCorsInformation": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BackendDatabaseInformation": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "edition": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackendInformation": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "buildDate": { "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "nullable": true }, "apiName": { "type": "string", "nullable": true }, "authentication": { "$ref": "#/components/schemas/BackendAuthInformation" }, "database": { "$ref": "#/components/schemas/BackendDatabaseInformation" }, "runtime": { "$ref": "#/components/schemas/BackendRuntimeInformation" } }, "additionalProperties": false }, "BackendRateLimitingInformation": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "globalPermitLimit": { "type": "integer", "format": "int32" }, "globalWindowSeconds": { "type": "integer", "format": "int32" }, "payrunJobStartPermitLimit": { "type": "integer", "format": "int32" }, "payrunJobStartWindowSeconds": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BackendRuntimeInformation": { "type": "object", "properties": { "maxParallelEmployees": { "type": "integer", "format": "int32" }, "maxRetroPayrunPeriods": { "type": "integer", "format": "int32" }, "dbCommandTimeoutSeconds": { "type": "integer", "format": "int32" }, "dbTransactionTimeoutSeconds": { "type": "integer", "format": "int32" }, "assemblyCacheTimeoutSeconds": { "type": "integer", "format": "int32" }, "webhookTimeoutSeconds": { "type": "integer", "format": "int32" }, "scriptSafetyAnalysis": { "type": "boolean" }, "auditTrail": { "$ref": "#/components/schemas/BackendAuditTrailInformation" }, "cors": { "$ref": "#/components/schemas/BackendCorsInformation" }, "rateLimiting": { "$ref": "#/components/schemas/BackendRateLimitingInformation" }, "tenantIsolationLevel": { "$ref": "#/components/schemas/TenantIsolationLevel" } }, "additionalProperties": false }, "Calendar": { "required": [ "cycleTimeUnit", "name", "periodTimeUnit" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "cycleTimeUnit": { "$ref": "#/components/schemas/CalendarTimeUnit" }, "periodTimeUnit": { "$ref": "#/components/schemas/CalendarTimeUnit" }, "timeMap": { "$ref": "#/components/schemas/CalendarTimeMap" }, "firstMonthOfYear": { "$ref": "#/components/schemas/Month" }, "periodDayCount": { "type": "number", "format": "double", "nullable": true }, "yearWeekRule": { "$ref": "#/components/schemas/CalendarWeekRule" }, "firstDayOfWeek": { "$ref": "#/components/schemas/DayOfWeek" }, "weekMode": { "$ref": "#/components/schemas/CalendarWeekMode" }, "workMonday": { "type": "boolean" }, "workTuesday": { "type": "boolean" }, "workWednesday": { "type": "boolean" }, "workThursday": { "type": "boolean" }, "workFriday": { "type": "boolean" }, "workSaturday": { "type": "boolean" }, "workSunday": { "type": "boolean" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CalendarTimeMap": { "enum": [ "Period", "Cycle" ], "type": "string" }, "CalendarTimeUnit": { "enum": [ "Year", "SemiYear", "Quarter", "BiMonth", "CalendarMonth", "LunisolarMonth", "SemiMonth", "BiWeek", "Week" ], "type": "string" }, "CalendarWeekMode": { "enum": [ "Week", "WorkWeek" ], "type": "string" }, "CalendarWeekRule": { "enum": [ "FirstDay", "FirstFullWeek", "FirstFourDayWeek" ], "type": "string" }, "CallingConventions": { "enum": [ 1, 2, 3, 32, 64 ], "type": "integer", "format": "int32" }, "Case": { "required": [ "caseType", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "caseType": { "$ref": "#/components/schemas/CaseType" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "nameSynonyms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "defaultReason": { "type": "string", "nullable": true }, "defaultReasonLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "baseCase": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "baseCaseFields": { "type": "array", "items": { "$ref": "#/components/schemas/CaseFieldReference" }, "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "cancellationType": { "$ref": "#/components/schemas/CaseCancellationType" }, "hidden": { "type": "boolean" }, "availableExpression": { "type": "string", "nullable": true }, "buildExpression": { "type": "string", "nullable": true }, "validateExpression": { "type": "string", "nullable": true }, "lookups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "slots": { "type": "array", "items": { "$ref": "#/components/schemas/CaseSlot" }, "nullable": true }, "availableActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "buildActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "validateActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CaseCancellationType": { "enum": [ "None", "Case" ], "type": "string" }, "CaseChange": { "required": [ "userId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "cancellationType": { "$ref": "#/components/schemas/CaseCancellationType" }, "cancellationId": { "type": "integer", "format": "int32", "nullable": true }, "cancellationDate": { "type": "string", "format": "date-time", "nullable": true }, "reason": { "type": "string", "nullable": true }, "validationCaseName": { "type": "string", "nullable": true }, "forecast": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/CaseValue" }, "nullable": true }, "ignoredValues": { "type": "array", "items": { "$ref": "#/components/schemas/CaseValue" }, "nullable": true } }, "additionalProperties": false }, "CaseChangeSetup": { "required": [ "case", "userId" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "cancellationId": { "type": "integer", "format": "int32", "nullable": true }, "forecast": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "reason": { "type": "string", "nullable": true }, "case": { "$ref": "#/components/schemas/CaseSetup" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/CaseValidationIssue" }, "nullable": true } }, "additionalProperties": false }, "CaseDocument": { "required": [ "content", "contentType", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "minLength": 1, "type": "string" }, "content": { "minLength": 1, "type": "string" }, "contentType": { "maxLength": 128, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "CaseField": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "valueScope": { "$ref": "#/components/schemas/ValueScope" }, "timeType": { "$ref": "#/components/schemas/CaseFieldTimeType" }, "timeUnit": { "$ref": "#/components/schemas/CaseFieldTimeUnit" }, "periodAggregation": { "$ref": "#/components/schemas/CaseFieldAggregationType" }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "cancellationMode": { "$ref": "#/components/schemas/CaseFieldCancellationMode" }, "valueCreationMode": { "$ref": "#/components/schemas/CaseValueCreationMode" }, "culture": { "type": "string", "nullable": true }, "valueMandatory": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "startDateType": { "$ref": "#/components/schemas/CaseFieldDateType" }, "endDateType": { "$ref": "#/components/schemas/CaseFieldDateType" }, "endMandatory": { "type": "boolean" }, "defaultStart": { "type": "string", "nullable": true }, "defaultEnd": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lookupSettings": { "$ref": "#/components/schemas/LookupSettings" }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "valueAttributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CaseFieldAggregationType": { "enum": [ "Summary", "Last", "First" ], "type": "string" }, "CaseFieldCancellationMode": { "enum": [ "TimeType", "Previous", "Keep", "Reset", "Invert" ], "type": "string" }, "CaseFieldDateType": { "enum": [ "Day", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Month", "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December", "Year", "PeriodStart", "PeriodStartDate", "PeriodEnd", "PeriodEndDate", "CycleStart", "CycleStartDate", "CycleEnd", "CycleEndDate" ], "type": "string" }, "CaseFieldReference": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CaseFieldSet": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "valueScope": { "$ref": "#/components/schemas/ValueScope" }, "timeType": { "$ref": "#/components/schemas/CaseFieldTimeType" }, "timeUnit": { "$ref": "#/components/schemas/CaseFieldTimeUnit" }, "periodAggregation": { "$ref": "#/components/schemas/CaseFieldAggregationType" }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "cancellationMode": { "$ref": "#/components/schemas/CaseFieldCancellationMode" }, "valueCreationMode": { "$ref": "#/components/schemas/CaseValueCreationMode" }, "culture": { "type": "string", "nullable": true }, "valueMandatory": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "startDateType": { "$ref": "#/components/schemas/CaseFieldDateType" }, "endDateType": { "$ref": "#/components/schemas/CaseFieldDateType" }, "endMandatory": { "type": "boolean" }, "defaultStart": { "type": "string", "nullable": true }, "defaultEnd": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lookupSettings": { "$ref": "#/components/schemas/LookupSettings" }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "valueAttributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "displayName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "value": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "cancellationDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CaseFieldTimeType": { "enum": [ "Timeless", "Moment", "Period", "CalendarPeriod" ], "type": "string" }, "CaseFieldTimeUnit": { "enum": [ "Day", "HalfDay", "Month" ], "type": "string" }, "CaseFieldValue": { "required": [ "caseFieldName", "value" ], "type": "object", "properties": { "caseFieldName": { "minLength": 1, "type": "string" }, "caseFieldNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "created": { "type": "string", "format": "date-time" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "minLength": 1, "type": "string" }, "cancellationDate": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CaseIssueType": { "enum": [ "Unknown", "CaseInvalid", "CaseUnknown", "CaseRelationInvalid", "CaseFieldDuplicated", "CaseValueIncomplete", "CaseValueMissing", "CaseValueStartInvalid", "CaseValueEndInvalid", "CaseValueEndMissing", "CaseValueWeekdayInvalid", "CaseValueMonthInvalid" ], "type": "string" }, "CaseRelation": { "required": [ "sourceCaseName", "targetCaseName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "sourceCaseName": { "maxLength": 128, "minLength": 0, "type": "string" }, "sourceCaseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "sourceCaseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "sourceCaseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "targetCaseName": { "maxLength": 128, "minLength": 0, "type": "string" }, "targetCaseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "targetCaseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "targetCaseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "buildExpression": { "type": "string", "nullable": true }, "validateExpression": { "type": "string", "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "order": { "type": "integer", "format": "int32" }, "buildActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "validateActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CaseRelationReference": { "type": "object", "properties": { "sourceCaseName": { "type": "string", "nullable": true }, "sourceCaseSlot": { "type": "string", "nullable": true }, "targetCaseName": { "type": "string", "nullable": true }, "targetCaseSlot": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CaseSet": { "required": [ "caseType", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "caseType": { "$ref": "#/components/schemas/CaseType" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "nameSynonyms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "defaultReason": { "type": "string", "nullable": true }, "defaultReasonLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "baseCase": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "baseCaseFields": { "type": "array", "items": { "$ref": "#/components/schemas/CaseFieldReference" }, "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "cancellationType": { "$ref": "#/components/schemas/CaseCancellationType" }, "hidden": { "type": "boolean" }, "availableExpression": { "type": "string", "nullable": true }, "buildExpression": { "type": "string", "nullable": true }, "validateExpression": { "type": "string", "nullable": true }, "lookups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "slots": { "type": "array", "items": { "$ref": "#/components/schemas/CaseSlot" }, "nullable": true }, "availableActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "buildActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "validateActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "displayName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "cancellationDate": { "type": "string", "format": "date-time", "nullable": true }, "reason": { "type": "string", "nullable": true }, "forecast": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/CaseFieldSet" }, "nullable": true }, "relatedCases": { "type": "array", "items": { "$ref": "#/components/schemas/CaseSet" }, "nullable": true } }, "additionalProperties": false }, "CaseSetup": { "required": [ "caseName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "caseName": { "minLength": 1, "type": "string" }, "caseSlot": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/CaseValueSetup" }, "nullable": true }, "relatedCases": { "type": "array", "items": { "$ref": "#/components/schemas/CaseSetup" }, "nullable": true } }, "additionalProperties": false }, "CaseSlot": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CaseType": { "enum": [ "Global", "National", "Company", "Employee" ], "type": "string" }, "CaseValidationIssue": { "required": [ "caseName", "issueType", "message" ], "type": "object", "properties": { "issueType": { "$ref": "#/components/schemas/CaseIssueType" }, "number": { "type": "integer", "format": "int32" }, "caseName": { "maxLength": 128, "minLength": 0, "type": "string" }, "caseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "caseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "caseFieldName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseFieldNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "sourceCaseName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "sourceCaseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "sourceCaseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "sourceCaseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "targetCaseName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "targetCaseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "targetCaseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "targetCaseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "message": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CaseValue": { "required": [ "caseFieldName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "caseName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "caseFieldName": { "maxLength": 128, "minLength": 0, "type": "string" }, "caseFieldNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "caseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "string", "nullable": true }, "numericValue": { "type": "number", "format": "double", "nullable": true }, "culture": { "type": "string", "nullable": true }, "caseRelation": { "$ref": "#/components/schemas/CaseRelationReference" }, "cancellationDate": { "type": "string", "format": "date-time", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "forecast": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CaseValueCreationMode": { "enum": [ "OnChanges", "Always", "Discard" ], "type": "string" }, "CaseValueSetup": { "required": [ "caseFieldName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "caseName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "caseFieldName": { "maxLength": 128, "minLength": 0, "type": "string" }, "caseFieldNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "caseSlot": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "caseSlotLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "string", "nullable": true }, "numericValue": { "type": "number", "format": "double", "nullable": true }, "culture": { "type": "string", "nullable": true }, "caseRelation": { "$ref": "#/components/schemas/CaseRelationReference" }, "cancellationDate": { "type": "string", "format": "date-time", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "forecast": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDocument" }, "nullable": true } }, "additionalProperties": false }, "ClusterSet": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "includeClusters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excludeClusters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CollectMode": { "enum": [ "Summary", "Minimum", "Maximum", "Average", "Range", "Count" ], "type": "string" }, "Collector": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "collectMode": { "$ref": "#/components/schemas/CollectMode" }, "negated": { "type": "boolean" }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "culture": { "type": "string", "nullable": true }, "collectorGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "threshold": { "type": "number", "format": "double", "nullable": true }, "minResult": { "type": "number", "format": "double", "nullable": true }, "maxResult": { "type": "number", "format": "double", "nullable": true }, "startExpression": { "type": "string", "nullable": true }, "applyExpression": { "type": "string", "nullable": true }, "endExpression": { "type": "string", "nullable": true }, "startActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "applyActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "endActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CollectorCustomResult": { "required": [ "collectorName", "end", "source", "start", "value", "valueType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "collectorResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "collectorName": { "minLength": 1, "type": "string" }, "collectorNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "source": { "minLength": 1, "type": "string" }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "number", "format": "double" }, "culture": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CollectorResult": { "required": [ "collectMode", "collectorId", "collectorName", "end", "negated", "start", "value", "valueType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "payrunJobId": { "type": "integer", "format": "int32" }, "forecast": { "type": "string", "nullable": true }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "collectorId": { "type": "integer", "format": "int32" }, "collectorName": { "minLength": 1, "type": "string" }, "collectorNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "collectMode": { "$ref": "#/components/schemas/CollectMode" }, "negated": { "type": "boolean" }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "number", "format": "double" }, "culture": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CollectorResultSet": { "required": [ "collectMode", "collectorId", "collectorName", "end", "negated", "start", "value", "valueType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "payrunJobId": { "type": "integer", "format": "int32" }, "forecast": { "type": "string", "nullable": true }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "collectorId": { "type": "integer", "format": "int32" }, "collectorName": { "minLength": 1, "type": "string" }, "collectorNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "collectMode": { "$ref": "#/components/schemas/CollectMode" }, "negated": { "type": "boolean" }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "number", "format": "double" }, "culture": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "customResults": { "type": "array", "items": { "$ref": "#/components/schemas/CollectorCustomResult" }, "nullable": true } }, "additionalProperties": false }, "ConsolidatedPayrollResult": { "type": "object", "properties": { "wageTypeResults": { "type": "array", "items": { "$ref": "#/components/schemas/WageTypeResultSet" }, "nullable": true }, "collectorResults": { "type": "array", "items": { "$ref": "#/components/schemas/CollectorResult" }, "nullable": true }, "payrunResults": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunResult" }, "nullable": true } }, "additionalProperties": false }, "ConstructorInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" } }, "additionalProperties": false }, "CustomAttributeData": { "type": "object", "properties": { "attributeType": { "$ref": "#/components/schemas/Type" }, "constructor": { "$ref": "#/components/schemas/ConstructorInfo" }, "constructorArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "nullable": true, "readOnly": true }, "namedArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeNamedArgument" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CustomAttributeNamedArgument": { "type": "object", "properties": { "memberInfo": { "$ref": "#/components/schemas/MemberInfo" }, "typedValue": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "memberName": { "type": "string", "nullable": true, "readOnly": true }, "isField": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomAttributeTypedArgument": { "type": "object", "properties": { "argumentType": { "$ref": "#/components/schemas/Type" }, "value": { "nullable": true } }, "additionalProperties": false }, "DataColumn": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "expression": { "type": "string", "nullable": true }, "valueType": { "type": "string", "nullable": true }, "valueBaseType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataRelation": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "parentTable": { "type": "string", "nullable": true }, "parentColumn": { "type": "string", "nullable": true }, "childTable": { "type": "string", "nullable": true }, "childColumn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataRow": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DataSet": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "tables": { "type": "array", "items": { "$ref": "#/components/schemas/DataTable" }, "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/DataRelation" }, "nullable": true } }, "additionalProperties": false }, "DataTable": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DataColumn" }, "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DataRow" }, "nullable": true } }, "additionalProperties": false }, "DatePeriod": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "Division": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "culture": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "calendar": { "type": "string", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "DivisionScope": { "enum": [ "All", "Local", "Global", "GlobalAndLocal" ], "type": "string" }, "Employee": { "required": [ "firstName", "identifier", "lastName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "identifier": { "maxLength": 128, "minLength": 0, "type": "string" }, "firstName": { "maxLength": 128, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 128, "minLength": 0, "type": "string" }, "divisions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "culture": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "calendar": { "type": "string", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "EventAttributes": { "enum": [ 0, 512, 1024 ], "type": "integer", "format": "int32" }, "EventInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/EventAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "addMethod": { "$ref": "#/components/schemas/MethodInfo" }, "removeMethod": { "$ref": "#/components/schemas/MethodInfo" }, "raiseMethod": { "$ref": "#/components/schemas/MethodInfo" }, "isMulticast": { "type": "boolean", "readOnly": true }, "eventHandlerType": { "$ref": "#/components/schemas/Type" } }, "additionalProperties": false }, "Exception": { "type": "object", "properties": { "targetSite": { "$ref": "#/components/schemas/MethodBase" }, "message": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "object", "additionalProperties": { }, "nullable": true, "readOnly": true }, "innerException": { "$ref": "#/components/schemas/Exception" }, "helpLink": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "hResult": { "type": "integer", "format": "int32" }, "stackTrace": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FieldAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 16, 32, 64, 128, 256, 512, 1024, 4096, 8192, 32768, 38144 ], "type": "integer", "format": "int32" }, "FieldInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/FieldAttributes" }, "fieldType": { "$ref": "#/components/schemas/Type" }, "isInitOnly": { "type": "boolean", "readOnly": true }, "isLiteral": { "type": "boolean", "readOnly": true }, "isNotSerialized": { "type": "boolean", "readOnly": true, "deprecated": true }, "isPinvokeImpl": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "fieldHandle": { "$ref": "#/components/schemas/RuntimeFieldHandle" } }, "additionalProperties": false }, "FunctionType": { "enum": [ "CaseAvailable", "CaseBuild", "CaseValidate", "CaseChange", "Case", "CaseRelationBuild", "CaseRelationValidate", "CaseRelation", "CollectorStart", "CollectorApply", "CollectorEnd", "Collector", "WageTypeValue", "WageTypeResult", "WageType", "PayrunStart", "PayrunEmployeeAvailable", "PayrunEmployeeStart", "PayrunEmployeeEnd", "PayrunWageTypeAvailable", "PayrunEnd", "PayrunBase", "Payrun", "Payroll", "ReportBuild", "ReportStart", "ReportEnd", "Report", "All" ], "type": "string" }, "GenericParameterAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 28, 32 ], "type": "integer", "format": "int32" }, "ICustomAttributeProvider": { "type": "object", "additionalProperties": false }, "IntPtr": { "type": "object", "additionalProperties": false }, "LayoutKind": { "enum": [ 0, 2, 3 ], "type": "integer", "format": "int32" }, "Log": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/LogLevel" }, "message": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "owner": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "ownerType": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "LogLevel": { "enum": [ "Verbose", "Debug", "Information", "Warning", "Error", "Fatal" ], "type": "string" }, "Lookup": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "rangeMode": { "$ref": "#/components/schemas/LookupRangeMode" }, "rangeSize": { "type": "number", "format": "double", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "LookupData": { "required": [ "name", "values" ], "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "culture": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/LookupValueData" } }, "rangeSize": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "LookupRangeBracket": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "rangeStart": { "type": "number", "format": "double" }, "rangeEnd": { "type": "number", "format": "double" }, "rangeValue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "LookupRangeMode": { "enum": [ "None", "Threshold", "Progressive" ], "type": "string" }, "LookupRangeResult": { "type": "object", "properties": { "lookupName": { "type": "string", "nullable": true }, "rangeMode": { "$ref": "#/components/schemas/LookupRangeMode" }, "rangeSize": { "type": "number", "format": "double", "nullable": true }, "brackets": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRangeBracket" }, "nullable": true } }, "additionalProperties": false }, "LookupSet": { "required": [ "name", "values" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "rangeMode": { "$ref": "#/components/schemas/LookupRangeMode" }, "rangeSize": { "type": "number", "format": "double", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/LookupValue" } } }, "additionalProperties": false }, "LookupSettings": { "required": [ "lookupName" ], "type": "object", "properties": { "lookupName": { "minLength": 1, "type": "string" }, "valueFieldName": { "type": "string", "nullable": true }, "textFieldName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LookupValue": { "required": [ "key", "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "key": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" }, "valueLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "rangeValue": { "type": "number", "format": "double", "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" } }, "additionalProperties": false }, "LookupValueData": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "rangeValue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MemberInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MemberTypes": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128, 191 ], "type": "integer", "format": "int32" }, "MethodAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 53248 ], "type": "integer", "format": "int32" }, "MethodBase": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MethodImplAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 32, 64, 128, 256, 512, 4096, 8192, 65535 ], "type": "integer", "format": "int32" }, "MethodInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "returnParameter": { "$ref": "#/components/schemas/ParameterInfo" }, "returnType": { "$ref": "#/components/schemas/Type" }, "returnTypeCustomAttributes": { "$ref": "#/components/schemas/ICustomAttributeProvider" } }, "additionalProperties": false }, "ModelError": { "type": "object", "properties": { "exception": { "$ref": "#/components/schemas/Exception" }, "errorMessage": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ModelStateEntry": { "type": "object", "properties": { "rawValue": { "nullable": true }, "attemptedValue": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ModelError" }, "nullable": true, "readOnly": true }, "validationState": { "$ref": "#/components/schemas/ModelValidationState" }, "isContainerNode": { "type": "boolean", "readOnly": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/ModelStateEntry" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ModelValidationState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Module": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/Assembly" }, "fullyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true }, "moduleVersionId": { "type": "string", "format": "uuid", "readOnly": true }, "scopeName": { "type": "string", "nullable": true, "readOnly": true }, "moduleHandle": { "$ref": "#/components/schemas/ModuleHandle" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ModuleHandle": { "type": "object", "properties": { "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Month": { "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ], "type": "string" }, "ObjectStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "OverrideType": { "enum": [ "Active", "Inactive" ], "type": "string" }, "ParameterAttributes": { "enum": [ 0, 1, 2, 4, 8, 16, 4096, 8192, 16384, 32768, 61440 ], "type": "integer", "format": "int32" }, "ParameterInfo": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/ParameterAttributes" }, "member": { "$ref": "#/components/schemas/MemberInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "parameterType": { "$ref": "#/components/schemas/Type" }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "isIn": { "type": "boolean", "readOnly": true }, "isLcid": { "type": "boolean", "readOnly": true }, "isOptional": { "type": "boolean", "readOnly": true }, "isOut": { "type": "boolean", "readOnly": true }, "isRetval": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "rawDefaultValue": { "nullable": true, "readOnly": true }, "hasDefaultValue": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "PasswordChangeRequest": { "type": "object", "properties": { "newPassword": { "type": "string", "nullable": true }, "existingPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Payroll": { "required": [ "divisionId", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "clusterSetCase": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetCaseField": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetCollector": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetCollectorRetro": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetWageType": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetWageTypeRetro": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetCaseValue": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSetWageTypePeriod": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "clusterSets": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterSet" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "PayrollLayer": { "required": [ "level", "regulationName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "level": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "regulationName": { "minLength": 1, "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "PayrollResult": { "required": [ "cycleEnd", "cycleName", "cycleStart", "divisionId", "employeeId", "payrollId", "payrunJobId", "periodName", "periodStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollId": { "type": "integer", "format": "int32" }, "payrollName": { "type": "string", "nullable": true }, "payrunId": { "type": "integer", "format": "int32" }, "payrunName": { "type": "string", "nullable": true }, "payrunJobId": { "type": "integer", "format": "int32" }, "payrunJobName": { "type": "string", "nullable": true }, "employeeId": { "type": "integer", "format": "int32" }, "employeeIdentifier": { "type": "string", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "cycleName": { "minLength": 1, "type": "string" }, "cycleStart": { "type": "string", "format": "date-time" }, "cycleEnd": { "type": "string", "format": "date-time" }, "periodName": { "minLength": 1, "type": "string" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PayrollResultSet": { "required": [ "cycleEnd", "cycleName", "cycleStart", "divisionId", "employeeId", "payrollId", "payrunJobId", "periodName", "periodStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollId": { "type": "integer", "format": "int32" }, "payrollName": { "type": "string", "nullable": true }, "payrunId": { "type": "integer", "format": "int32" }, "payrunName": { "type": "string", "nullable": true }, "payrunJobId": { "type": "integer", "format": "int32" }, "payrunJobName": { "type": "string", "nullable": true }, "employeeId": { "type": "integer", "format": "int32" }, "employeeIdentifier": { "type": "string", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "cycleName": { "minLength": 1, "type": "string" }, "cycleStart": { "type": "string", "format": "date-time" }, "cycleEnd": { "type": "string", "format": "date-time" }, "periodName": { "minLength": 1, "type": "string" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "wageTypeResults": { "type": "array", "items": { "$ref": "#/components/schemas/WageTypeResultSet" }, "nullable": true }, "collectorResults": { "type": "array", "items": { "$ref": "#/components/schemas/CollectorResultSet" }, "nullable": true }, "payrunResults": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunResult" }, "nullable": true } }, "additionalProperties": false }, "Payrun": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "defaultReason": { "type": "string", "nullable": true }, "defaultReasonLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "startExpression": { "type": "string", "nullable": true }, "employeeAvailableExpression": { "type": "string", "nullable": true }, "employeeStartExpression": { "type": "string", "nullable": true }, "employeeEndExpression": { "type": "string", "nullable": true }, "wageTypeAvailableExpression": { "type": "string", "nullable": true }, "endExpression": { "type": "string", "nullable": true }, "retroBackCycles": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PayrunJob": { "required": [ "createdReason", "createdUserId", "cycleEnd", "cycleName", "cycleStart", "evaluationDate", "jobStart", "name", "payrollId", "payrunId", "periodEnd", "periodName", "periodStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "owner": { "type": "string", "nullable": true }, "payrunId": { "type": "integer", "format": "int32" }, "payrollId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "createdUserId": { "type": "integer", "format": "int32" }, "releasedUserId": { "type": "integer", "format": "int32", "nullable": true }, "processedUserId": { "type": "integer", "format": "int32", "nullable": true }, "finishedUserId": { "type": "integer", "format": "int32", "nullable": true }, "retroPayMode": { "$ref": "#/components/schemas/RetroPayMode" }, "jobStatus": { "$ref": "#/components/schemas/PayrunJobStatus" }, "jobResult": { "$ref": "#/components/schemas/PayrunJobResult" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "forecast": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "cycleName": { "minLength": 1, "type": "string" }, "cycleStart": { "type": "string", "format": "date-time" }, "cycleEnd": { "type": "string", "format": "date-time" }, "periodName": { "minLength": 1, "type": "string" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "evaluationDate": { "type": "string", "format": "date-time" }, "released": { "type": "string", "format": "date-time", "nullable": true }, "processed": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "createdReason": { "minLength": 1, "type": "string" }, "releasedReason": { "type": "string", "nullable": true }, "processedReason": { "type": "string", "nullable": true }, "finishedReason": { "type": "string", "nullable": true }, "totalEmployeeCount": { "type": "integer", "format": "int32" }, "processedEmployeeCount": { "type": "integer", "format": "int32" }, "jobStart": { "type": "string", "format": "date-time" }, "jobEnd": { "type": "string", "format": "date-time", "nullable": true }, "message": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunJobEmployee" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "PayrunJobEmployee": { "required": [ "employeeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "employeeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PayrunJobInvocation": { "required": [ "name", "payrunName", "periodStart", "reason", "userIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrunName": { "minLength": 1, "type": "string" }, "userIdentifier": { "minLength": 1, "type": "string" }, "payrunJobId": { "type": "integer", "format": "int32" }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "minLength": 1, "type": "string" }, "owner": { "type": "string", "nullable": true }, "retroJobs": { "type": "array", "items": { "$ref": "#/components/schemas/RetroPayrunJob" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "forecast": { "type": "string", "nullable": true }, "retroPayMode": { "$ref": "#/components/schemas/RetroPayMode" }, "jobResult": { "$ref": "#/components/schemas/PayrunJobResult" }, "jobStatus": { "$ref": "#/components/schemas/PayrunJobStatus" }, "completedJobStatus": { "$ref": "#/components/schemas/PayrunJobStatus" }, "periodStart": { "type": "string", "format": "date-time" }, "evaluationDate": { "type": "string", "format": "date-time", "nullable": true }, "reason": { "minLength": 1, "type": "string" }, "storeEmptyResults": { "type": "boolean" }, "logLevel": { "$ref": "#/components/schemas/LogLevel" }, "employeeIdentifiers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "PayrunJobResult": { "enum": [ "Full", "Incremental" ], "type": "string" }, "PayrunJobSet": { "required": [ "createdReason", "createdUserId", "cycleEnd", "cycleName", "cycleStart", "evaluationDate", "jobStart", "name", "payrollId", "payrunId", "periodEnd", "periodName", "periodStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "owner": { "type": "string", "nullable": true }, "payrunId": { "type": "integer", "format": "int32" }, "payrollId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "createdUserId": { "type": "integer", "format": "int32" }, "releasedUserId": { "type": "integer", "format": "int32", "nullable": true }, "processedUserId": { "type": "integer", "format": "int32", "nullable": true }, "finishedUserId": { "type": "integer", "format": "int32", "nullable": true }, "retroPayMode": { "$ref": "#/components/schemas/RetroPayMode" }, "jobStatus": { "$ref": "#/components/schemas/PayrunJobStatus" }, "jobResult": { "$ref": "#/components/schemas/PayrunJobResult" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "forecast": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "cycleName": { "minLength": 1, "type": "string" }, "cycleStart": { "type": "string", "format": "date-time" }, "cycleEnd": { "type": "string", "format": "date-time" }, "periodName": { "minLength": 1, "type": "string" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "evaluationDate": { "type": "string", "format": "date-time" }, "released": { "type": "string", "format": "date-time", "nullable": true }, "processed": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "createdReason": { "minLength": 1, "type": "string" }, "releasedReason": { "type": "string", "nullable": true }, "processedReason": { "type": "string", "nullable": true }, "finishedReason": { "type": "string", "nullable": true }, "totalEmployeeCount": { "type": "integer", "format": "int32" }, "processedEmployeeCount": { "type": "integer", "format": "int32" }, "jobStart": { "type": "string", "format": "date-time" }, "jobEnd": { "type": "string", "format": "date-time", "nullable": true }, "message": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/PayrunJobEmployee" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "payrunName": { "type": "string", "nullable": true }, "divisionName": { "type": "string", "nullable": true }, "userIdentifier": { "type": "string", "nullable": true }, "resultSets": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollResultSet" }, "nullable": true } }, "additionalProperties": false }, "PayrunJobStatus": { "enum": [ "Draft", "Release", "Process", "Complete", "Forecast", "Abort", "Cancel" ], "type": "string" }, "PayrunParameter": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "mandatory": { "type": "boolean" }, "value": { "type": "string", "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "PayrunResult": { "required": [ "end", "name", "source", "start", "value", "valueType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "payrunJobId": { "type": "integer", "format": "int32" }, "forecast": { "type": "string", "nullable": true }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "source": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "slot": { "type": "string", "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "minLength": 1, "type": "string" }, "culture": { "type": "string", "nullable": true }, "numericValue": { "type": "number", "format": "double", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "PropertyAttributes": { "enum": [ 0, 512, 1024, 4096, 8192, 16384, 32768, 62464 ], "type": "integer", "format": "int32" }, "PropertyInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "propertyType": { "$ref": "#/components/schemas/Type" }, "attributes": { "$ref": "#/components/schemas/PropertyAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "canRead": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "getMethod": { "$ref": "#/components/schemas/MethodInfo" }, "setMethod": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "QueryResultType": { "enum": [ "Items", "Count", "ItemsWithCount" ], "type": "string" }, "Regulation": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "namespace": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "sharedRegulation": { "type": "boolean" }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "baseRegulations": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Report": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "category": { "type": "string", "nullable": true }, "attributeMode": { "$ref": "#/components/schemas/ReportAttributeMode" }, "userType": { "$ref": "#/components/schemas/UserType" }, "reportIsolation": { "$ref": "#/components/schemas/ReportIsolation" }, "queries": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/DataRelation" }, "nullable": true }, "buildExpression": { "type": "string", "nullable": true }, "startExpression": { "type": "string", "nullable": true }, "endExpression": { "type": "string", "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReportAttributeMode": { "enum": [ "Json", "Table" ], "type": "string" }, "ReportIsolation": { "enum": [ "None", "Global", "Company", "Division", "Employee" ], "type": "string" }, "ReportLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "reportName": { "type": "string", "nullable": true }, "reportDate": { "type": "string", "format": "date-time" }, "key": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportParameter": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "mandatory": { "type": "boolean" }, "hidden": { "type": "boolean" }, "value": { "type": "string", "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "parameterType": { "$ref": "#/components/schemas/ReportParameterType" }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ReportParameterType": { "enum": [ "Value", "Now", "Today", "TenantId", "UserId", "EmployeeId", "RegulationId", "PayrollId", "PayrunId", "ReportId", "WebhookId" ], "type": "string" }, "ReportRequest": { "type": "object", "properties": { "culture": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32" }, "parameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ReportResponse": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "queries": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/DataRelation" }, "nullable": true }, "reportName": { "type": "string", "nullable": true }, "culture": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "result": { "$ref": "#/components/schemas/DataSet" } }, "additionalProperties": false }, "ReportSet": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "category": { "type": "string", "nullable": true }, "attributeMode": { "$ref": "#/components/schemas/ReportAttributeMode" }, "userType": { "$ref": "#/components/schemas/UserType" }, "reportIsolation": { "$ref": "#/components/schemas/ReportIsolation" }, "queries": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/DataRelation" }, "nullable": true }, "buildExpression": { "type": "string", "nullable": true }, "startExpression": { "type": "string", "nullable": true }, "endExpression": { "type": "string", "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "regulationId": { "type": "integer", "format": "int32" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameter" }, "nullable": true }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTemplate" }, "nullable": true } }, "additionalProperties": false }, "ReportTemplate": { "required": [ "content", "culture", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "culture": { "minLength": 1, "type": "string" }, "content": { "minLength": 1, "type": "string" }, "contentType": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "schema": { "type": "string", "nullable": true }, "resource": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RetroPayMode": { "enum": [ "ValueChange", "None" ], "type": "string" }, "RetroPayrunJob": { "required": [ "scheduleDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "scheduleDate": { "type": "string", "format": "date-time" }, "resultTags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RuntimeFieldHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeMethodHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeTypeHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "Script": { "required": [ "name", "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "functionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/FunctionType" }, "nullable": true }, "value": { "minLength": 1, "type": "string" }, "overrideType": { "$ref": "#/components/schemas/OverrideType" } }, "additionalProperties": false }, "SecurityRuleSet": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "StructLayoutAttribute": { "type": "object", "properties": { "typeId": { "nullable": true, "readOnly": true }, "value": { "$ref": "#/components/schemas/LayoutKind" } }, "additionalProperties": false }, "Task": { "required": [ "instruction", "name", "scheduled", "scheduledUserId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "category": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "instruction": { "minLength": 1, "type": "string" }, "scheduledUserId": { "type": "integer", "format": "int32" }, "scheduled": { "type": "string", "format": "date-time" }, "completedUserId": { "type": "integer", "format": "int32", "nullable": true }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Tenant": { "required": [ "identifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "identifier": { "maxLength": 128, "minLength": 0, "type": "string" }, "culture": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "calendar": { "type": "string", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "TenantIsolationLevel": { "enum": [ "None", "Consolidation", "Read", "Write" ], "type": "string" }, "Type": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isInterface": { "type": "boolean", "readOnly": true }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TypeAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32, 128, 256, 1024, 2048, 4096, 8192, 16384, 65536, 131072, 196608, 262144, 264192, 1048576, 12582912 ], "type": "integer", "format": "int32" }, "TypeInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isInterface": { "type": "boolean", "readOnly": true }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true }, "genericTypeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "declaredConstructors": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructorInfo" }, "nullable": true, "readOnly": true }, "declaredEvents": { "type": "array", "items": { "$ref": "#/components/schemas/EventInfo" }, "nullable": true, "readOnly": true }, "declaredFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInfo" }, "nullable": true, "readOnly": true }, "declaredMembers": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" }, "nullable": true, "readOnly": true }, "declaredMethods": { "type": "array", "items": { "$ref": "#/components/schemas/MethodInfo" }, "nullable": true, "readOnly": true }, "declaredNestedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "declaredProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyInfo" }, "nullable": true, "readOnly": true }, "implementedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User": { "required": [ "firstName", "identifier", "lastName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "identifier": { "maxLength": 128, "minLength": 0, "type": "string" }, "firstName": { "maxLength": 128, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 128, "minLength": 0, "type": "string" }, "culture": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "userType": { "$ref": "#/components/schemas/UserType" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "UserType": { "enum": [ "Employee", "User", "TenantAdministrator", "SystemAdministrator" ], "type": "string" }, "ValueScope": { "enum": [ "Local", "Global" ], "type": "string" }, "ValueType": { "enum": [ "String", "Boolean", "Integer", "NumericBoolean", "Decimal", "DateTime", "None", "Date", "Weekday", "Month", "Year", "Money", "Percent", "WebResource" ], "type": "string" }, "WageType": { "required": [ "name", "wageTypeNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "wageTypeNumber": { "type": "number", "format": "double" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "nameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "description": { "type": "string", "nullable": true }, "descriptionLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "overrideType": { "$ref": "#/components/schemas/OverrideType" }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "calendar": { "type": "string", "nullable": true }, "culture": { "type": "string", "nullable": true }, "collectors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collectorGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueExpression": { "type": "string", "nullable": true }, "resultExpression": { "type": "string", "nullable": true }, "valueActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resultActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "clusters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "WageTypeCustomResult": { "required": [ "end", "source", "start", "value", "wageTypeNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "wageTypeResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "wageTypeNumber": { "type": "number", "format": "double" }, "wageTypeName": { "type": "string", "nullable": true }, "wageTypeNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "source": { "minLength": 1, "type": "string" }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "number", "format": "double" }, "culture": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "WageTypeResult": { "required": [ "end", "start", "value", "wageTypeId", "wageTypeName", "wageTypeNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "payrunJobId": { "type": "integer", "format": "int32" }, "forecast": { "type": "string", "nullable": true }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "wageTypeId": { "type": "integer", "format": "int32" }, "wageTypeNumber": { "type": "number", "format": "double" }, "wageTypeName": { "minLength": 1, "type": "string" }, "wageTypeNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "number", "format": "double" }, "culture": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "WageTypeResultSet": { "required": [ "end", "start", "value", "wageTypeId", "wageTypeName", "wageTypeNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "payrollResultId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "payrunJobId": { "type": "integer", "format": "int32" }, "forecast": { "type": "string", "nullable": true }, "parentJobId": { "type": "integer", "format": "int32", "nullable": true }, "wageTypeId": { "type": "integer", "format": "int32" }, "wageTypeNumber": { "type": "number", "format": "double" }, "wageTypeName": { "minLength": 1, "type": "string" }, "wageTypeNameLocalizations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "valueType": { "$ref": "#/components/schemas/ValueType" }, "value": { "type": "number", "format": "double" }, "culture": { "type": "string", "nullable": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "customResults": { "type": "array", "items": { "$ref": "#/components/schemas/WageTypeCustomResult" }, "nullable": true } }, "additionalProperties": false }, "Webhook": { "required": [ "action", "name", "receiverAddress" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 128, "minLength": 0, "type": "string" }, "receiverAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "action": { "$ref": "#/components/schemas/WebhookAction" }, "attributes": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "WebhookAction": { "enum": [ "None", "CaseFunctionRequest", "CaseChangeAdded", "PayrunFunctionRequest", "PayrunJobProcess", "PayrunJobFinish", "ReportFunctionRequest", "TaskChange" ], "type": "string" }, "WebhookMessage": { "required": [ "actionName", "receiverAddress", "requestDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ObjectStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "actionName": { "maxLength": 128, "minLength": 0, "type": "string" }, "receiverAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "requestDate": { "type": "string", "format": "date-time" }, "requestMessage": { "type": "string", "nullable": true }, "requestOperation": { "type": "string", "nullable": true }, "responseDate": { "type": "string", "format": "date-time" }, "responseStatus": { "type": "integer", "format": "int32" }, "responseMessage": { "type": "string", "nullable": true } }, "additionalProperties": false } } }, "tags": [ { "name": "Administration" }, { "name": "Calendars" }, { "name": "Case fields" }, { "name": "Case relations" }, { "name": "Cases" }, { "name": "Collectors" }, { "name": "Company case changes" }, { "name": "Company case documents" }, { "name": "Company case values" }, { "name": "Divisions" }, { "name": "Employee case changes" }, { "name": "Employee case documents" }, { "name": "Employee case values" }, { "name": "Employees" }, { "name": "Global case changes" }, { "name": "Global case documents" }, { "name": "Global case values" }, { "name": "Logs" }, { "name": "Lookup values" }, { "name": "Lookups" }, { "name": "National case changes" }, { "name": "National case documents" }, { "name": "National case values" }, { "name": "Payroll consolidated results" }, { "name": "Payroll layers" }, { "name": "Payroll results" }, { "name": "Payrolls" }, { "name": "Payrun jobs" }, { "name": "Payrun parameters" }, { "name": "Payruns" }, { "name": "Regulations" }, { "name": "Report logs" }, { "name": "Report parameters" }, { "name": "Report templates" }, { "name": "Reports" }, { "name": "Scripts" }, { "name": "Tasks" }, { "name": "Tenants" }, { "name": "Users" }, { "name": "Wage types" }, { "name": "Webhook messages" }, { "name": "Webhooks" } ] }