API - Personalities

Personalities

No description given.

Endpoints

get/api/v3/talent/personalities

Return a paginated list of talent/personalities

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
created_by_id?: unknown
o1?: unknown
o2?: unknown
o3?: unknown
o4?: unknown
o5?: unknown
o6?: unknown
c1?: unknown
c2?: unknown
c3?: unknown
c4?: unknown
c5?: unknown
c6?: unknown
e1?: unknown
e2?: unknown
e3?: unknown
e4?: unknown
e5?: unknown
e6?: unknown
a1?: unknown
a2?: unknown
a3?: unknown
a4?: unknown
a5?: unknown
a6?: unknown
n1?: unknown
n2?: unknown
n3?: unknown
n4?: unknown
n5?: unknown
n6?: unknown
ox?: unknown
cx?: unknown
ex?: unknown
ax?: unknown
nx?: unknown
summary?: unknown
search?: unknown
The related resources to include in the response. Allowed resources are:
- `talent`
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;
    created_by_id?: any;
    o1?: any;
    o2?: any;
    o3?: any;
    o4?: any;
    o5?: any;
    o6?: any;
    c1?: any;
    c2?: any;
    c3?: any;
    c4?: any;
    c5?: any;
    c6?: any;
    e1?: any;
    e2?: any;
    e3?: any;
    e4?: any;
    e5?: any;
    e6?: any;
    a1?: any;
    a2?: any;
    a3?: any;
    a4?: any;
    a5?: any;
    a6?: any;
    n1?: any;
    n2?: any;
    n3?: any;
    n4?: any;
    n5?: any;
    n6?: any;
    ox?: any;
    cx?: any;
    ex?: any;
    ax?: any;
    nx?: any;
    summary?: any;
    search?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `talent`
  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
o1?: number
o2?: number
o3?: number
o4?: number
o5?: number
o6?: number
c1?: number
c2?: number
c3?: number
c4?: number
c5?: number
c6?: number
e1?: number
e2?: number
e3?: number
e4?: number
e5?: number
e6?: number
a1?: number
a2?: number
a3?: number
a4?: number
a5?: number
a6?: number
n1?: number
n2?: number
n3?: number
n4?: number
n5?: number
n6?: number
ox?: number
cx?: number
ex?: number
ax?: number
nx?: number
summary?: string
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      o1?: number;
      o2?: number;
      o3?: number;
      o4?: number;
      o5?: number;
      o6?: number;
      c1?: number;
      c2?: number;
      c3?: number;
      c4?: number;
      c5?: number;
      c6?: number;
      e1?: number;
      e2?: number;
      e3?: number;
      e4?: number;
      e5?: number;
      e6?: number;
      a1?: number;
      a2?: number;
      a3?: number;
      a4?: number;
      a5?: number;
      a6?: number;
      n1?: number;
      n2?: number;
      n3?: number;
      n4?: number;
      n5?: number;
      n6?: number;
      ox?: number;
      cx?: number;
      ex?: number;
      ax?: number;
      nx?: number;
      summary?: string;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/talent/personalities

Input Schema

object
data:
object
type: string
id: integer
attributes:
object
personality_string: string

Typescript

type InputSchema = {
  data: {
    type: string;
    id: number;
    attributes: { personality_string: string };
  };
};

patch/api/v3/talent/personalities/:id

Input Schema

object
id: integer
data:
object
type: string
attributes:
object
personality_string: string

Typescript

type InputSchema = {
  id: number;
  data: { type: string; attributes: { personality_string: string } };
};

delete/api/v3/talent/personalities/:resource_id

Delete the talent/personalities

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/talent/personalities/:resource_id

Show a specific talent/personalities

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
o1?: number
o2?: number
o3?: number
o4?: number
o5?: number
o6?: number
c1?: number
c2?: number
c3?: number
c4?: number
c5?: number
c6?: number
e1?: number
e2?: number
e3?: number
e4?: number
e5?: number
e6?: number
a1?: number
a2?: number
a3?: number
a4?: number
a5?: number
a6?: number
n1?: number
n2?: number
n3?: number
n4?: number
n5?: number
n6?: number
ox?: number
cx?: number
ex?: number
ax?: number
nx?: number
summary?: string
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      o1?: number;
      o2?: number;
      o3?: number;
      o4?: number;
      o5?: number;
      o6?: number;
      c1?: number;
      c2?: number;
      c3?: number;
      c4?: number;
      c5?: number;
      c6?: number;
      e1?: number;
      e2?: number;
      e3?: number;
      e4?: number;
      e5?: number;
      e6?: number;
      a1?: number;
      a2?: number;
      a3?: number;
      a4?: number;
      a5?: number;
      a6?: number;
      n1?: number;
      n2?: number;
      n3?: number;
      n4?: number;
      n5?: number;
      n6?: number;
      ox?: number;
      cx?: number;
      ex?: number;
      ax?: number;
      nx?: number;
      summary?: string;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};