Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Financial Management

Change Events

5 endpoints5 implementedAll modules →
  1. GET /rest/v1.0/change_event/statusesList Change Event statuses
  2. GET /rest/v1.0/change_eventsList Change Events
  3. POST /rest/v1.0/change_eventsCreate Change Event
  4. GET /rest/v1.0/change_events/{id}Show Change Event
  5. PATCH /rest/v1.0/change_events/{id}Update Change Event
GET /rest/v1.0/change_event/statuses

List Change Event statuses

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • page
    integerquery
  • per_page
    integerquery
  • project_id
    integerqueryrequired

Response · 200 · object[]

  • default_status
    boolean
  • id
    integer
  • mapped_to_status
    string
  • name
    string
  • show_in_select
    boolean
GET /rest/v1.0/change_events

List Change Events

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[change_event_status_id][]
    integer[]query
  • filters[change_order_change_reason_id][]
    integer[]query
  • filters[change_type_id][]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[id]
    integer[]query
  • filters[include_deleted]
    stringquery
  • filters[origin_type][]
    string[]query
  • filters[updated_at]
    string (date)query
  • include_rfqs
    booleanquery

Response · 200 · object[]

  • id
    integer
  • number
    integer
  • alphanumeric_number
    string
  • origin_data
    string
  • origin_id
    string
  • title
    string
  • status
    string
  • project_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • event_type
    string
  • event_scope
    string
  • change_event_origin_id
    integer
  • change_event_origin_type
    string
  • rfi
    object
  • change_event_line_items
    object[]
  • change_order_change_reason
    object
  • change_event_status
    object
  • created_by
    object
  • attachments
    object[]
  • rfqs
    object[]
  • currency_configuration
    object
POST /rest/v1.0/change_events

Create Change Event

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Request body

  • change_event
    objectrequired
  • change_event_origin_id
    integer
  • change_event_origin_type
    string
  • origin_global_id
    string
  • attachments
    string[]

Response · 201 · object

  • id
    integer
  • number
    integer
  • alphanumeric_number
    string
  • origin_data
    string
  • origin_id
    string
  • title
    string
  • status
    string
  • project_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • event_type
    string
  • event_scope
    string
  • change_event_origin_id
    integer
  • change_event_origin_type
    string
  • rfi
    object
  • change_event_line_items
    object[]
  • change_order_change_reason
    object
  • change_event_status
    object
  • created_by
    object
  • attachments
    object[]
  • rfqs
    object[]
  • currency_configuration
    object
GET /rest/v1.0/change_events/{id}

Show Change Event

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • number
    integer
  • alphanumeric_number
    string
  • origin_data
    string
  • origin_id
    string
  • title
    string
  • status
    string
  • project_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • event_type
    string
  • event_scope
    string
  • change_event_origin_id
    integer
  • change_event_origin_type
    string
  • rfi
    object
  • change_event_line_items
    object[]
  • change_order_change_reason
    object
  • change_event_status
    object
  • created_by
    object
  • attachments
    object[]
  • rfqs
    object[]
  • currency_configuration
    object
PATCH /rest/v1.0/change_events/{id}

Update Change Event

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Request body

  • project_id
    integerrequired
  • change_event
    objectrequired
  • change_event_origin_id
    integer
  • change_event_origin_type
    string
  • origin_global_id
    string
  • attachments
    string[]

Response · 200 · object

  • id
    integer
  • number
    integer
  • alphanumeric_number
    string
  • origin_data
    string
  • origin_id
    string
  • title
    string
  • status
    string
  • project_id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • event_type
    string
  • event_scope
    string
  • change_event_origin_id
    integer
  • change_event_origin_type
    string
  • rfi
    object
  • change_event_line_items
    object[]
  • change_order_change_reason
    object
  • change_event_status
    object
  • created_by
    object
  • attachments
    object[]
  • rfqs
    object[]
  • currency_configuration
    object

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file