{
"openapi": "3.0.1",
"info": {
"title": "MindKey OData Connector 2.0 - Leave",
"description": "MindKey OData Connector",
"version": "2.0"
},
"servers": [
{
"url": "https://connector.mindkey.com"
}
],
"paths": {
"/odata/v2/Leave": {
"get": {
"tags": [
"Leave"
],
"summary": "Retrieve a list of leave entries",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "GetLeaves",
"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/LeaveIEnumerableODataResponse"
}
}
}
},
"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/LeaveCode": {
"get": {
"tags": [
"LeaveCode"
],
"summary": "Retrieve a list of leave codes",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "LeaveCodes",
"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/LeaveCodeIEnumerableODataResponse"
}
}
}
},
"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/LeaveGroup": {
"get": {
"tags": [
"LeaveGroup"
],
"summary": "Retrieve a list of leave groups",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "LeaveGroups",
"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/LeaveGroupIEnumerableODataResponse"
}
}
}
},
"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/LeaveIntegration": {
"get": {
"tags": [
"LeaveIntegration"
],
"summary": "Retrieve a list of leave integrations",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "LeaveIntegrations",
"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/LeaveIntegrationIEnumerableODataResponse"
}
}
}
},
"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/LeaveLine": {
"get": {
"tags": [
"LeaveLine"
],
"summary": "Retrieve a list of leave line",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "LeaveLines",
"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/LeaveLineIEnumerableODataResponse"
}
}
}
},
"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/LeaveType": {
"get": {
"tags": [
"LeaveType"
],
"summary": "Retrieve a list of leave types",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "LeaveTypes",
"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/LeaveTypeIEnumerableODataResponse"
}
}
}
},
"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/LeaveTypePeriod": {
"get": {
"tags": [
"LeaveTypePeriod"
],
"summary": "Retrieve a list of leave type periods",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "LeaveTypePeriods",
"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/LeaveTypePeriodIEnumerableODataResponse"
}
}
}
},
"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
},
"Leave": {
"type": "object",
"properties": {
"integrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveIntegration"
},
"nullable": true
},
"leaveId": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "string",
"nullable": true
},
"approvalStatus": {
"type": "integer",
"format": "int32"
},
"approvedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"approver": {
"type": "string",
"nullable": true
},
"submitter": {
"type": "string",
"nullable": true
},
"leaveCodeName": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"description": {
"type": "string",
"nullable": true
},
"origin": {
"type": "integer",
"format": "int32"
},
"halfDay": {
"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"
},
"batchId": {
"type": "string",
"nullable": true
},
"leaveLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveLine"
},
"nullable": true
},
"leaveCode": {
"$ref": "#/components/schemas/LeaveCode"
},
"employee": {
"$ref": "#/components/schemas/SimpleEmployee"
}
},
"additionalProperties": false
},
"LeaveCode": {
"type": "object",
"properties": {
"leaves": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Leave"
},
"nullable": true
},
"leaveGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveGroup"
},
"nullable": true
},
"leaveCodeName": {
"type": "string",
"nullable": true
},
"color": {
"type": "integer",
"format": "int32"
},
"leaveTypeName": {
"type": "string",
"nullable": true
},
"balanceUnit": {
"type": "integer",
"format": "int32"
},
"qtyTransferMax": {
"type": "number",
"format": "double"
},
"qtyPayoutMax": {
"type": "number",
"format": "double"
},
"negativeBalance": {
"type": "boolean"
},
"allowCreateEmployee": {
"type": "boolean"
},
"allowCreateManager": {
"type": "boolean"
},
"seniorityMonths": {
"type": "integer",
"format": "int32"
},
"qtyAccumulatePeriod": {
"type": "number",
"format": "double"
},
"onlyFullDays": {
"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"
},
"active": {
"type": "boolean"
},
"approvalWorkflow": {
"type": "boolean"
},
"negativeBalanceMax": {
"type": "number",
"format": "double"
},
"lockDescription": {
"type": "boolean"
},
"qtyAccumulateDay": {
"type": "number",
"format": "double"
},
"qtyAccumulatePeriodExtra": {
"type": "number",
"format": "double"
},
"accumulatePeriodFrequency": {
"type": "integer",
"format": "int32"
},
"autoAccumulate": {
"type": "boolean"
},
"periodPrinciple": {
"type": "integer",
"format": "int32"
},
"visibleEmployeeDashboard": {
"type": "boolean"
},
"visibleManagerDashboard": {
"type": "boolean"
},
"visibleHrDashboard": {
"type": "boolean"
},
"kind": {
"type": "integer",
"format": "int32"
},
"leaveType": {
"$ref": "#/components/schemas/LeaveType"
}
},
"additionalProperties": false
},
"LeaveCodeIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveCode"
},
"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."
},
"LeaveGroup": {
"type": "object",
"properties": {
"leaveGroupName": {
"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"
},
"leaveCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveCode"
},
"nullable": true
}
},
"additionalProperties": false
},
"LeaveGroupIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveGroup"
},
"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."
},
"LeaveIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Leave"
},
"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."
},
"LeaveIntegration": {
"type": "object",
"properties": {
"leaveId": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"leaveCodeName": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"balanceEffect": {
"type": "number",
"format": "double"
},
"balanceUnit": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "string",
"nullable": true
},
"origin": {
"type": "integer",
"format": "int32"
},
"payrollUpdateStatus": {
"type": "integer",
"format": "int32"
},
"payrollDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"correction": {
"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"
},
"externalStatus": {
"type": "integer",
"format": "int32"
},
"employee": {
"$ref": "#/components/schemas/SimpleEmployee"
}
},
"additionalProperties": false
},
"LeaveIntegrationIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveIntegration"
},
"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."
},
"LeaveLine": {
"type": "object",
"properties": {
"leaveId": {
"type": "string",
"nullable": true
},
"transDate": {
"type": "string",
"format": "date-time"
},
"leaveTypePeriodId": {
"type": "string",
"nullable": true
},
"balanceEffect": {
"type": "number",
"format": "double"
},
"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"
},
"leaveTypePeriod": {
"$ref": "#/components/schemas/LeaveTypePeriod"
}
},
"additionalProperties": false
},
"LeaveLineIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveLine"
},
"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."
},
"LeaveType": {
"type": "object",
"properties": {
"leaveCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveCode"
},
"nullable": true
},
"leaveTypeName": {
"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"
},
"balanceType": {
"type": "integer",
"format": "int32"
},
"leaveTypePeriods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveTypePeriod"
},
"nullable": true
}
},
"additionalProperties": false
},
"LeaveTypeIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveType"
},
"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."
},
"LeaveTypePeriod": {
"type": "object",
"properties": {
"leaveLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveLine"
},
"nullable": true
},
"leaveType": {
"$ref": "#/components/schemas/LeaveType"
},
"leaveTypePeriodId": {
"type": "string",
"nullable": true
},
"leaveTypeName": {
"type": "string",
"nullable": true
},
"startDateConduct": {
"type": "string",
"format": "date-time"
},
"endDateConduct": {
"type": "string",
"format": "date-time"
},
"startDateAccumulate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDateAccumulate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"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
},
"LeaveTypePeriodIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveTypePeriod"
},
"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."
},
"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
}
},
"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": [ ]
}
]
}