salesforceDescribeObject

Gets metadata information on a particular object or field as part of a specified object.

Required Parameters

objectname	Object name that you want to get the metadata information for.

Optional Parameters

serverurl	Server URL from the login response. Needed if providing sessionid, otherwise provide loginurl, user and password.
loginurl	URL to the Salesforce server used for logging in. Needed if providing user and password to this call.
sessionid	Session ID from the login response. If this is unknown, enter your user and password in the respective fields to login.
user	Your Salesforce user name. This is required if no serverurl and sessionid have been provided.
password	Your Salesforce password. This is required if no serverurl and sessionid have been provided.
accesstoken	Your Salesforce access token. This can optionally be appended to your password instead of being input separately. It can be obtained via your personal information on salesforce.com.
sslcert	The SSL certificate to be accepted from the server. Any other certificate will be rejected. This can take the form of a full PEM certificate, the path to a file containing the certificate, the public key, the MD5 thunbprint or the SHA1 thumbprint. If not specified any valid certificate will be accepted.
showsslstatus	Whether to return the list of SSL status messages. The allowed values are: FALSE, TRUE.
timeout	Timeout, in seconds, for the operation to complete. Zero (0) means no timeout.
proxy_server	IP Address or host name of the proxy server used for the request.
proxy_auto	Whether or not Proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are: TRUE, FALSE.
proxy_port	Port number of the proxy server.
proxy_user	User ID used to authenticate with the proxy server.
proxy_password	Password used to authenticate with the proxy server.
proxy_authscheme	The proxy server The allowed values are: BASIC, DIGEST, PROPRIETARY, NONE, NTLM.
proxy_authtoken	The proxy authentication token.
proxy_ssltype	The proxy server The allowed values are: AUTO, ALWAYS, NEVER, TUNNEL.
firewall_server	IP Address or host name of the firewall.
firewall_port	Port number of the firewall.
firewall_user	User ID used to authenticate with the firewall.
firewall_password	Password used to authenticate with the firewall.
firewall_type	The type of the firewall. The allowed values are: TUNNEL, SOCKS4, SOCKS5.
logfile	The connector will log the exchange/transferred data to this file.
fieldname	Field name (which is part of the selected object specified by objectname input field above) that you want to get the description for. Comma separated list of fields to retrieve. Use * means all fields. This is case sensitive.

Output Attributes

sf:*	Output varies depending on 'fieldname' being specified and information returned from Salesforce.com.
ssl:issuer	The issuer of the SSL certificate.
ssl:subject	The subject of the SSL certificate.
ssl:effectivedate	A date before which the certificate is not valid.
ssl:expirationdate	A date after which the certificate is not valid.
ssl:issuer	The issuer of the SSL certificate.
ssl:publickey	The public key of the certificate.
ssl:serialnum	The serial number of the certificate encoded as a String.
ssl:status#	Shows the progress of the secure connection. Only returned if 'showsslstatus' is TRUE.
ssl:subject	The subject of the SSL certificate.