📄️ bomChangeBomReleaseLifecycleState
Changes the lifecycle state of the specified BOM release by applying the specified transition.
📄️ bomCreateBom
Creates a new BOM.
📄️ bomExportBomById
Exports the specified BOM into a file and provides a download URL.
📄️ bomExportBomRelease
Use bomExportBomById() instead.
📄️ bomExportBom
Use bomExportBomById() instead.
📄️ desAddComponentPartChoices
Adds part choices of the specified component.
📄️ desAddDatasheetToComponent
Adds the specified datasheet to a component (does not affect the revision).
📄️ desAddFootprintToComponent
Adds the specified footprint to a component (does not affect the revision).
📄️ desAddUsersToGroup
Adds users to the specified group.
📄️ desCompareReleases
Runs schematic, PCB, or BOM comparisons between two project releases. Provides URL of the comparison result for web-browser.
📄️ desCreateCommentThread
Creates a new comment thread.
📄️ desCreateComment
Creates a new comment.
📄️ desCreateDatasheet
Creates a datasheet.
📄️ desCreateFolder
Creates a folder in the library.
📄️ desCreateFootprint
Creates a footprint.
📄️ desCreateLifeCycleDefinition
Creates the provided life cycle definition, with associated states, stages and state transitions.
📄️ desCreateProjectTask
Creates a project task. A task is a job activity in Altium 365.
📄️ desCreateRevisionNamingScheme
Creates a revision naming scheme.
📄️ desCreateSymbol
Creates a symbol.
📄️ desCreateTaskComment
Creates a new comment for the specified task.
📄️ desCreateUserGroup
Creates a new user group.
📄️ desCreateUser
Creates a user.
📄️ desCreateWorkspaceTask
Creates a workspace task. A task is a job activity in Altium 365.
📄️ desDeleteCommentThread
Permanently deletes a comment thread.
📄️ desDeleteComment
Permanently deletes the specified comment.
📄️ desDeleteFolder
Deletes the specified folder from the library.
📄️ desDeleteLifeCycleDefinition
Deletes the provided life cycle definitions.
📄️ desDeleteRevisionNamingScheme
Deletes the revision naming scheme.
📄️ desDeleteTaskComment
Deletes the specified task comment.
📄️ desDeleteTask
Deletes the task specified by its node identifier.
📄️ desDeleteUserGroup
Deletes the specified user group.
📄️ desDeleteUser
Deletes the specified user.
📄️ desLaunchWorkflow
Launches a workflow. Workflows allow you to automate design processes, and are created in Altium 365.
📄️ desMoveFolder
Moves the specified folder in the library.
📄️ desPartRemoveCustomParts
Removes custom part by the given identifiers.
📄️ desPartUploadCustomPartDatasheet
Uploads a datasheet file for a custom part and returns its public service URL.
📄️ desPartUploadCustomPartImage
Uploads an image file for a custom part and returns its public service URL.
📄️ desPartUploadParts
**Experimental** Upload parts.
📄️ desPartUpsertCustomParts
Upserts custom parts.
📄️ desReleaseComponentTemplate
Creates and releases the specified component template.
📄️ desReleaseComponent
Releases the specified component.
📄️ desRemoveComponentPartChoices
Removes part choices of the specified component.
📄️ desRemoveDatasheetFromComponent
Removes the specified datasheet from a component (does not affect the revision).
📄️ desRemoveFootprintFromComponent
Removes the specified footprint from a component (does not affect the revision).
📄️ desRemoveUsersFromGroup
Removes users from the specified group.
📄️ desSetProjectRequirementsBlock
Link/unlink A365 project with requirements block component.
📄️ desTerminateWorkflows
Terminates a workflow. Workflows allow you to automate design processes, and are created in Altium 365.
📄️ desUpdateCommentThread
Updates an existing comment thread.
📄️ desUpdateComment
Updates the specified comment.
📄️ desUpdateComponentItemParameters
Updates item parameters for the specified component (does not affect the revision).
📄️ desUpdateComponentLifeCycleState
Updates life cycle state for the provided component.
📄️ desUpdateComponentRevisionParameters
Updates parameters for the specified component (creates a new revision).
📄️ desUpdateComponentSymbol
Updates the specified component's symbol (does not affect the revision).
📄️ desUpdateComponentTemplate
Updates the specified component template.
📄️ desUpdateFolderPermissions
Updates the permissions for the associated folder.
📄️ desUpdateFolder
Updates the specified folder in the library.
📄️ desUpdateFootprintLifeCycleState
Updates life cycle state for the provided footprint.
📄️ desUpdateFootprint
Updates the specified footprint. This will create a new revision of the footprint, and reset the lifecycle state.
📄️ desUpdateLifeCycleDefinition
Updates the defined life cycle definition with those provided.
📄️ desUpdatePermissions
Updates entity's permissions.
📄️ desUpdateProjectOwner
Updates the owner for the associated project.
📄️ desUpdateProjectParameters
Updates parameters for the specified project (does not affect the revision).
📄️ desUpdateProjectPermissions
Updates the permissions for the associated project.
📄️ desUpdateReuseBlock
Updates a specific result block.
📄️ desUpdateRevisionNamingScheme
Updates a revision naming scheme.
📄️ desUpdateSetting
Updates the value associated with the specified setting.
📄️ desUpdateSymbolLifeCycleState
Updates life cycle state for the provided symbol.
📄️ desUpdateSymbol
Updates the specified symbol. This will create a new revision of the symbol, and reset the lifecycle state.
📄️ desUpdateTaskComment
Updates the specified task comment.
📄️ desUpdateTask
Updates the specified task.
📄️ desUpdateUserGroup
Updates the specified user group.
📄️ desUpdateUser
Updates the specified user properties.
📄️ desUpgradeComponentsToLatestFootprint
Upgrades components to use the latest footprint revision. This operation updates the link to the footprint and does not create new component revisions.
📄️ desUpgradeComponentsToLatestSymbol
Upgrades components to use the latest symbol revision. This operation updates the link to the symbol and does not create new component revisions.
📄️ desUploadCollaborationSimulation
*PROTOTYPE, SUBJECT TO CHANGE*
📄️ desUploadCollaboration
Uploads the specified collaboration.
📄️ desUploadProject
Uploads the project zip file.
📄️ desWorkspaceInsInitializeInsightsIfRequired
Runs the initialization process for insights, if didn't run yet.
📄️ desWorkspaceInsUnsubscribeFromNotifications
Unsubscribes from notifications.
📄️ desWorkspaceInsUpdateInsightById
Updates an insight by identifier.
📄️ desWorkspaceInsUpdateNotificationSettings
Updates the notification settings.
📄️ desWorkspaceInsUpdateSettings
Updates the settings.
📄️ desWorkspaceInsUpsertInsightByKey
Creates or updates an insight by key.
📄️ designRegisterUpload
**Experimental** Registers an uploaded file as a design upload.
📄️ designRuleCheckExecuteOnUpload
**Experimental** Executes rule checks for the specified upload and returns the resulting rule check execution.
📄️ designRuleCheckExecute
**Experimental** Executes rule checks for the specified design and returns the resulting rule check execution.
📄️ dmExecuteDeviceEvaluationFromConfiguration
**Experimental**
📄️ dmExecuteDeviceEvaluationFromESD
Use dmExecuteDeviceEvaluationFromESDv2 mutation instead
📄️ dmExecuteDeviceEvaluationFromESDv2
**Experimental**
📄️ dmExecuteDeviceEvaluationFromXml
**Experimental**
📄️ dmExecuteDeviceEvaluation
**Experimental**
📄️ dmExecuteDeviceExtractionFromConfigurationUrl
**Experimental**
📄️ dmExecuteDeviceExtractionFromConfiguration
**Experimental**
📄️ dmUpdateDeviceFromSdm
**Experimental**
📄️ gloAddAppClientSecret
Adds a new client secret to an existing App.
📄️ gloAddAppGrantType
Adds a new grant type to an existing App.
📄️ gloAddAppRedirectUri
Adds a new redirect URI to an existing App.
📄️ gloAddAppScope
Adds a new scope to an existing App.
📄️ gloAddUsersToGroup
Add users to group.
📄️ gloCreateAppFromOAuthClient
Creates a new App with an existing *OAuth 2.0 client*.
📄️ gloCreateApp
Creates a new App with an *OAuth 2.0 client*.
📄️ gloCreateUserGroup
Create new user group.
📄️ gloCreateUser
Create new user.
📄️ gloCusAddAssignment
Add new assignment to extension point.
📄️ gloCusDeleteAssignment
Deletes an existing assignment.
📄️ gloCusExecuteAssignment
Executes an existing assignment.
📄️ gloCusExecuteExtensionPoint
Dispatches all active assignments of the given extension point in run-and-forget mode. Returns one entry per assignment; per-assignment failures are surfaced individually and do not abort the others.
📄️ gloCusUpdateAssignmentConfigurations
Updates configuration parameters of an Extension point.
📄️ gloCusUpdateAssignment
Updates an existing assignment.
📄️ gloDeleteApp
Deletes an App.
📄️ gloEvtCreateWebhookSubscription
Creates webhook-based subscription with given parameters.
📄️ gloEvtDeleteSubscription
Deletes the subscription with given identifier.
📄️ gloEvtPublishEvent
Publishes an event.
📄️ gloInstallApp
Installs an App into a Workspace.
📄️ gloNtfSendEmail
Sends e-mail to specified recipients.
📄️ gloRemoveAppClientSecret
Removes an existing client secret from an existing App.
📄️ gloRemoveAppGrantType
Removes an existing grant type from an existing App.
📄️ gloRemoveAppRedirectUri
Removes an existing redirect URI from an existing App.
📄️ gloRemoveAppScope
Removes an existing scope from an existing App.
📄️ gloRemoveUsersFromGroup
Remove users from group.
📄️ gloRestoreApp
Restores an App.
📄️ gloScrCreateScript
Creates a new script.
📄️ gloScrDeleteScript
Deletes a script by its identifier.
📄️ gloScrExecuteScript
Executes a script asynchronously.
📄️ gloScrUpdateScript
Updates an existing script, creating a new version.
📄️ gloUninstallApp
Uninstalls an App from a Workspace.
📄️ gloUpdateAppContactEmail
Updates the contact email of an existing App.
📄️ gloUpdateAppDescription
Updates the description of an existing App.
📄️ gloUpdateAppHrid
Updates the human-readable identifier of an existing App.
📄️ gloUpdateAppName
Updates the name of an existing App.
📄️ platformTokenDelete
Deletes a PlatformToken. Returns the identifier of the deleted token.
📄️ platformTokenUpdate
Updates the name and/or description of an existing PlatformToken.
📄️ platformWorkspaceRefreshTokenCreateNewSecret
Creates a new client secret for an existing PlatformWorkspaceRefreshToken. Returns the newly generated secret along with the PlatformWorkspaceRefreshToken.
📄️ platformWorkspaceRefreshTokenCreate
Creates a new PlatformWorkspaceRefreshToken.
📄️ platformWorkspaceTokenCreate
Creates a new PlatformWorkspaceToken.
📄️ rsaMotorStudioCreateEasyModeConfig
**Experimental** Add an easymode config for the specified project.
📄️ rsaMotorStudioCreateProject
**Experimental** Add new MotorStudioProject
📄️ rsaMotorStudioCreateScopeCapture
**Experimental** Create a scope capture for the specified project and scope configuration.
📄️ rsaMotorStudioCreateScopeConfig
**Experimental** Create a scope configuration for the specified project.
📄️ rsaMotorStudioCreateTuningRevision
**Experimental** Create a new tuning revision for the specified tuning.
📄️ rsaMotorStudioCreateTuning
**Experimental** Create a tuning.
📄️ rsaMotorStudioCreateVariableSetRevision
**Experimental** Create a new revision for an existing variable set.
📄️ rsaMotorStudioCreateVariableSet
**Experimental** Create a variable set for the specified project.
📄️ rsaMotorStudioDeleteEasyModeConfig
**Experimental** Delete an easymode config for the specified project.
📄️ rsaMotorStudioDeleteProject
**Experimental** Delete specified motor studio project.
📄️ rsaMotorStudioDeleteScopeCapture
**Experimental** Delete a scope capture for the specified project.
📄️ rsaMotorStudioDeleteScopeConfig
**Experimental** Delete a scope configuration for the specified project.
📄️ rsaMotorStudioDeleteTuning
**Experimental** Delete a tuning and all its revisions.
📄️ rsaMotorStudioDeleteVariableSet
**Experimental** Delete a variable set and all of its revisions for the specified project.
📄️ rsaMotorStudioLinkTuningToProject
**Experimental**
📄️ rsaMotorStudioUnlinkTuningFromProject
**Experimental**
📄️ rsaMotorStudioUpdateEasyModeConfig
**Experimental** Update an easymode config for the specified project (provided sliders will become the entire list).
📄️ rsaMotorStudioUpdateProject
**Experimental** Update a MotorStudioProject
📄️ rsaMotorStudioUpdateScopeConfig
**Experimental** Update a scope configuration for the specified project (provided views/channels become the entire list).
📄️ rsaMotorStudioUpdateTuning
**Experimental** Update a tuning.
📄️ rsaMotorStudioUpdateVariableSet
**Experimental** Update a variable set metadata for the specified project.
📄️ sftAIModelCreateCustomProperties
Creates the AI model custom properties.
📄️ sftAIModelCreate
Creates new AI model.
📄️ sftAIModelDeleteCustomProperties
Delete the AI model custom properties.
📄️ sftAIModelDelete
Deletes the AI Model.
📄️ sftAIModelUpdateCustomProperties
Updates the AI model custom properties.
📄️ sftAIModelUpdate
Updates the AI model.
📄️ sftDevCfgCreateDeviceConfiguration
Creates new device configuration.
📄️ sftDevCfgDeleteDeviceConfiguration
Deletes device configuration by ID.
📄️ sftDevCfgLinkDeviceConfigurationRevisionToHardwareProject
Creates a link between device configuration revision and hardware project.
📄️ sftDevCfgLinkDeviceConfigurationToSoftwareProject
Creates a link between device configuration and software project.
📄️ sftDevCfgUnlinkDeviceConfigurationFromSoftwareProject
Removes a link between device configuration and software project.
📄️ sftDevCfgUnlinkDeviceConfigurationRevisionFromHardwareProject
Removes an existing link between device configuration revision and hardware project.
📄️ sftSimSimulationCreateCustomProperties
Creates the simulation custom properties.
📄️ sftSimSimulationCreate
Creates new simulation.
📄️ sftSimSimulationDeleteCustomProperties
Delete the simulation custom properties.
📄️ sftSimSimulationDelete
Deletes simulation by identifier.
📄️ sftSimSimulationUpdateCustomProperties
Updates the simulation custom properties.
📄️ sftSimSimulationUpdate
Updates the simulation.
📄️ sftSoftwareCreateProjectCustomProperties
Creates the Software Project custom properties.
📄️ sftSoftwareCreateProject
Creates new Sofware Project.
📄️ sftSoftwareDeleteProjectCustomProperties
Delete the Software Project custom properties.
📄️ sftSoftwareDeleteProject
Deletes Software Project by ID.
📄️ sftSoftwareUpdateProjectConfiguration
Updates the Software Project configuration.
📄️ sftSoftwareUpdateProjectCustomProperties
Updates the Software Project custom properties.
📄️ sftSoftwareUpdateProjectFirmware
Updates the Software Project firmware.
📄️ sftSoftwareUpdateProject
Updates the Software Project.
📄️ solAddAttachment
Adds an attachment to the solution.
📄️ solBldCreateSolution
Scaffolds a new solution with projects and optional empty linked ESD document.
📄️ solBldImportRefDesigns
Imports a reference design into an existing solution.
📄️ solBldImportSoftwareProjects
Imports software projects into an existing solution.
📄️ solBldLinkSolution
Links projects to an existing solution and optionally creates an empty ESD document if none exists.
📄️ solBldScaffoldingByConfiguration
Scaffolds a new solution by provided configuration file.
📄️ solBldScaffoldingByExistingEsd
Updates existing solution from linked ESD document.
📄️ solBldScaffoldingBySdm
Generates software project based on SDM document.
📄️ solBldScaffoldingBySoftwareProjectAndEvalKit
Scaffolds a new solution by software project and eval kit.
📄️ solBldScaffoldingBySolutionTemplate
Scaffolds a new solution by solution template.
📄️ solBldScaffoldingExistingSolutionBySolutionTemplate
Scaffolds additional data into an existing solution using a solution template.
📄️ solBldScaffoldingWithEmptyEsd
Scaffolds a new solution with an empty linked ESD document.
📄️ solBldScaffolding
Scaffolds a new solution.
📄️ solCreateSolution
Adds new solution.
📄️ solDeleteAttachment
Deletes existing attachment.
📄️ solDeleteSolution
Deletes existing solution.
📄️ solLinkItemToSolution
Creates a link between solution and other item.
📄️ solLinkItemsToSolution
Creates a link between solution and other items.
📄️ solUnlinkItemFromSolution
Removes a link between solution and other item.
📄️ solUpdateSolution
Updates existing solution.
📄️ supEvalKitAddDevices
Add devices to an evaluation kit.
📄️ supEvalKitAddPreviewImages
Add preview images to an evaluation kit.
📄️ supEvalKitAddRefDesignCompatibleEvalKit
Add evaluation kits to a reference design.
📄️ supEvalKitCreateEvalKit
Create a new evaluation kit.
📄️ supEvalKitDeleteDevices
Delete devices from an evaluation kit.
📄️ supEvalKitDeleteEvalKit
Delete a evaluation kit.
📄️ supEvalKitDeletePreviewImages
Delete preview images from an evaluation kit.
📄️ supEvalKitDeleteRefDesignCompatibleEvalKit
Delete evaluation kits from a reference design.
📄️ supEvalKitPatchParameters
Add or remove parameters on an evaluation kit. Replaces values of existing parameters.
📄️ supEvalKitSetMainRefDesign
Set the main reference design for an evaluation kit.
📄️ supEvalKitSetParameters
Replace all parameters on an evaluation kit. Deletes all existing parameters and values, then inserts the new ones.
📄️ supEvalKitSoftwareProjectCompatibleEvalKit
Modify a software project compatible evaluation kit.
📄️ supEvalKitSortPreviewImages
Sort preview images of an evaluation kit.
📄️ supEvalKitUnsetMainRefDesign
Unset a specific main reference design for an evaluation kit.
📄️ supEvalKitUpdateEvalKit
Update a evaluation kit.
📄️ supSoftwareProjectCreateSoftwareProject
Create a new software project.
📄️ supSoftwareProjectDeleteSoftwareProject
Delete a software project.
📄️ supSoftwareProjectPatchParameters
Add or remove parameters on a software project. Replaces values of existing parameters.
📄️ supSoftwareProjectPatchPreviewImages
Patch preview images on a software project: add, delete, or reorder.
📄️ supSoftwareProjectSetParameters
Replace all parameters on a software project. Deletes all existing parameters and values, then inserts the new ones.
📄️ supSoftwareProjectSetPreviewImages
Replace all preview images on a software project.
📄️ supSoftwareProjectUpdateEvalKitCompatibleSoftwareProject
Update evaluation kit's compatible software project.
📄️ supSoftwareProjectUpdateSoftwareProject
Update a software project.
📄️ supSolutionTemplateCreateSolutionTemplateApplication
Create a new solution template application.
📄️ supSolutionTemplateCreateSolutionTemplate
Create a new solution template.
📄️ supSolutionTemplateDeleteSolutionTemplateApplication
Delete a solution template application.
📄️ supSolutionTemplateDeleteSolutionTemplate
Delete a solution template.
📄️ supSolutionTemplateIndexSolutionTemplate
Index list of solution templates by identifiers.
📄️ supSolutionTemplatePatchKeyFeatureGroups
Add or remove list of key feature groups related to a solution template.
📄️ supSolutionTemplatePatchPreviewImages
Patch preview images on a solution template: add, delete, or reorder.
📄️ supSolutionTemplatePatchTags
Add or remove list of tags related to a solution template.
📄️ supSolutionTemplateSetKeyFeatureGroups
Replace existing list of key feature groups by new one related to a solution template.
📄️ supSolutionTemplateSetPreviewImages
Replace all preview images on a solution template.
📄️ supSolutionTemplateSetTags
Replace existing list of tags by new one related to a solution template.
📄️ supSolutionTemplateUpdateSolutionTemplateApplication
Update a new solution template application.
📄️ supSolutionTemplateUpdateSolutionTemplateStatus
Update the status of a solution template.
📄️ supSolutionTemplateUpdateSolutionTemplate
Update a solution template.
📄️ sysEsdCreateDocument
Creates new ESD Document.
📄️ sysEsdDeleteDocument
Deletes ESD Document by identifier.
📄️ sysEsdExportDocument
Exports new ESD Document.
📄️ sysEsdImportDocument
Imports new ESD Document.
📄️ sysEsdUpdateDocument
Updates the ESD Document.
📄️ sysSdmCreateSystemModelVersion
**Experimental** Add new system model