SOLIDWORKS Manage command reference
Use these commands in PDMShell to read and update Manage data. Set up your connection before running a command.
Start here
- Find the operation below.
- Download its request template into
C:\Scripts\Manageand replace the example IDs and field names with your values. - Copy the PDMShell command.
-queryFileand-bodyFileread the template; they do not save the response. -variable Resultstores the response for later script steps as${global.Result}.
Use globals inside template string values, such as "record_guid": "${global.RecordGuid}", when values change between runs. You do not need to edit the file each time. See response selection and arrays.
POST operations change Manage data. Run only the operation you intend. Example IDs, GUIDs and field names must be replaced before use.
Availability: the connector requires PDMShell 4.1.60 or newer. The next installer build restricts requests to these 97 endpoints and their listed methods. Six download operations are marked Not available through manage because they return files rather than JSON.
Find an operation
Authentication
Authentication/Authenticate
Set up automatic sign-in to Manage.
Run the configuration command and enter your Manage sign-in details. PDMShell signs in automatically when you run a request.
manage -configure
Authentication/License
List available license IDs for your connection.
manage -endpoint Authentication/License -method GET -variable Result
No request file needed.
BOM
BOM/AddItemsInBom
Add a record to a BOM with a quantity.
manage -endpoint BOM/AddItemsInBom -method POST -bodyFile "C:\Scripts\Manage\BOM-AddItemsInBom.json" -variable Result
Download request template · Save as BOM-AddItemsInBom.json.
View request JSON
{
"config_id": 1,
"parent_object_id": 42,
"parent_record_id": 11,
"child_object_id": 42,
"quantity": 2,
"view_name": "REPLACE_WITH_BOM_VIEW",
"child_record_id": 11
}
BOM/AddTextLineBom
Add a text line to a BOM.
manage -endpoint BOM/AddTextLineBom -method POST -bodyFile "C:\Scripts\Manage\BOM-AddTextLineBom.json" -variable Result
Download request template · Save as BOM-AddTextLineBom.json.
View request JSON
{
"object_id": 42,
"record_id": 11,
"config_id": 1,
"view_name": "REPLACE_WITH_BOM_VIEW"
}
BOM/ChangeMarkers
Change BOM item markers.
manage -endpoint BOM/ChangeMarkers -method POST -bodyFile "C:\Scripts\Manage\BOM-ChangeMarkers.json" -variable Result
Download request template · Save as BOM-ChangeMarkers.json.
View request JSON
{
"config_id": 1,
"object_id": 42,
"record_id": 11,
"marker_update_option": 0
}
BOM/ChangeQuantity
Change quantities for selected BOM instances.
manage -endpoint BOM/ChangeQuantity -method POST -bodyFile "C:\Scripts\Manage\BOM-ChangeQuantity.json" -variable Result
Download request template · Save as BOM-ChangeQuantity.json.
View request JSON
{
"object_id": 42,
"config_id": 1,
"config_instance_ids": [
501,
502
],
"quantity": 2,
"record_id": 11
}
BOM/ChangeSourceDefaultConfiguration
Change the source configuration for selected BOM instances.
Confirm the required config_label format with your Manage administrator before using this operation.
manage -endpoint BOM/ChangeSourceDefaultConfiguration -method POST -bodyFile "C:\Scripts\Manage\BOM-ChangeSourceDefaultConfiguration.json" -variable Result
Download request template · Save as BOM-ChangeSourceDefaultConfiguration.json.
View request JSON
{
"object_id": 42,
"config_instance_ids": [
501,
502
],
"config_label": [
501,
502
],
"record_id": 11
}
BOM/Configurations
List a record’s BOM configurations.
manage -endpoint BOM/Configurations -method GET -queryFile "C:\Scripts\Manage\BOM-Configurations.json" -variable Result
Download request template · Save as BOM-Configurations.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555"
}
BOM/Fields
Read fields for a BOM view.
manage -endpoint BOM/Fields -method GET -queryFile "C:\Scripts\Manage\BOM-Fields.json" -variable Result
Download request template · Save as BOM-Fields.json.
View request JSON
{
"config_id": 1,
"view_name": "REPLACE_WITH_BOM_VIEW",
"format_view_id": 1
}
BOM/FormatView
List available BOM view formats.
manage -endpoint BOM/FormatView -method GET -variable Result
No request file needed.
BOM/Records
Read BOM rows for a record and configuration.
manage -endpoint BOM/Records -method GET -queryFile "C:\Scripts\Manage\BOM-Records.json" -variable Result
Download request template · Save as BOM-Records.json.
View request JSON
{
"config_id": 1,
"object_id": 42,
"record_id": 11,
"version_index": 1,
"get_latest": true,
"level": 1,
"format_view_id": 1,
"view_name": "REPLACE_WITH_BOM_VIEW"
}
BOM/RemoveItemsBom
Remove selected instances from a BOM.
manage -endpoint BOM/RemoveItemsBom -method POST -bodyFile "C:\Scripts\Manage\BOM-RemoveItemsBom.json" -variable Result
Download request template · Save as BOM-RemoveItemsBom.json.
View request JSON
{
"config_instance_ids": [
501,
502
],
"object_id": 42,
"record_id": 11
}
BOM/SaveBomChanges
Save edited BOM properties.
Use instance IDs and field metadata from BOM/Records. Keep each field’s ID, type and flags.
manage -endpoint BOM/SaveBomChanges -method POST -bodyFile "C:\Scripts\Manage\BOM-SaveBomChanges.json" -variable Result
Download request template · Save as BOM-SaveBomChanges.json.
View request JSON
{
"config_id": 1,
"object_id": 42,
"record_id": 11,
"version_index": "1",
"list_items": [
{
"Name": "configInstanceId",
"Value": "501",
"CustomProperties": [
{
"Id": 101,
"Name": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"Value": "Example value",
"TypeId": 1,
"AllowMultipleItems": false,
"IsReference": false,
"IsMapped": false,
"Required": false
}
]
}
],
"view_name": "REPLACE_WITH_BOM_VIEW"
}
BOM/Variants
List BOM variants for an object.
manage -endpoint BOM/Variants -method GET -queryFile "C:\Scripts\Manage\BOM-Variants.json" -variable Result
Download request template · Save as BOM-Variants.json.
View request JSON
{
"object_id": 42
}
BOM/Versions
List BOM versions for a record.
manage -endpoint BOM/Versions -method GET -queryFile "C:\Scripts\Manage\BOM-Versions.json" -variable Result
Download request template · Save as BOM-Versions.json.
View request JSON
{
"object_id": 42,
"record_id": 11
}
BOM/Views
List views for a BOM configuration.
manage -endpoint BOM/Views -method GET -queryFile "C:\Scripts\Manage\BOM-Views.json" -variable Result
Download request template · Save as BOM-Views.json.
View request JSON
{
"config_id": 1
}
BOM/WhereUsed
Find where a record is used.
manage -endpoint BOM/WhereUsed -method GET -queryFile "C:\Scripts\Manage\BOM-WhereUsed.json" -variable Result
Download request template · Save as BOM-WhereUsed.json.
View request JSON
{
"object_id": 42,
"record_id": 11,
"version": -100
}
BOM/WhereUsedFromParentKey
Read the next level of where-used results from a parent key.
manage -endpoint BOM/WhereUsedFromParentKey -method GET -queryFile "C:\Scripts\Manage\BOM-WhereUsedFromParentKey.json" -variable Result
Download request template · Save as BOM-WhereUsedFromParentKey.json.
View request JSON
{
"key": "REPLACE_WITH_PARENT_KEY",
"object_id": 42,
"record_id": 11,
"version": -100
}
File
File/AddRelatedFileToFolder
Upload a local file to a record’s related-file folder.
Choose file_structure_id from Objects/RelatedFiles. Replace the upload path with your local file. Maximum file size: 16 MiB.
manage -endpoint File/AddRelatedFileToFolder -method POST -bodyFile "C:\Scripts\Manage\File-AddRelatedFileToFolder.json" -upload "C:\Exports\example.pdf" -variable Result
Download request template · Save as File-AddRelatedFileToFolder.json.
View request JSON
{
"object_id": 42,
"record_id": 11,
"file_structure_id": -42
}
File/ExportRelatedFiles
Download a record’s related files.
Not available through manage: this operation returns a file. See the optional PowerShell download helper.
Save-ManageDownload -Endpoint "File/ExportRelatedFiles" -QueryFile "C:\Scripts\Manage\File-ExportRelatedFiles.json" -OutFile "C:\Exports\ExportRelatedFiles.bin"
Download request template · Save as File-ExportRelatedFiles.json.
View request JSON
{
"record_id": 11,
"object_id": 42,
"get_all_revisions": false
}
File/ExportRelatedFilesByIds
Download selected related files by their IDs.
Not available through manage: this operation returns a file. See the optional PowerShell download helper.
Save-ManageDownload -Endpoint "File/ExportRelatedFilesByIds" -QueryFile "C:\Scripts\Manage\File-ExportRelatedFilesByIds.json" -OutFile "C:\Exports\ExportRelatedFilesByIds.bin"
Download request template · Save as File-ExportRelatedFilesByIds.json.
View request JSON
{
"record_id": 11,
"object_id": 42,
"file_ids": "101,102"
}
File/ExportTemplates
List available file-export templates.
manage -endpoint File/ExportTemplates -method GET -queryFile "C:\Scripts\Manage\File-ExportTemplates.json" -variable Result
Download request template · Save as File-ExportTemplates.json.
View request JSON
{
"object_id": 42
}
File/FilePath
Read the file path configured for a Manage object.
manage -endpoint File/FilePath -method GET -queryFile "C:\Scripts\Manage\File-FilePath.json" -variable Result
Download request template · Save as File-FilePath.json.
View request JSON
{
"object_id": 42
}
File/FileVersion
List a record’s file versions.
manage -endpoint File/FileVersion -method GET -queryFile "C:\Scripts\Manage\File-FileVersion.json" -variable Result
Download request template · Save as File-FileVersion.json.
View request JSON
{
"object_id": 42,
"record_id": 11
}
File/PrimaryFile
Download primary files for selected records.
Not available through manage: this operation returns a file. See the optional PowerShell download helper.
Save-ManageDownload -Endpoint "File/PrimaryFile" -QueryFile "C:\Scripts\Manage\File-PrimaryFile.json" -OutFile "C:\Exports\PrimaryFile.bin"
Download request template · Save as File-PrimaryFile.json.
View request JSON
{
"record_id": "11,12",
"object_id": 42,
"file_version": 0
}
File/TemplateFiles
Download files using an export template.
Not available through manage: this operation returns a file. See the optional PowerShell download helper.
Save-ManageDownload -Endpoint "File/TemplateFiles" -QueryFile "C:\Scripts\Manage\File-TemplateFiles.json" -OutFile "C:\Exports\TemplateFiles.bin"
Download request template · Save as File-TemplateFiles.json.
View request JSON
{
"record_id": "11,12",
"object_id": 42,
"template_id": 1
}
Objects
Objects/AddReferencesToFolder
Add a record reference to a reference folder.
manage -endpoint Objects/AddReferencesToFolder -method POST -bodyFile "C:\Scripts\Manage\Objects-AddReferencesToFolder.json" -variable Result
Download request template · Save as Objects-AddReferencesToFolder.json.
View request JSON
{
"record_id": 11,
"object_id": 42,
"source_object_id": 42,
"source_record_id": 11,
"folder_id": 1
}
Objects/CreateLinkedRecords
Create linked records from selected record IDs.
manage -endpoint Objects/CreateLinkedRecords -method POST -bodyFile "C:\Scripts\Manage\Objects-CreateLinkedRecords.json" -variable Result
Download request template · Save as Objects-CreateLinkedRecords.json.
View request JSON
{
"object_id": 42,
"list_record_ids": [
501,
502
]
}
Objects/IsPdmLoggedIn
Check whether Manage is signed in to PDM for an object.
manage -endpoint Objects/IsPdmLoggedIn -method GET -queryFile "C:\Scripts\Manage\Objects-IsPdmLoggedIn.json" -variable Result
Download request template · Save as Objects-IsPdmLoggedIn.json.
View request JSON
{
"object_id": 42
}
Objects/LogInToPdm
Sign Manage in to PDM for an object.
Set the PdmPassword global before running. This GET request signs in to PDM and sends the password in the URL; use HTTPS and protect server logs. Configure the returned PDM token if your server requires it.
manage -endpoint Objects/LogInToPdm -method GET -queryFile "C:\Scripts\Manage\Objects-LogInToPdm.json" -variable Result
Download request template · Save as Objects-LogInToPdm.json.
View request JSON
{
"object_id": 42,
"pdm_password": "${global.PdmPassword}"
}
Objects/Modules
List Manage modules.
manage -endpoint Objects/Modules -method GET -variable Result
No request file needed.
Objects/ObjectById
Read an object by its ID.
manage -endpoint Objects/ObjectById -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectById.json" -variable Result
Download request template · Save as Objects-ObjectById.json.
View request JSON
{
"object_id": 42
}
Objects/ObjectBySystemName
Find an object by its system name.
manage -endpoint Objects/ObjectBySystemName -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectBySystemName.json" -variable Result
Download request template · Save as Objects-ObjectBySystemName.json.
View request JSON
{
"system_name": "REPLACE_WITH_OBJECT_SYSTEM_NAME"
}
Objects/ObjectFieldGroupByIds
Read a field group using its object and group IDs.
manage -endpoint Objects/ObjectFieldGroupByIds -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectFieldGroupByIds.json" -variable Result
Download request template · Save as Objects-ObjectFieldGroupByIds.json.
View request JSON
{
"object_id": 42,
"group_object_id": 42
}
Objects/ObjectFieldGroups
List object field groups.
manage -endpoint Objects/ObjectFieldGroups -method GET -variable Result
No request file needed.
Objects/ObjectFieldGroupsByObjectId
List field groups for one object.
manage -endpoint Objects/ObjectFieldGroupsByObjectId -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectFieldGroupsByObjectId.json" -variable Result
Download request template · Save as Objects-ObjectFieldGroupsByObjectId.json.
View request JSON
{
"object_id": 42
}
Objects/ObjectRecords
List or search records in an object.
manage -endpoint Objects/ObjectRecords -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectRecords.json" -variable Result
Download request template · Save as Objects-ObjectRecords.json.
View request JSON
{
"object_id": 42,
"show_all": true,
"include_subfolders": false,
"page_number": 1,
"page_size": 50,
"fields_name": "",
"simple_text": "",
"include_custom_fields": false
}
Objects/ObjectRecordsAdvancedSearch
Search records using advanced field conditions.
Ask your Manage administrator for valid fields and conditions expressions for your server.
manage -endpoint Objects/ObjectRecordsAdvancedSearch -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectRecordsAdvancedSearch.json" -variable Result
Download request template · Save as Objects-ObjectRecordsAdvancedSearch.json.
View request JSON
{
"object_id": 42,
"show_all": true,
"include_subfolders": false,
"page_number": 1,
"page_size": 50,
"fields": "REPLACE_WITH_ADVANCED_SEARCH_FIELDS",
"conditions": "REPLACE_WITH_ADVANCED_SEARCH_CONDITIONS",
"include_custom_fields": false
}
Objects/ObjectRecordValues
Read a record’s field values.
manage -endpoint Objects/ObjectRecordValues -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectRecordValues.json" -variable Result
Download request template · Save as Objects-ObjectRecordValues.json.
View request JSON
{
"object_id": 42,
"record_id": 11
}
Objects/Objects
List Manage objects.
manage -endpoint Objects/Objects -method GET -variable Result
No request file needed.
Objects/ObjectStructure
Read a module or section’s object structure.
manage -endpoint Objects/ObjectStructure -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectStructure.json" -variable Result
Download request template · Save as Objects-ObjectStructure.json.
View request JSON
{
"module_id": 1,
"section_id": 1,
"level": 1
}
Objects/ObjectTree
Read the folder tree for an object.
manage -endpoint Objects/ObjectTree -method GET -queryFile "C:\Scripts\Manage\Objects-ObjectTree.json" -variable Result
Download request template · Save as Objects-ObjectTree.json.
View request JSON
{
"object_id": 42
}
Objects/Recent
List recent records.
manage -endpoint Objects/Recent -method GET -variable Result
No request file needed.
Objects/ReferenceFolder
List reference folders for an object.
manage -endpoint Objects/ReferenceFolder -method GET -queryFile "C:\Scripts\Manage\Objects-ReferenceFolder.json" -variable Result
Download request template · Save as Objects-ReferenceFolder.json.
View request JSON
{
"object_id": 42
}
Objects/ReferenceRecords
List records in a reference folder.
manage -endpoint Objects/ReferenceRecords -method GET -queryFile "C:\Scripts\Manage\Objects-ReferenceRecords.json" -variable Result
Download request template · Save as Objects-ReferenceRecords.json.
View request JSON
{
"record_id": 11,
"object_id": 42,
"folder_id": 1
}
Objects/RelatedFiles
List a record’s related files and folders.
manage -endpoint Objects/RelatedFiles -method GET -queryFile "C:\Scripts\Manage\Objects-RelatedFiles.json" -variable Result
Download request template · Save as Objects-RelatedFiles.json.
View request JSON
{
"record_id": 11,
"object_id": 42,
"show_all_revisions": false
}
Objects/Shortcuts
List shortcuts, optionally including email folders.
manage -endpoint Objects/Shortcuts -method GET -queryFile "C:\Scripts\Manage\Objects-Shortcuts.json" -variable Result
Download request template · Save as Objects-Shortcuts.json.
View request JSON
{
"include_email_folders": false
}
Objects/SimpleSearchFields
List fields available for a simple record search.
manage -endpoint Objects/SimpleSearchFields -method GET -queryFile "C:\Scripts\Manage\Objects-SimpleSearchFields.json" -variable Result
Download request template · Save as Objects-SimpleSearchFields.json.
View request JSON
{
"object_id": 42
}
Objects/SpecialObjects
Read special sections for an object.
manage -endpoint Objects/SpecialObjects -method GET -queryFile "C:\Scripts\Manage\Objects-SpecialObjects.json" -variable Result
Download request template · Save as Objects-SpecialObjects.json.
View request JSON
{
"object_id": 42
}
Processes
Processes/AddAffectedItemsInProcess
Add records as affected items in a process stage.
manage -endpoint Processes/AddAffectedItemsInProcess -method POST -bodyFile "C:\Scripts\Manage\Processes-AddAffectedItemsInProcess.json" -variable Result
Download request template · Save as Processes-AddAffectedItemsInProcess.json.
View request JSON
{
"process_object_id": 42,
"process_record_id": 11,
"record_ids": [
501,
502
],
"child_object_id": 42,
"process_stage_id": 1
}
Processes/GetAffectedItemsInProcess
List affected items in a process.
manage -endpoint Processes/GetAffectedItemsInProcess -method GET -queryFile "C:\Scripts\Manage\Processes-GetAffectedItemsInProcess.json" -variable Result
Download request template · Save as Processes-GetAffectedItemsInProcess.json.
View request JSON
{
"object_id": 42,
"record_id": 11,
"show_all": true
}
Processes/RemoveAffectedItemsInProcess
Remove affected items from a process stage.
manage -endpoint Processes/RemoveAffectedItemsInProcess -method POST -bodyFile "C:\Scripts\Manage\Processes-RemoveAffectedItemsInProcess.json" -variable Result
Download request template · Save as Processes-RemoveAffectedItemsInProcess.json.
View request JSON
{
"process_object_id": 42,
"process_record_id": 11,
"record_ids": [
501,
502
],
"child_object_id": 42,
"process_stage_id": 1
}
Projects
Projects/AddDeliverablesToProjectStage
Add records as deliverables to a project stage.
manage -endpoint Projects/AddDeliverablesToProjectStage -method POST -bodyFile "C:\Scripts\Manage\Projects-AddDeliverablesToProjectStage.json" -variable Result
Download request template · Save as Projects-AddDeliverablesToProjectStage.json.
View request JSON
{
"project_object_id": 42,
"project_record_id": 11,
"record_ids": [
501,
502
],
"object_id": 42,
"project_stage_id": 1
}
Projects/AddResourcesInProjectStage
Assign users to a project stage.
manage -endpoint Projects/AddResourcesInProjectStage -method POST -bodyFile "C:\Scripts\Manage\Projects-AddResourcesInProjectStage.json" -variable Result
Download request template · Save as Projects-AddResourcesInProjectStage.json.
View request JSON
{
"project_stage_id": 1,
"project_object_id": 42,
"record_id": 11,
"user_ids": [
501,
502
]
}
Projects/GetProjectStages
List stages for a project.
manage -endpoint Projects/GetProjectStages -method GET -queryFile "C:\Scripts\Manage\Projects-GetProjectStages.json" -variable Result
Download request template · Save as Projects-GetProjectStages.json.
View request JSON
{
"project_object_id": 42,
"record_id": 11
}
Projects/GetProjectTemplates
List templates for creating projects.
manage -endpoint Projects/GetProjectTemplates -method GET -queryFile "C:\Scripts\Manage\Projects-GetProjectTemplates.json" -variable Result
Download request template · Save as Projects-GetProjectTemplates.json.
View request JSON
{
"project_object_id": 42
}
Projects/RemoveDeliverablesToProjectStage
Remove deliverables from a project stage.
manage -endpoint Projects/RemoveDeliverablesToProjectStage -method POST -bodyFile "C:\Scripts\Manage\Projects-RemoveDeliverablesToProjectStage.json" -variable Result
Download request template · Save as Projects-RemoveDeliverablesToProjectStage.json.
View request JSON
{
"project_object_id": 42,
"project_record_id": 11,
"record_ids": [
501,
502
],
"object_id": 42,
"project_stage_id": 1
}
Projects/RemoveResourcesInProjectStage
Remove assigned users from a project stage.
manage -endpoint Projects/RemoveResourcesInProjectStage -method POST -bodyFile "C:\Scripts\Manage\Projects-RemoveResourcesInProjectStage.json" -variable Result
Download request template · Save as Projects-RemoveResourcesInProjectStage.json.
View request JSON
{
"project_stage_id": 1,
"project_object_id": 42,
"record_id": 11,
"user_ids": [
501,
502
]
}
PropertyCard
PropertyCard/CheckIn
Check in a Manage record.
manage -endpoint PropertyCard/CheckIn -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CheckIn.json" -variable Result
Download request template · Save as PropertyCard-CheckIn.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"bom_level": 1
}
PropertyCard/CheckInBatch
Check in multiple Manage records.
Set BatchRecordsJson to a batch payload approved for your Manage server. The jsonData field must remain a JSON string.
manage -endpoint PropertyCard/CheckInBatch -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CheckInBatch.json" -variable Result
Download request template · Save as PropertyCard-CheckInBatch.json.
View request JSON
{
"jsonData": "${global.BatchRecordsJson}",
"bom_level": 1
}
PropertyCard/CheckOut
Check out a Manage record.
manage -endpoint PropertyCard/CheckOut -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CheckOut.json" -variable Result
Download request template · Save as PropertyCard-CheckOut.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"bom_level": 1
}
PropertyCard/CheckOutBatch
Check out multiple Manage records.
Set BatchRecordsJson to a batch payload approved for your Manage server. The jsonData field must remain a JSON string.
manage -endpoint PropertyCard/CheckOutBatch -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CheckOutBatch.json" -variable Result
Download request template · Save as PropertyCard-CheckOutBatch.json.
View request JSON
{
"jsonData": "${global.BatchRecordsJson}",
"bom_level": 1
}
PropertyCard/CreateCase
Create a new case record.
manage -endpoint PropertyCard/CreateCase -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CreateCase.json" -variable Result
Download request template · Save as PropertyCard-CreateCase.json.
View request JSON
{
"object_id": 42,
"field_group_id": 1,
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/CreateCRM
Create a new crm record.
manage -endpoint PropertyCard/CreateCRM -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CreateCRM.json" -variable Result
Download request template · Save as PropertyCard-CreateCRM.json.
View request JSON
{
"object_id": 42,
"field_group_id": 1,
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/CreateDocument
Create a new document record.
Prepare the file bytes using CreateDocument upload preparation. The -upload option applies only to related-file uploads.
manage -endpoint PropertyCard/CreateDocument -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CreateDocument.json" -variable Result
Download request template · Save as PropertyCard-CreateDocument.json.
View request JSON
{
"object_id": 42,
"field_group_id": 1,
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
],
"file_name": "example.pdf",
"file": "REPLACE_WITH_BASE64_FILE_BYTES",
"thumbnail": ""
}
PropertyCard/CreateProcess
Create a new process record.
manage -endpoint PropertyCard/CreateProcess -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CreateProcess.json" -variable Result
Download request template · Save as PropertyCard-CreateProcess.json.
View request JSON
{
"object_id": 42,
"field_group_id": 1,
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/CreateProject
Create a new project record.
manage -endpoint PropertyCard/CreateProject -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CreateProject.json" -variable Result
Download request template · Save as PropertyCard-CreateProject.json.
View request JSON
{
"object_id": 42,
"field_group_id": 1,
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
],
"template_id": 1
}
PropertyCard/CreateRecord
Create a new record record.
manage -endpoint PropertyCard/CreateRecord -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-CreateRecord.json" -variable Result
Download request template · Save as PropertyCard-CreateRecord.json.
View request JSON
{
"object_id": 42,
"field_group_id": 1,
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/DownloadObjectReport
Download the report for a record.
Not available through manage: this operation returns a file. See the optional PowerShell download helper.
Save-ManageDownload -Endpoint "PropertyCard/DownloadObjectReport" -QueryFile "C:\Scripts\Manage\PropertyCard-DownloadObjectReport.json" -OutFile "C:\Exports\DownloadObjectReport.bin"
Download request template · Save as PropertyCard-DownloadObjectReport.json.
View request JSON
{
"object_id": 42,
"record_id": 11
}
PropertyCard/DownloadReport
Download a selected report for a record.
Not available through manage: this operation returns a file. See the optional PowerShell download helper.
Save-ManageDownload -Endpoint "PropertyCard/DownloadReport" -QueryFile "C:\Scripts\Manage\PropertyCard-DownloadReport.json" -OutFile "C:\Exports\DownloadReport.bin"
Download request template · Save as PropertyCard-DownloadReport.json.
View request JSON
{
"object_id": 42,
"record_id": 11,
"report_id": 1
}
PropertyCard/FileInfo
Read file information for a record.
manage -endpoint PropertyCard/FileInfo -method GET -queryFile "C:\Scripts\Manage\PropertyCard-FileInfo.json" -variable Result
Download request template · Save as PropertyCard-FileInfo.json.
View request JSON
{
"object_id": 42,
"record_id": 11
}
PropertyCard/GetFieldsSettings
Read settings for a field.
manage -endpoint PropertyCard/GetFieldsSettings -method GET -queryFile "C:\Scripts\Manage\PropertyCard-GetFieldsSettings.json" -variable Result
Download request template · Save as PropertyCard-GetFieldsSettings.json.
View request JSON
{
"object_id": 42,
"field_id": 1
}
PropertyCard/GroupsAndFieldsById
Read a record’s fields for a group and tab.
manage -endpoint PropertyCard/GroupsAndFieldsById -method GET -queryFile "C:\Scripts\Manage\PropertyCard-GroupsAndFieldsById.json" -variable Result
Download request template · Save as PropertyCard-GroupsAndFieldsById.json.
View request JSON
{
"object_id": 42,
"record_id": 11,
"field_group_id": 1,
"tab_id": 1
}
PropertyCard/GroupsAndFieldsSettings
Read field groups and field settings for a record.
manage -endpoint PropertyCard/GroupsAndFieldsSettings -method GET -queryFile "C:\Scripts\Manage\PropertyCard-GroupsAndFieldsSettings.json" -variable Result
Download request template · Save as PropertyCard-GroupsAndFieldsSettings.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"field_group_id": 1
}
PropertyCard/RecordInfo
Read record information.
manage -endpoint PropertyCard/RecordInfo -method GET -queryFile "C:\Scripts\Manage\PropertyCard-RecordInfo.json" -variable Result
Download request template · Save as PropertyCard-RecordInfo.json.
View request JSON
{
"object_id": 42,
"record_id": 11
}
PropertyCard/Reports
List reports available for an object, group or stage.
manage -endpoint PropertyCard/Reports -method GET -queryFile "C:\Scripts\Manage\PropertyCard-Reports.json" -variable Result
Download request template · Save as PropertyCard-Reports.json.
View request JSON
{
"object_id": 42,
"group_object_id": 42,
"stage_id": 1
}
PropertyCard/Sections
List property-card sections for an object.
manage -endpoint PropertyCard/Sections -method GET -queryFile "C:\Scripts\Manage\PropertyCard-Sections.json" -variable Result
Download request template · Save as PropertyCard-Sections.json.
View request JSON
{
"object_id": 42
}
PropertyCard/UpdateCase
Update fields on a case record.
manage -endpoint PropertyCard/UpdateCase -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-UpdateCase.json" -variable Result
Download request template · Save as PropertyCard-UpdateCase.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/UpdateCRM
Update fields on a crm record.
manage -endpoint PropertyCard/UpdateCRM -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-UpdateCRM.json" -variable Result
Download request template · Save as PropertyCard-UpdateCRM.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/UpdateDocument
Update fields on a document record.
manage -endpoint PropertyCard/UpdateDocument -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-UpdateDocument.json" -variable Result
Download request template · Save as PropertyCard-UpdateDocument.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/UpdateProcess
Update fields on a process record.
manage -endpoint PropertyCard/UpdateProcess -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-UpdateProcess.json" -variable Result
Download request template · Save as PropertyCard-UpdateProcess.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/UpdateProject
Update fields on a project record.
manage -endpoint PropertyCard/UpdateProject -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-UpdateProject.json" -variable Result
Download request template · Save as PropertyCard-UpdateProject.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
PropertyCard/UpdateRecord
Update fields on a record record.
manage -endpoint PropertyCard/UpdateRecord -method POST -bodyFile "C:\Scripts\Manage\PropertyCard-UpdateRecord.json" -variable Result
Download request template · Save as PropertyCard-UpdateRecord.json.
View request JSON
{
"object_id": 42,
"record_guid": "11111111-2222-3333-4444-555555555555",
"thumbnail": "",
"fields": [
{
"key": "REPLACE_WITH_FIELD_SYSTEM_NAME",
"value": "Example value"
}
]
}
Tasks
Tasks/TaskRecords
List tasks using completion, cancellation and search filters.
manage -endpoint Tasks/TaskRecords -method GET -queryFile "C:\Scripts\Manage\Tasks-TaskRecords.json" -variable Result
Download request template · Save as Tasks-TaskRecords.json.
View request JSON
{
"filter_id": 1,
"show_completed": false,
"simple_search_for": "",
"limit_records": 50,
"from_sw": false,
"only_switems": false,
"ipage_displayed": 1,
"show_cancelled": false
}
Tasks/Tree
List task folders and filters.
manage -endpoint Tasks/Tree -method GET -variable Result
No request file needed.
UsersAndGroups
UsersAndGroups/AddGroup
Create a user group.
manage -endpoint UsersAndGroups/AddGroup -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-AddGroup.json" -variable Result
Download request template · Save as UsersAndGroups-AddGroup.json.
View request JSON
{
"group_name": "Automation reviewers",
"enabled": true
}
UsersAndGroups/AddUser
Create a Manage user.
manage -endpoint UsersAndGroups/AddUser -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-AddUser.json" -variable Result
Download request template · Save as UsersAndGroups-AddUser.json.
View request JSON
{
"first_name": "Example",
"last_name": "User",
"user_name": "example.user",
"salutation": "",
"telephone": "",
"telephone_ext": "",
"mobile": "",
"email": "example.user@example.com",
"position": "Reviewer",
"department": "Engineering",
"password_never_expires": false,
"cannot_change_password": false,
"must_change_password": true
}
UsersAndGroups/AddUsersToGroup
Add users to a group.
manage -endpoint UsersAndGroups/AddUsersToGroup -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-AddUsersToGroup.json" -variable Result
Download request template · Save as UsersAndGroups-AddUsersToGroup.json.
View request JSON
{
"user_ids": [
501,
502
],
"group_id": 1
}
UsersAndGroups/DeleteGroup
Delete a group.
manage -endpoint UsersAndGroups/DeleteGroup -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-DeleteGroup.json" -variable Result
Download request template · Save as UsersAndGroups-DeleteGroup.json.
View request JSON
{
"group_id": 1
}
UsersAndGroups/DeleteUsers
Delete selected users.
manage -endpoint UsersAndGroups/DeleteUsers -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-DeleteUsers.json" -variable Result
Download request template · Save as UsersAndGroups-DeleteUsers.json.
View request JSON
{
"user_ids": [
501,
502
]
}
UsersAndGroups/EnableDisableUsers
Enable or disable selected users.
manage -endpoint UsersAndGroups/EnableDisableUsers -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-EnableDisableUsers.json" -variable Result
Download request template · Save as UsersAndGroups-EnableDisableUsers.json.
View request JSON
{
"user_ids": [
501,
502
],
"enabled": true
}
UsersAndGroups/GetUserbyId
Read one user’s details.
manage -endpoint UsersAndGroups/GetUserbyId -method GET -queryFile "C:\Scripts\Manage\UsersAndGroups-GetUserbyId.json" -variable Result
Download request template · Save as UsersAndGroups-GetUserbyId.json.
View request JSON
{
"user_id": 1
}
UsersAndGroups/GetUserInGroup
List users in a group.
manage -endpoint UsersAndGroups/GetUserInGroup -method GET -queryFile "C:\Scripts\Manage\UsersAndGroups-GetUserInGroup.json" -variable Result
Download request template · Save as UsersAndGroups-GetUserInGroup.json.
View request JSON
{
"group_id": 1
}
UsersAndGroups/GetUsersAndGroups
List users and groups.
manage -endpoint UsersAndGroups/GetUsersAndGroups -method GET -variable Result
No request file needed.
UsersAndGroups/RemoveUsersFromGroup
Remove users from a group.
manage -endpoint UsersAndGroups/RemoveUsersFromGroup -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-RemoveUsersFromGroup.json" -variable Result
Download request template · Save as UsersAndGroups-RemoveUsersFromGroup.json.
View request JSON
{
"user_ids": [
501,
502
],
"group_id": 1
}
UsersAndGroups/ResetPassword
Reset a user’s password and choose whether they must change it at next sign-in.
manage -endpoint UsersAndGroups/ResetPassword -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-ResetPassword.json" -variable Result
Download request template · Save as UsersAndGroups-ResetPassword.json.
View request JSON
{
"user_id": 1,
"user_must_change_password_on_next_login": true
}
UsersAndGroups/UpdateUser
Update a user’s details and password policy.
manage -endpoint UsersAndGroups/UpdateUser -method POST -bodyFile "C:\Scripts\Manage\UsersAndGroups-UpdateUser.json" -variable Result
Download request template · Save as UsersAndGroups-UpdateUser.json.
View request JSON
{
"first_name": "Example",
"last_name": "User",
"user_name": "example.user",
"salutation": "",
"telephone": "",
"telephone_ext": "",
"mobile": "",
"email": "example.user@example.com",
"position": "Reviewer",
"department": "Engineering",
"password_never_expires": false,
"cannot_change_password": false,
"must_change_password": true,
"user_id": 1
}
Advanced file preparation
The helpers below run in Windows PowerShell, not in the PDMShell console. Use them only for the operations marked above.
Use ${global.RecordIds} in later script commands. That value is JSON text, not an implicit iteration. Inspect the actual response before choosing a path for other endpoints; this reference does not invent response schemas. Template string values may reference session globals. Use separate source and destination globals because the destination is cleared before execution.
Binary download helper (PowerShell)
Run this helper in Windows PowerShell, not the PDMShell console. Enter the same raw Authorization token expected by Manage. It does not read or decrypt PDMShell's saved credentials. Supply Pdm-Access-Token as well if your server requires it. Use HTTPS. Keep the token in memory only and clear $ManageHeaders after downloading.
$ManageBaseUrl = 'https://manage.example.com/api/'
$secureToken = Read-Host 'Manage Authorization token' -AsSecureString
$pointer = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($secureToken)
try {
$ManageHeaders = @{ Authorization = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($pointer) }
} finally {
[Runtime.InteropServices.Marshal]::ZeroFreeBSTR($pointer)
$secureToken.Dispose()
}
# If needed, add Pdm-Access-Token using the same secure-input pattern.
function Save-ManageDownload {
param([string]$Endpoint, [string]$QueryFile, [string]$OutFile)
if (Test-Path -LiteralPath $OutFile) { throw 'Choose a new output filename; this example does not overwrite files.' }
$query = Get-Content -LiteralPath $QueryFile -Raw | ConvertFrom-Json
$pairs = foreach ($property in $query.PSObject.Properties) {
$value = if ($property.Value -is [bool]) { $property.Value.ToString().ToLowerInvariant() }
else { [Convert]::ToString($property.Value, [Globalization.CultureInfo]::InvariantCulture) }
[Uri]::EscapeDataString($property.Name) + '=' + [Uri]::EscapeDataString($value)
}
$uri = $ManageBaseUrl.TrimEnd('/') + '/' + $Endpoint + '?' + ($pairs -join '&')
Invoke-WebRequest -Uri $uri -Method Get -Headers $ManageHeaders -OutFile $OutFile `
-UseBasicParsing -MaximumRedirection 0 -TimeoutSec 120 -ErrorAction Stop
}
# Run one download example below, then:
# $ManageHeaders.Clear()
Create the output directory before downloading. The examples use a .bin filename because the actual content may be a file or ZIP; inspect the response's Content-Type/Content-Disposition or the server contract before choosing a final extension. This helper saves the response without extracting ZIP contents. An HTTP-success JSON error response can still be saved as a file: inspect the result before treating it as a usable export.
Preparing a CreateDocument upload body
-upload is specifically for File/AddRelatedFileToFolder. For PropertyCard/CreateDocument, use PowerShell to populate the downloadable JSON body with real bytes, then run the PDMShell command shown in that endpoint's entry. The input file must already be locally available. The serialized request must remain within the connector's 32 MiB request limit.
$template = 'C:\Scripts\Manage\PropertyCard-CreateDocument.json'
$body = Get-Content -LiteralPath $template -Raw | ConvertFrom-Json
$file = 'C:\Exports\example.pdf'
$body.file = [Convert]::ToBase64String([IO.File]::ReadAllBytes($file))
$body.file_name = [IO.Path]::GetFileName($file)
$body | ConvertTo-Json -Depth 20 | Set-Content -LiteralPath $template -Encoding UTF8
The create/update examples use thumbnail: "" for an empty thumbnail. Check your server’s empty-value semantics before updating an existing thumbnail; supply base64 image bytes when needed. These examples do not assume an empty value means “leave unchanged.”