API - Plannings

Plannings

Manage plannings of production offices.

Endpoints

get/api/v3/office/plannings

Return a paginated list of office/plannings

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
name?: unknown
organizational_unit?: unknown
total_time?: unknown
timezone?: unknown
created_at?: unknown
updated_at?: unknown
schedule?: unknown
working_hour_per_day?: unknown
name__match?: unknown
with_employees?: unknown
The related resources to include in the response. Allowed resources are:
- `employees`
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;
    name?: any;
    organizational_unit?: any;
    total_time?: any;
    timezone?: any;
    created_at?: any;
    updated_at?: any;
    schedule?: any;
    working_hour_per_day?: any;
    name__match?: any;
    with_employees?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `employees`
  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
name?: string
organizational_unit?: string
total_time?: integer
timezone?: string
created_at?: datetime
updated_at?: datetime
schedule?: open struct
working_hour_per_day?: number
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      organizational_unit?: string;
      total_time?: number;
      timezone?: string;
      created_at?: Date;
      updated_at?: Date;
      schedule?: Record<string, any>;
      working_hour_per_day?: number;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/office/plannings

Create a new office/plannings

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
name?: string
organizational_unit?: string
total_time?: integer
timezone?: string
created_at?: datetime
updated_at?: datetime
schedule?: open struct
working_hour_per_day?: number

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      organizational_unit?: string;
      total_time?: number;
      timezone?: string;
      created_at?: Date;
      updated_at?: Date;
      schedule?: Record<string, any>;
      working_hour_per_day?: number;
    };
  };
};

delete/api/v3/office/plannings/:resource_id

Delete the office/plannings

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/office/plannings/:resource_id

Show a specific office/plannings

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
name?: string
organizational_unit?: string
total_time?: integer
timezone?: string
created_at?: datetime
updated_at?: datetime
schedule?: open struct
working_hour_per_day?: number
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      organizational_unit?: string;
      total_time?: number;
      timezone?: string;
      created_at?: Date;
      updated_at?: Date;
      schedule?: Record<string, any>;
      working_hour_per_day?: number;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/office/plannings/:resource_id

Update a office/plannings

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
organizational_unit?: string
timezone?: string
schedule?: open struct
working_hour_per_day?: number

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      organizational_unit?: string;
      timezone?: string;
      schedule?: Record<string, any>;
      working_hour_per_day?: number;
    };
  };
};