Kelverion.Salesforce.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!-- Module: Kelverion.Salesforce Version: 1.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SalesforceLimits</command:name> <maml:description> <maml:para>Retrieves Salesforce API limits. Note: Running this cmdlet affects the Daily API Requests value.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SalesforceLimits</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-SalesforceLimits</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>DailyApiRequestsRemaining - the remaining number of API requests (calls) for the day. DailyAsyncApexExecutionsMax - the maximum number of daily async Apex executions allowed for your organization. DailyAsyncApexExecutionsRemaining - the remaining number of async Apex executions for the day. DailyBulkAPIRequestsMax - the maximum number of daily Bulk API requests (calls) allowed for your organization. DailyBulkAPIRequestsRemaining - the remaining number of Bulk API requests (calls) for the day. DataStorageMbMax - maximum data storage for your organization. DataStorageMbRemaining - remaining data storage for your organization.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SalesforceRecord</command:name> <maml:description> <maml:para>Retrieve Salesforce record(s) of the specifed type.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SalesforceRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Get-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to retrieve. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordId</maml:name> <maml:description> <maml:para>Identifies a specific object to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishAllFields</maml:name> <maml:description> <maml:para>Specifies whether the cmdlet will return all record fields, or just a subset of “summary” fields. Summary fields typically include record identifier fields, name fields, Created Date and Last Modified Date. Note: Choosing not to publish all record fields can improve performance in cases where specific details for an object are not needed, for example, when only the Record ID for a specific record is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to retrieve. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordLimit</maml:name> <maml:description> <maml:para>The maximum number of records to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifes one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='My Account'},[PSCustomObject]@{'Id'='NumberOfEmployees';'Operator'='GreaterThan';'Value'=10})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies a field used for ordering the returned records. When not specified, record order is undefined.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>When OrderBy is specified, specifies whether the returned records will be ordered in ascending or descending order. When not specified, the cmdlet returns records in ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishAllFields</maml:name> <maml:description> <maml:para>Specifies whether the cmdlet will return all record fields, or just a subset of “summary” fields. Summary fields typically include record identifier fields, name fields, Created Date and Last Modified Date. Note: Choosing not to publish all record fields can improve performance in cases where specific details for an object are not needed, for example, when only the Record ID for a specific record is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to retrieve. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordId</maml:name> <maml:description> <maml:para>Identifies a specific object to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishAllFields</maml:name> <maml:description> <maml:para>Specifies whether the cmdlet will return all record fields, or just a subset of “summary” fields. Summary fields typically include record identifier fields, name fields, Created Date and Last Modified Date. Note: Choosing not to publish all record fields can improve performance in cases where specific details for an object are not needed, for example, when only the Record ID for a specific record is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordLimit</maml:name> <maml:description> <maml:para>The maximum number of records to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifes one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='My Account'},[PSCustomObject]@{'Id'='NumberOfEmployees';'Operator'='GreaterThan';'Value'=10})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies a field used for ordering the returned records. When not specified, record order is undefined.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>When OrderBy is specified, specifies whether the returned records will be ordered in ascending or descending order. When not specified, the cmdlet returns records in ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Outputs specific to the specified ObjectType.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-SalesforceRecord</command:name> <maml:description> <maml:para>Creates a new Salesforce record of the specifed type.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SalesforceRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to be created. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifes filed values for the new record. For example: @ {'Description'='My test accout';'Name'='Test Account';'Type'='Customer';'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to be created. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifes filed values for the new record. For example: @ {'Description'='My test accout';'Name'='Test Account';'Type'='Customer';'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Record ID of the newly created record.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-SalesforceRecord</command:name> <maml:description> <maml:para>Removes a record of the specifed type.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SalesforceRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Remove-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to removed. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordId</maml:name> <maml:description> <maml:para>Identifies the record to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject"> <!--NAME: InputObject--> <maml:name>Remove-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to removed. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the record that is to be removed. Use Get-SalesforceRecord to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to removed. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordId</maml:name> <maml:description> <maml:para>Identifies the record to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the record that is to be removed. Use Get-SalesforceRecord to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Record ID of the removed record. The record ID is no longer valid.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-SalesforceRecord</command:name> <maml:description> <maml:para>Updates a record of the specifed type.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SalesforceRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Set-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to updated. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordId</maml:name> <maml:description> <maml:para>Identifies the record to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifes filed values for the updaed record. For example: @ {'Description'='My updated test accout'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject"> <!--NAME: InputObject--> <maml:name>Set-SalesforceRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to updated. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the record that is to be updated. Use Get-SalesforceRecord to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifes filed values for the updaed record. For example: @ {'Description'='My updated test accout'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of object to updated. For example: Account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecordId</maml:name> <maml:description> <maml:para>Identifies the record to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifes filed values for the updaed record. For example: @ {'Description'='My updated test accout'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Salesforce site. For example: @{ ServerUrl='<Salesforce Site URL>'; LoginUrl='https://login.salesforce.com/services/oauth2/token'; Username='<user>'; Password='<password>'; SecurityToken='<user security token>'; ClientId='<client ID (consumer key) for the Salesforce connected app>'; ClientSecret='<client secret (consumer secret) for the Salesforce connected app>'; LicenseKey='<license key>'; SessionTimeoutMinutes=15; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the record that is to be updated. Use Get-SalesforceRecord to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Record ID of the updated record.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> </helpItems> |