{
"openapi": "3.0.1",
"info": {
"title": "MindKey OData Connector 2.0 - WorkingTime",
"description": "MindKey OData Connector",
"version": "2.0"
},
"servers": [
{
"url": "https://connector.mindkey.com"
}
],
"paths": {
"/odata/v2/WorkTimeJournal": {
"get": {
"tags": [
"WorkTimeJournal"
],
"summary": "Retrieve a list of work time journal entries",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "WorkTimeJournals",
"parameters": [
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTimeJournalIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/odata/v2/WorkTimeJournalLine": {
"get": {
"tags": [
"WorkTimeJournalLine"
],
"summary": "Retrieve a list of work time journal lines",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "WorkTimeJournalLines",
"parameters": [
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTimeJournalLineIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/odata/v2/WorkTimeLogHeader": {
"get": {
"tags": [
"WorkTimeLogHeader"
],
"summary": "Retrieve a list of work time log headers",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "WorkTimeLogHeaders",
"parameters": [
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTimeLogHeaderIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/odata/v2/WorkTimeLogLine": {
"get": {
"tags": [
"WorkTimeLogLine"
],
"summary": "Retrieve a list of work time log lines",
"operationId": "WorkTimeLogLines",
"parameters": [
{
"name": "select",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "expand",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "orderby",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTimeLogLineODataModelIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/odata/v2/WorkTimeLogViolation": {
"get": {
"tags": [
"WorkTimeLogViolation"
],
"summary": "Retrieve a list of work time log violations",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "WorkTimeLogViolations",
"parameters": [
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTimeLogViolationIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/odata/v2/WorkTimeViolation": {
"get": {
"tags": [
"WorkTimeViolation"
],
"summary": "Retrieve a list of work time violations",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "WorkTimeViolations",
"parameters": [
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTimeViolationIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"CurrentPosition": {
"type": "object",
"properties": {
"positionId": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"nullable": true
},
"organizationId": {
"type": "string",
"nullable": true
},
"employmentCategoryName": {
"type": "string",
"nullable": true
},
"dimension1Id": {
"type": "string",
"nullable": true
},
"dimension2Id": {
"type": "string",
"nullable": true
},
"dimension3Id": {
"type": "string",
"nullable": true
},
"dimension4Id": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"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": { }
},
"SimpleEmployee": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"initials": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"nameFirstName": {
"type": "string",
"nullable": true
},
"nameMiddleName": {
"type": "string",
"nullable": true
},
"nameLastName": {
"type": "string",
"nullable": true
},
"nameFullName": {
"type": "string",
"nullable": true
},
"hiredDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"seniorityDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"terminatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"position": {
"$ref": "#/components/schemas/CurrentPosition"
}
},
"additionalProperties": false
},
"WorkTimeJournal": {
"type": "object",
"properties": {
"workTimeJournalLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeJournalLine"
},
"nullable": true
},
"workTimeLogHeaders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeLogHeader"
},
"nullable": true
},
"employee": {
"$ref": "#/components/schemas/SimpleEmployee"
},
"workTimeJournalId": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"submitted": {
"type": "boolean"
},
"submittedBy": {
"type": "string",
"nullable": true
},
"submittedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"violationsApproved": {
"type": "boolean"
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
},
"yearWeek": {
"type": "string",
"nullable": true
},
"workTimeViolations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeViolation"
},
"nullable": true
}
},
"additionalProperties": false
},
"WorkTimeJournalIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeJournal"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
},
"WorkTimeJournalLine": {
"type": "object",
"properties": {
"workTimeJournalId": {
"type": "string",
"nullable": true
},
"dayOfWeek": {
"type": "integer",
"format": "int32"
},
"block1StartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"block1EndTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"block2StartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"block2EndTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workFromHome": {
"type": "boolean"
},
"workingHours": {
"type": "number",
"format": "double"
},
"breaksHeld": {
"type": "boolean"
},
"workTimeDayType": {
"type": "integer",
"format": "int32"
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
},
"allowEdit": {
"type": "boolean"
},
"dayTypeLookup": {
"type": "integer",
"format": "int32"
},
"workTimeJournal": {
"$ref": "#/components/schemas/WorkTimeJournal"
}
},
"additionalProperties": false
},
"WorkTimeJournalLineIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeJournalLine"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
},
"WorkTimeLogHeader": {
"type": "object",
"properties": {
"workTimeLogViolations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeLogViolation"
},
"nullable": true
},
"workTimeLogHeaderId": {
"type": "string",
"nullable": true
},
"workTimeJournalId": {
"type": "string",
"nullable": true
},
"submittedDateTime": {
"type": "string",
"format": "date-time"
},
"note": {
"type": "string",
"nullable": true
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
},
"workTimeJournal": {
"$ref": "#/components/schemas/WorkTimeJournal"
}
},
"additionalProperties": false
},
"WorkTimeLogHeaderIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeLogHeader"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
},
"WorkTimeLogLineODataModel": {
"type": "object",
"properties": {
"workTimeLogHeaderId": {
"type": "string",
"nullable": true
},
"dayOfWeek": {
"type": "integer",
"format": "int32"
},
"columnName": {
"type": "string",
"nullable": true
},
"oldValue": {
"type": "string",
"nullable": true
},
"newValue": {
"type": "string",
"nullable": true
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
},
"workTimeLogHeader": {
"$ref": "#/components/schemas/WorkTimeLogHeader"
}
},
"additionalProperties": false
},
"WorkTimeLogLineODataModelIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeLogLineODataModel"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
},
"WorkTimeLogViolation": {
"type": "object",
"properties": {
"workTimeLogHeaderId": {
"type": "string",
"nullable": true
},
"dayOfWeek": {
"type": "integer",
"format": "int32"
},
"violationType": {
"type": "integer",
"format": "int32"
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
},
"workTimeLogHeader": {
"$ref": "#/components/schemas/WorkTimeLogHeader"
}
},
"additionalProperties": false
},
"WorkTimeLogViolationIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeLogViolation"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
},
"WorkTimeViolation": {
"type": "object",
"properties": {
"workTimeJournal": {
"$ref": "#/components/schemas/WorkTimeJournal"
},
"workTimeJournalId": {
"type": "string",
"nullable": true
},
"dayOfWeek": {
"type": "integer",
"format": "int32"
},
"violationType": {
"type": "integer",
"format": "int32"
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
}
},
"additionalProperties": false
},
"WorkTimeViolationIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTimeViolation"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
}
},
"securitySchemes": {
"ApiKey-v2": {
"type": "apiKey",
"description": "Prefix the value with \"ApiKey-v2\" to indicate the custom authorization type",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"ApiKey-v2": [ ]
}
]
}