SOAP Actions
Eric Domke edited this page Dec 16, 2020
·
31 revisions
| Action | Notes |
|---|---|
ActivateActivity |
|
AddItem ➡️ |
|
ApplyAML |
Run one or more <Item/> queries within a mandatory <AML/> tag. Methods returning a <Result>string</Result> will not display. |
ApplyItem |
Run the query represented by a single <Item/> tag. Methods returning a <Result>string</Result> will work properly. |
ApplyMethod |
Executes the method specified by the action attribute (e.g. <Item type="Method" action="{method name}" />). The same result can be achieved with the ApplyItem action |
ApplySQL |
Administrators and root can run SQL queries passed in a <sql/> or <SQL/> tag. Data will only be returned if the first word of the query is SELECT
|
ApplyUpdate |
|
BuildProcessReport |
|
⛔ CacheDiag
|
Removed in Aras v10 |
CancelWorkflow |
|
ChangeUserPassword |
|
⛔ CheckImportedItemType
|
Removed in Aras v10 |
ClearCache |
Clears all server caches |
ClearHistory |
Performs DELETE FROM innovator.HISTORY;
|
CloneForm |
|
CloseWorkflow |
|
CompileMethod |
|
CopyItem ➡️ |
Used when copying relationships in the relationships grid |
CopyItem2 ➡️ |
Used with the Save As... menu item |
CreateFileExchangeTxn |
(:heavy_plus_sign: Added in Aras v10) |
CreateItem |
|
DeleteItem |
|
DeleteUsers |
Removes a user session. Input should be similar to the output of GetUsersList
|
DeleteVersionFile |
|
EditItem ➡️ |
|
EvaluateActivity ➡️ |
|
ExecuteEscalations |
Execute workflow escalations (generally called on a schedule) |
ExecuteReminders |
Execute workflow reminders (generally called on a schedule) |
⛔ ExportItemType
|
Removed in Aras v11 |
GenerateNewGUID ➡️ |
|
GenerateNewGUIDEx ➡️ |
|
GenerateParametersGrid |
|
GenerateRelationshipsTabbar |
|
GenerateRelationshipsTable |
|
GetAffectedItems |
|
GetAssignedActivities |
|
GetAssignedTasks ➡️ |
|
GetCheckUpdateInfo |
(:heavy_plus_sign: Added in Aras v11) |
GetConfigurableGridMetadata |
|
GetCurrentUserID |
Get the user ID of the currently logged in user |
GetFormForDisplay |
|
⛔ GetHistoryItems
|
Obsolete in 9.3 |
GetIdentityList ➡️ |
|
GetItem ➡️ |
|
GetItemAllVersions |
Get all versions (i.e. generations) of an item. It requires an id attribute and does not respect the select attribute. Another way to do this is to search for generations > 0. |
GetItemLastVersion ➡️ |
|
GetItemNextStates ➡️ |
|
GetItemRelationships |
<Item type="Part" relName="Part BOM" id="xxx"> -> <Item type="Part BOM" action="get"><source_id>xxx</source_id></Item>
|
GetItemTypeByFormID |
|
GetItemTypeForClient |
|
GetItemWhereUsed ➡️ |
|
⛔ GetMainTreeItems ➡️
|
Returns information used to generate the TOC. Removed in Aras v12 |
GetNextSequence ➡️ |
|
GetPermissionsForClient ➡️ |
|
GetUsersList ➡️ |
|
GetUserWorkingDirectory |
|
InstantiateWorkflow ➡️ |
|
⛔ LoadCache
|
Removed in Aras v11 |
LoadProcessInstance |
|
LoadVersionFile |
|
LockItem |
|
LogMessage |
|
LogOff |
Log off the current user: <logoff skip_unlock="1"/>
|
MergeItem |
|
NewItem |
Returns the AML for adding a new item including specifying all of the default properties |
⛔ NewRelationship
|
Removed in Aras v11sp12 |
PopulateRelationshipsGrid |
|
PopulateRelationshipsTables |
|
ProcessFileTransferResult |
(:heavy_plus_sign: Added in Aras v10) |
ProcessReplicationQueue |
|
PromoteItem ➡️ |
|
PurgeItem |
|
ReassignActivity |
|
RebuildKeyedName ➡️ |
|
RebuildView |
|
ReplicationExecutionResult |
|
ResetAllItemsAccess |
|
ResetItemAccess |
|
ResetLifeCycle |
|
⛔ ResetServerCache
|
Removed in Aras v11 Resets the server's cache of metadata regarding item types, properties, etc. Useful if you make a metadata change through app server A and then try to access the same database from app server B. |
⛔ SaveCache
|
Removed in Aras v11 |
⛔ ServerErrorTest
|
Removed in Aras v11sp12 Can only be run by the root account |
SetDefaultLifeCycle |
|
⛔ SetNullBooleanTo0
|
Removed in Aras v11sp12 |
SetUserWorkingDirectory |
|
SkipItem |
|
StartDefaultWorkflow |
|
StartFileExchangeTxn |
(:heavy_plus_sign: Added in Aras v10) |
StartNamedWorkflow |
|
StartWorkflow ➡️ |
|
StoreVersionFile |
|
TransformVaultServerURL |
Replaces parameters in a vault URL: <url>$[HTTP_PREFIX_SERVER]server-name$[HTTP_PATH_SERVER]/vault/vaultserver.aspx</url>
|
UnlockAll |
Unlocks every item in the database |
UnlockItem |
|
UpdateItem ➡️ |
|
ValidateUser |
Used to log in |
ValidateVote |
Validates the password of a vote: <Item incoming="MD5_String" mode="password|esignature" />
|
ValidateWorkflowMap |
|
VaultApplyAml, VaultApplyItem
|
(:heavy_plus_sign: Added in Aras v11) |