Skip to content

plm parts

plm parts

Manage parts

Usage

Terminal window
plm parts

Subcommands

Agent-readable summary
{
"command": "plm parts",
"description": "Manage parts",
"arguments": [],
"options": [],
"subcommands": [
"list",
"get",
"create",
"update",
"delete",
"bulk-delete",
"bulk-obsolete",
"revisions",
"relationships",
"impact-analysis",
"hierarchy",
"dependencies",
"where-used",
"numbering-scheme",
"next-number",
"validate-number",
"reserve"
]
}

plm parts list

Usage

Terminal window
plm parts list

Options

  • -f, --filter <kv...> — key=value filters
  • --page <n> — page number (1-based)
  • --limit <n> — results per page (max 100)
  • --offset <n> — row offset (alternative to —page)
  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts list",
"description": null,
"arguments": [],
"options": [
{
"flags": "-f, --filter <kv...>",
"description": "key=value filters",
"required": false,
"default": null
},
{
"flags": "--page <n>",
"description": "page number (1-based)",
"required": false,
"default": null
},
{
"flags": "--limit <n>",
"description": "results per page (max 100)",
"required": false,
"default": null
},
{
"flags": "--offset <n>",
"description": "row offset (alternative to --page)",
"required": false,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts get

Usage

Terminal window
plm parts get <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts get",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts create

Create a part

Usage

Terminal window
plm parts create

Options

  • --file <path> — JSON/YAML file with the part payload (pn, description, revision, attributes, etc.)
  • --format <fmt> — output format (default: "json")
  • --bypass-validation — skip active-scheme pattern validation (for legacy/migration part numbers). Server enforces admin role.
Agent-readable summary
{
"command": "plm parts create",
"description": "Create a part",
"arguments": [],
"options": [
{
"flags": "--file <path>",
"description": "JSON/YAML file with the part payload (pn, description, revision, attributes, etc.)",
"required": false,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
},
{
"flags": "--bypass-validation",
"description": "skip active-scheme pattern validation (for legacy/migration part numbers). Server enforces admin role.",
"required": false,
"default": null
}
],
"subcommands": []
}

plm parts update

Update an existing part by part number

Usage

Terminal window
plm parts update <partNumber>

Options

  • --file <path> — JSON/YAML file with the fields to update (partial update; only included keys are changed)
  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts update",
"description": "Update an existing part by part number",
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--file <path>",
"description": "JSON/YAML file with the fields to update (partial update; only included keys are changed)",
"required": false,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts delete

Usage

Terminal window
plm parts delete <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts delete",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts bulk-delete

Usage

Terminal window
plm parts bulk-delete

Options

  • --file <path> required — JSON file with an array of part numbers, or an object { partNumbers: […] }
  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts bulk-delete",
"description": null,
"arguments": [],
"options": [
{
"flags": "--file <path>",
"description": "JSON file with an array of part numbers, or an object { partNumbers: [...] }",
"required": true,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts bulk-obsolete

Usage

Terminal window
plm parts bulk-obsolete

Options

  • --file <path> required — JSON file with an array of part numbers, or an object { partNumbers: […] }
  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts bulk-obsolete",
"description": null,
"arguments": [],
"options": [
{
"flags": "--file <path>",
"description": "JSON file with an array of part numbers, or an object { partNumbers: [...] }",
"required": true,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts revisions

Usage

Terminal window
plm parts revisions <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts revisions",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts relationships

Manage part relationships

Usage

Terminal window
plm parts relationships

Subcommands

Agent-readable summary
{
"command": "plm parts relationships",
"description": "Manage part relationships",
"arguments": [],
"options": [],
"subcommands": [
"list",
"add",
"remove"
]
}

plm parts relationships list

Usage

Terminal window
plm parts relationships list <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts relationships list",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts relationships add

Usage

Terminal window
plm parts relationships add <partNumber> <target> <type>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts relationships add",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
},
{
"name": "target",
"required": true,
"variadic": false,
"description": ""
},
{
"name": "type",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts relationships remove

Usage

Terminal window
plm parts relationships remove <partNumber> <target> <type>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts relationships remove",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
},
{
"name": "target",
"required": true,
"variadic": false,
"description": ""
},
{
"name": "type",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts impact-analysis

Usage

Terminal window
plm parts impact-analysis <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts impact-analysis",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts hierarchy

Usage

Terminal window
plm parts hierarchy <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts hierarchy",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts dependencies

Usage

Terminal window
plm parts dependencies <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts dependencies",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts where-used

Usage

Terminal window
plm parts where-used <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts where-used",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts numbering-scheme

Show the org’s active part-numbering scheme (formula, required variables)

Usage

Terminal window
plm parts numbering-scheme

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts numbering-scheme",
"description": "Show the org's active part-numbering scheme (formula, required variables)",
"arguments": [],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts next-number

Usage

Terminal window
plm parts next-number

Options

  • --type <type> — shorthand for —var CATEGORY=<type>
  • --var <kv...> — scheme variable as KEY=VALUE (repeatable). Required when the active scheme declares required variables.
  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts next-number",
"description": null,
"arguments": [],
"options": [
{
"flags": "--type <type>",
"description": "shorthand for --var CATEGORY=<type>",
"required": false,
"default": null
},
{
"flags": "--var <kv...>",
"description": "scheme variable as KEY=VALUE (repeatable). Required when the active scheme declares required variables.",
"required": false,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts validate-number

Usage

Terminal window
plm parts validate-number <partNumber>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts validate-number",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm parts reserve

Usage

Terminal window
plm parts reserve <partNumber>

Options

  • --workspace <id> — workspace id (defaults to whoami.workspaceId — the personal workspace)
  • --ttl <seconds> — reservation TTL in seconds
  • --purpose <text> — free-form note describing what the reservation is for
  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm parts reserve",
"description": null,
"arguments": [
{
"name": "partNumber",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--workspace <id>",
"description": "workspace id (defaults to whoami.workspaceId — the personal workspace)",
"required": false,
"default": null
},
{
"flags": "--ttl <seconds>",
"description": "reservation TTL in seconds",
"required": false,
"default": null
},
{
"flags": "--purpose <text>",
"description": "free-form note describing what the reservation is for",
"required": false,
"default": null
},
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}