Nexus
Nexus APIs
POST
/v1/onboardings
Creates an Onboarding record
Requires the Nexus.PermissionCodes.OnboardingWrite permission
Request body
Request payload
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Example
{
"data": {},
"employeeId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
Responses
201
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Example
{
"id": 0,
"data": {},
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": [
{
"id": 0,
"data": {},
"created": "string",
"createdBy": "string",
"eventType": "string",
"onboardingId": 0,
"onboardingRecord": {
"id": 0,
"data": null,
"created": "string",
"modified": "string",
"createdBy": "string",
"employeeId": 0,
"isArchived": false,
"modifiedBy": "string",
"onboardingEvents": []
}
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
data
|
— | JsonObject primitive | — | |
employeeId
|
integer (int32)
|
— | — | — |
id
|
integer (int32)
|
— | — | — |
isArchived
|
boolean
|
— | — | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
onboardingEvents
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic