Work Periods Audit

This endpoint provides access to the audit trail for work period operations.

Overview

The Work Periods Audit API tracks all work period-related activities, creating a comprehensive history of work period update events. This audit trail is valuable for compliance, security monitoring, and activity tracking.

Audit Events

The system automatically records the following work period events:

Audit Information

Each audit record includes:

Event-Driven Architecture

The audit system uses an event-driven approach, listening for work period events and automatically creating audit records when work periods are updated. This ensures a complete and accurate history of all work period operations.

Endpoints

get /api/v3/workflow/work_periods_audit

get/api/v3/workflow/work_periods_audit

Return a paginated list of workflow/work_periods_audits

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
work_period_id?: unknown
editor_account_id?: unknown
comment_details?: unknown
previous_started_at?: unknown
previous_ended_at?: unknown
created_at?: unknown
work_period_id__in?: unknown
The related resources to include in the response. Allowed resources are:
- `work_period`
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;
    work_period_id?: any;
    editor_account_id?: any;
    comment_details?: any;
    previous_started_at?: any;
    previous_ended_at?: any;
    created_at?: any;
    work_period_id__in?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `work_period`
  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
work_period_id?: integer
editor_account_id?: integer
comment_details?: string
previous_started_at?: datetime
previous_ended_at?: datetime
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      work_period_id?: number;
      editor_account_id?: number;
      comment_details?: string;
      previous_started_at?: Date;
      previous_ended_at?: Date;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};