{
"openapi": "3.0.1",
"info": {
"title": "MindKey OData Connector 2.0 - Compensation",
"description": "MindKey OData Connector",
"version": "2.0"
},
"servers": [
{
"url": "https://connector.mindkey.com"
}
],
"paths": {
"/odata/v2/EmployeeAward": {
"get": {
"tags": [
"EmployeeAward"
],
"summary": "Retrieve a list of employee awards",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "GetEmployeeAwardsV2",
"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/EmployeeAwardIEnumerableODataResponse"
}
}
}
},
"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/EmployeeSalary": {
"get": {
"tags": [
"EmployeeSalary"
],
"summary": "Retrieve a list of employee salary data",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "GetEmployeeSalariesV2",
"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/EmployeeSalaryIEnumerableODataResponse"
}
}
}
},
"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/EmployeeStockOption": {
"get": {
"tags": [
"EmployeeStockOption"
],
"summary": "Retrieve a list of employee stock options",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "EmployeeStockOptions",
"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/EmployeeStockOptionIEnumerableODataResponse"
}
}
}
},
"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
},
"EmployeeAward": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"awardName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"amount": {
"type": "number",
"format": "double"
},
"authorizedBy": {
"type": "string",
"nullable": true
},
"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"
},
"employee": {
"$ref": "#/components/schemas/SimpleEmployee"
}
},
"additionalProperties": false
},
"EmployeeAwardIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeAward"
},
"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."
},
"EmployeeSalary": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"salaryName": {
"type": "string",
"nullable": true
},
"currencyId": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"authorizedBy": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"payFrequency": {
"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"
},
"percentage": {
"type": "number",
"format": "double"
},
"employee": {
"$ref": "#/components/schemas/SimpleEmployee"
}
},
"additionalProperties": false
},
"EmployeeSalaryIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeSalary"
},
"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."
},
"EmployeeStockOption": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"stockOptionName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"dateIssued": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"vestedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"shares": {
"type": "number",
"format": "double"
},
"strikePrice": {
"type": "number",
"format": "double"
},
"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"
},
"currentPrice": {
"type": "number",
"format": "double"
},
"currentPriceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"employee": {
"$ref": "#/components/schemas/SimpleEmployee"
}
},
"additionalProperties": false
},
"EmployeeStockOptionIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeStockOption"
},
"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": [ ]
}
]
}