Using the GetSchemaForObject Web Method

Retrieves an XML version of the metadata behind a business object. In the process, it screens out properties not appropriate for end users, such as the RecID.

Request Syntax

string GetSchemaForObject(string sessionKey, string tenantId, string objectName)

Parameters

•sessionKey: The session key from the Connect web method.

•tenantId: The tenant for which the session key is authenticated.

•objectName: The name of the business object, in object reference notation (such as "incident#").

Return Value

A string value representing the schema for the specified business object, which is represented in XML.

Example

string schemaDoc = frSvc.GetSchemaForObject(authSessionKey, tenantId, "Incident#");