retire_project¶

photonforge.pda.retire_project(name=None, *, project_id=None)[source]¶

Retire a project document by name or identifier.

Parameters:

name (str | None) – Project name.
project_id (DocumentId | ReadOnlyURL | None) – Project document ID or reference URL.

Returns:

None.

Return type:

object

Important

Projects that are released (given a version) cannot be retired.