History reference

History endpoint authentication, parameters, request and response contracts.

Last updated: 10 November 2026

On this page

GET /api/p/{pid}/changes/{batch}/placement GET /api/p/{pid}/changes POST /api/p/{pid}/changes/{batch}/revert

Paths, methods, parameters and available schemas are generated from the OpenAPI document in the repository.

Note: These endpoints form the browser application contract and do not provide the same versioning assurance as v1. Use the versioned API for external integrations.

GET `/api/p/{pid}/changes/{batch}/placement`

Get placement changes

All placement and splice-location differences for an operation, continuing beyond the first HIST_PLACEMENT differences shown in the history row. Uses the same visibility as the history list: returns 403 if fiber data cannot be read.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

Name	Location	Type	Required
`pid`	path	integer	Yes
`batch`	path	string	Yes
`kapali`	query	integer	No

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

Field	Type	Required	Description
`detail`	ValidationError[]	No

For error meanings and client actions, see the error code glossary.

GET `/api/p/{pid}/changes`

Changes

Change stream (since) and history list. Both include only records from modules the reader can access.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

Name	Location	Type	Required
`pid`	path	integer	Yes
`limit`	query	integer	No
`since`	query	integer \| null	No
`before`	query	integer \| null	No
`paged`	query	integer	No
`kapali`	query	integer	No
`batch`	query	string \| null	No

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

Field	Type	Required	Description
`detail`	ValidationError[]	No

For error meanings and client actions, see the error code glossary.

POST `/api/p/{pid}/changes/{batch}/revert`

Undo operation

Undoes an operation, restoring each record to its preceding state. 1) Checks all records first. If a record has changed again since the operation, undo is rejected. 2) Applies two phases: records to delete first, then records to restore. This allows connection changes and port swaps within the same operation to be undone without an intermediate endpoint uniqueness conflict. 3) Shared integrity check: rejects undo if dependent records were added later, such as a device on a node or a feature in a layer.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

Name	Location	Type	Required
`pid`	path	integer	Yes
`batch`	path	string	Yes

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

Field	Type	Required	Description
`detail`	ValidationError[]	No

For error meanings and client actions, see the error code glossary.