Skip to content

Progress Platform

Main Navigation Overview User Manual Admin & Developers Technical Reference

Appearance

Sidebar Navigation

Technical Reference

Overview

DB Collections

Broker Subjects

API Reference

Overview

Production

GET /job

GET /job/{job_key}

GET /job/{job_key}/time

GET /job-assignment

GET /queue/site/{site_key}

GET /work-order

GET /work-order/{wo_key}

GET /work-order/{wo_key}/traceability

GET /work-order-search-opts

GET /work-session

POST /jobs/start

POST /job/update

POST /work-order

PATCH /work-order/{wo_key}

PATCH /work-order/{wo_key}/update-quantities

PUT /queue

PUT /queue/operator/{operator_key}

DELETE /work-order/{wo_key}

Warehouse

GET /inventory

GET /inventory/count-assignment

GET /inventory/count-position-status

GET /inventory/count-record

GET /inventory/count-session

GET /inventory/count-session/{session_key}

GET /inventory/count-session/{session_key}/completed-positions

GET /inventory/count-session/{session_key}/processed-records

GET /movement

GET /movement-list

GET /movement/latest-positions

GET /movement/latest-products

GET /position

GET /position/{position_key}

GET /position-hierarchy

POST /inventory/count-assignment

POST /inventory/count-record/import

POST /inventory/count-session

POST /movement

POST /movement-list

POST /position

PATCH /position/{position_key}

PUT /inventory/count-session/{session_key}

DELETE /inventory/count-assignment

DELETE /inventory/count-session

DELETE /position/{position_key}

Serial

GET /serial

GET /serial/{serial_key}

GET /serial/{serial_key}/dhr

GET /serial-batch

GET /serial-children

GET /serial-code

GET /serial-code/verify-free

GET /serial-field

GET /serial-hierarchy

GET /serial-parents

GET /serial-selection

GET /component-batch

GET /wip-serial

Collaboration

GET /issue

GET /issue-type

GET /message

GET /task

GET /task/{task_key}

GET /task-type

POST /issue-type

POST /task-type

PATCH /issue-type/{issue_type_key}

PUT /task-type/{type_key}

DELETE /issue-type/{issue_type_key}

DELETE /task-type/{type_key}

Quality

GET /field

GET /list

GET /print-template

GET /print-template/{template_key}

POST /field

POST /list/{field_key}

POST /print-job

POST /print-template

POST /update-template-assignments

PUT /field/{field_key}

PUT /print-template

DELETE /field/{field_key}

DELETE /list/{field_key}

DELETE /print-template/{template_key}

Traceability

GET /batch/{batch_key}

GET /batch/{batch_key}/serials

GET /event

GET /wip

POST /batch/temp-data

POST /event

POST /event/bulk

POST /job/{job_key}/heartbeat

PUT /batch/{batch_key}/serial-temp-links

Process

GET /operation

GET /phase

GET /procedure/{phase_key}

GET /product/{product_key}/process

GET /step/{step_key}/media

POST /operation

POST /operation/{operation_key}/copy

POST /product/{product_key}/counter/copy

POST /product/{product_key}/process/copy

POST /step/{step_key}/media

PATCH /operation/{operation_key}

PUT /product/{product_key}/process

DELETE /operation/{operation_key}

Product

GET /{product_key}

GET /{product_key}/bom

GET /{product_key}/stats

POST /copy

POST /{product_key}/doc

PATCH /{product_key}

PUT /{product_key}

PUT /{product_key}/bom

PUT /{product_key}/image

DELETE /{product_key}

DELETE /{product_key}/doc/{doc_name}

DELETE /{product_key}/image

Organization

GET /api-token

GET /department

GET /user

GET /user/api-tokens

POST /user

PATCH /user/{user_key}

PUT /user/{user_key}/image

PUT /user/{user_key}/password

DELETE /api-token/{token_key}

DELETE /user/{user_key}

DELETE /user/{user_key}/password

Administration

DELETE /force-delete-work-order/{work_order_key}

DELETE /reset/inventory

DELETE /reset/prod

Configuration

GET /config

GET /counter

GET /custom-data

GET /custom-data/{key}

GET /tag

POST /counter

POST /tag

POST /tag/update-connections

PATCH /config

PUT /config/{key}/file

PUT /counter/{counter_key}

PUT /custom-data/{key}

DELETE /counter/{counter_key}

DELETE /custom-data/{key}

Attachments

GET /media/{media_key}

POST /files

POST /media/create

PATCH /media/{media_key}

DELETE /files

DELETE /media/{media_key}

Security

GET /whoami

POST /auth

POST /session

POST /user/{user_key}/verify

DELETE /session/{session_key}

Notification

GET /notification/{topic}

POST /notification/ticket

Events Reference

Overview

Production

ActiveBatchChangedEvent

BatchCompletedEvent

BatchCompleted Fanout

BatchCreatedEvent

BatchReleasedEvent

JobBackOnlineEvent

JobClosedEvent

JobPausedEvent

JobPausedOfflineEvent

JobPauseForcedEvent

JobResumedEvent

JobStartedEvent

QueueUpdatedEvent

StepCompletedEvent

StepEditedEvent

WorkOrderStartedEvent

Inventory

AssignmentCompletedEvent

AssignmentStartedEvent

CountAppliedEvent

CountCanceledEvent

CountCompletedEvent

CountDiscardedEvent

CountImportedEvent

CountSessionAppliedEvent

CountSessionCompletedEvent

CountSessionConfirmedEvent

CountSessionResumedEvent

CountSessionStartedEvent

CountStartedEvent

InventoryChangedEvent

MovementCompletedEvent

MovementPlannedEvent

MovementReversedEvent

MovementUpdatedEvent

PositionConfirmedEmptyEvent

WarehouseListClosed

Serial

SerialCreatedEvent

SerialDeletedEvent

SerialLinkedEvent

SerialReleasedEvent

SerialUnlinkedEvent

SerialUpdatedEvent

Collaboration

IssueClosedEvent

IssueCreatedEvent

IssueDeletedEvent

IssueReopenedEvent

IssueUpdatedEvent

MessageDeletedEvent

MessagePostedEvent

MessageUpdatedEvent

TaskCanceledEvent

TaskCompletedEvent

TaskCreatedEvent

TaskLinkedEvent

TaskReopenedEvent

TaskSuspendedEvent

TaskUnlinkedEvent

TaskUpdatedEvent

WIP

WIPBookedEvent

WIPDeclaredEvent

WIPRemovedEvent

WIPUnbookedEvent

Work Session

WorkSessionCanceledEvent

WorkSessionClosedEvent

WorkSessionCreatedEvent

Admin

ExtraUpdateRequestedEvent

CLI Reference

Overview

progress init

progress restore

progress tap

On this page

POST /jobs/start

Edit this page on GitHub

Last updated:

Pager

Previous pageGET /work-session

Next pagePOST /job/update

Released under the Apache 2.0 License.

Copyright © 2026 Progress Platform Contributors.