getContentFieldsDefinition

Gets a ContentField definition that contains metadata. This metadata contains information about the content field type that is part of the requested business object.

The getContentFieldsDefinition operation is compatible with the binary, image, and note field types.
The values that are obtained from the getContentFieldsDefinition operation help facilitate the fieldName attribute needed for some operations that take in a Content parameter.
Document objects do not have a field name.

Parameters

moduleName: The module name.
boName: The business object name.

Errors

ModuleDoesNotExistException: The module does not exist.
ObjectTypeDoesNotExistException: The object type does not exist.
AccessException: The user does not have access to write to the record.
IOException: A system error occurred.

Sample request

<soapenv:Envelope 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:ws="http://ws.tririga.com">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getContentFieldsDefinition>
         <ws:moduleName>cstIntegration</ws:moduleName>
         <ws:boName>cstIntegration</ws:boName>
      </ws:getContentFieldsDefinition>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<soap:Envelope 
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <getContentFieldsDefinitionResponse xmlns="http://ws.tririga.com">
         <contentFields>
            <ns1:ContentField xmlns:ns1="http://content.dto.ws.tririga.com">
               <boName xmlns="http://content.dto.ws.tririga.com">cstIntegration</boName>
               <fieldLabel xmlns="http://content.dto.ws.tririga.com">Binary</fieldLabel>
               <fieldName xmlns="http://content.dto.ws.tririga.com">cstBinaryBI</fieldName>
               <fieldType xmlns="http://content.dto.ws.tririga.com">Binary</fieldType>
               <moduleName xmlns="http://content.dto.ws.tririga.com">cstIntegration</moduleName>
            </ns1:ContentField>
            <ns1:ContentField xmlns:ns1="http://content.dto.ws.tririga.com">
               <boName xmlns="http://content.dto.ws.tririga.com">cstIntegration</boName>
               <fieldLabel xmlns="http://content.dto.ws.tririga.com">Image</fieldLabel>
               <fieldName xmlns="http://content.dto.ws.tririga.com">cstImageIM</fieldName>
               <fieldType xmlns="http://content.dto.ws.tririga.com">Image</fieldType>
               <moduleName xmlns="http://content.dto.ws.tririga.com">cstIntegration</moduleName>
            </ns1:ContentField>
            <ns1:ContentField xmlns:ns1="http://content.dto.ws.tririga.com">
               <boName xmlns="http://content.dto.ws.tririga.com">cstIntegration</boName>
               <fieldLabel xmlns="http://content.dto.ws.tririga.com">Note</fieldLabel>
               <fieldName xmlns="http://content.dto.ws.tririga.com">cstNoteNO</fieldName>
               <fieldType xmlns="http://content.dto.ws.tririga.com">Note</fieldType>
               <moduleName xmlns="http://content.dto.ws.tririga.com">cstIntegration</moduleName>
            </ns1:ContentField>
         </contentFields>
      </getContentFieldsDefinitionResponse>
   </soap:Body>
</soap:Envelope>