API - Career Notes

Career Notes

Those endpoints allow you to manage the career notes.

Career notes are notes that are related to the career of an employee, during his employment in the company. Those notes are visible only by the HR department.

They can be used to store information about the employee, like a performance review, a disciplinary action, a promotion, which should not be reflected in the employee’s career events.

Endpoints

get/api/v3/office/career_notes

Return a paginated list of office/career/notes

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
recipient_id?: unknown
note?: unknown
created_by_id?: unknown
created_at?: unknown
updated_at?: unknown
The related resources to include in the response. Allowed resources are:
- `employee`
- `created_by`
included?:
array
Elements: string
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    recipient_id?: any;
    note?: any;
    created_by_id?: any;
    created_at?: any;
    updated_at?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `employee`
  // - `created_by`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
recipient_id?: integer
note?: string or null
created_by_id?: integer
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      recipient_id?: number;
      note?: string | null;
      created_by_id?: number;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/office/career_notes

Create a new office/career/notes

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
recipient_id?: integer
note?: string or null
created_by_id?: integer
created_at?: datetime
updated_at?: datetime

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      recipient_id?: number;
      note?: string | null;
      created_by_id?: number;
      created_at?: Date;
      updated_at?: Date;
    };
  };
};

delete/api/v3/office/career_notes/:resource_id

Delete the office/career/notes

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/office/career_notes/:resource_id

Show a specific office/career/notes

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
recipient_id?: integer
note?: string or null
created_by_id?: integer
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      recipient_id?: number;
      note?: string | null;
      created_by_id?: number;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/office/career_notes/:resource_id

Update a office/career/notes

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
recipient_id?: integer
note?: string or null
created_by_id?: integer

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      recipient_id?: number;
      note?: string | null;
      created_by_id?: number;
    };
  };
};