Get-SalesforceRecord

NAME Get-SalesforceRecord



SYNOPSIS

Retrieve Salesforce record(s) of the specifed type.





SYNTAX

Get-SalesforceRecord -ObjectType <String> -RecordId <String> [-PublishAllFields <SwitchParameter>] -Connection

<Hashtable> [<CommonParameters>]



Get-SalesforceRecord -ObjectType <String> -RecordLimit <Int32> [-Filters <PSObject[]>] [-OrderBy <String>]

[-Descending <SwitchParameter>] [-PublishAllFields <SwitchParameter>] -Connection <Hashtable> [<CommonParameters>]





DESCRIPTION







PARAMETERS

-ObjectType <String>

Specifies the type of object to retrieve. For example: Account.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RecordId <String>

Identifies a specific object to be retrieved.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PublishAllFields [<SwitchParameter>]

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Hashtable>

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

}



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RecordLimit <Int32>

The maximum number of records to be retrieved.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Filters [<PSObject[]>]

Specifes one or more filters. For example:

@([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='My

Account'},[PSCustomObject]@{'Id'='NumberOfEmployees';'Operator'='GreaterThan';'Value'=10})



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OrderBy [<String>]

Specifies a field used for ordering the returned records. When not specified, record order is undefined.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Descending [<SwitchParameter>]

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

System.Management.Automation.PSObject

Outputs specific to the specified ObjectType.







RELATED LINKS