GrooveForms2.ReadRecords Operation

The ReadRecords operation returns the specified Forms tool records.

HTTP Post URL

The HTTP Post URL targets the Forms tool. This URI is provided by the GrooveTools.Read operation in the ToolData element.

Input Message Header

GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.

Input Message Parameters

<RecordURIList>
  <!-- Array of -->  <URI /> 
</RecordURIList>
<IncludeFileAttachmentContent />
<ExceptionIfDeleted />
Element Data type Description

RecordURIList

Array of xs:anyURI

Identifies the Forms tool record to be read. URIs that identify Forms tool records are returned by the CreateRecords operation and by the RecordURI field in the Forms2RecordDataSet. The RecordURIList array can contain zero or more URI elements.

IncludeFileAttachmentContent

xs:boolean

If true, the attachment contents will be included in the record in the FileAttachmentContent element. If false, when reading records from Groove Forms Tools, the FileAttachmentContent element will not be provided, but the other FileAttachment elements, such as the FullName and Size, will be provided. Default is false.

ExceptionIfDeleted

xs:boolean

If true and any of the records specified by the URIs have already been deleted, then the entire operation will fail and will return an exception. If false and any of the records have been deleted, then the remaining records will be read.

Output Message Header

GrooveResponseHeader specifies the Response key.

Return Value

<ReadRecordsResult />
Element Data type Description

ReadRecordsResult

Forms2RecordDataSet

The Schema defines the record schemas and the Data contains the records.

Remarks

If this operation fails for any record for any reason other than that the record has been deleted, then the entire operation will fail and will return a SOAP exception.

If you want to read all records, use the QueryRecords operation with an empty WhereClause.

The content of attachments will be included if the IncludeFileAttachments parameter is true.

If all records specified have been deleted and you specified false for the ExceptionIfDeleted parameter, the operation will return a Forms2RecordDataSet element with an empty Data element and with no elements defining the record schemas in the Schema element.

See Also

Reference

GrooveForms2 Web Service
Forms2RecordDataSet Complex Type

Concepts

Reading Records Specified by URI