Nexus

Nexus APIs

PATCH /v1/onboardings/{onboardingId}

Updates the given properties on an Onboarding record.

Requires the onboarding.write permission

Parameters
Name In Required Description
onboardingId path Yes —
Request body
application/json-patch+json
Example 
[
  {
    "op": "string",
    "path": "string",
    "value": {}
  }
]
Schema
Name Type Attributes Description Extensions
op string — — —
path string — — —
value object nullable — —
Responses
200
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 — —
404
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Security

Authentication is required for this operation.

Source: default

Requirements (any one option may satisfy)

  • Bearer and ApplicationToken
  • Basic