Nexus

Nexus APIs

GET /v1/onboardings

Gets a list of Onboarding Records

Parameters
Name In Required Description
select query No One or more comma separated fields to select.
orderby query No One or more fields to sort by, with optional ascending/descending indicator. (e.g. name DESC)
filter query No An OData filter expression. e.g. field_name eq 123
top query No The maximum number of rows to return in the response.
count query No Indicates if the response should contain a field with the total count of records.
expand query No Indicates if the response should expand nested objects.
skip query No Indicates the number of records to skip. Combine with $top for paging operations.
Responses
200
Example 
{
  "value": [
    {
      "id": 0,
      "data": {},
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "employeeId": 0,
      "isArchived": false,
      "modifiedBy": "string",
      "onboardingEvents": [
        {
          "data": null,
          "eventType": null,
          "onboardingRecord": null
        }
      ]
    }
  ],
  "@odata.count": 0,
  "@odata.context": "string"
}
Schema
Name Type Attributes Description Extensions
@odata.context string nullable — —
@odata.count number nullable — —
value — — —
Example 
{
  "value": [
    {
      "id": 0,
      "data": {},
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "employeeId": 0,
      "isArchived": false,
      "modifiedBy": "string",
      "onboardingEvents": [
        {
          "data": null,
          "eventType": null,
          "onboardingRecord": null
        }
      ]
    }
  ],
  "@odata.count": 0,
  "@odata.context": "string"
}
Schema
Name Type Attributes Description Extensions
@odata.context string nullable — —
@odata.count number nullable — —
value — — —
Example 
{
  "value": [
    {
      "id": 0,
      "data": {},
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "employeeId": 0,
      "isArchived": false,
      "modifiedBy": "string",
      "onboardingEvents": [
        {
          "data": null,
          "eventType": null,
          "onboardingRecord": null
        }
      ]
    }
  ],
  "@odata.count": 0,
  "@odata.context": "string"
}
Schema
Name Type Attributes Description Extensions
@odata.context string nullable — —
@odata.count number nullable — —
value — — —
Security

Authentication is required for this operation.

Source: default

Requirements (any one option may satisfy)

  • Bearer and ApplicationToken
  • Basic