ListDocuments

Overview

The ListDocuments operation retrieves a list of the documents available in a given package (or LOB phase). The request takes a package identifier (PackageID as a string) or LOB phase (LOBPhase object) and returns an array containing a document set objects for the given package or LOB phase and organization combination. To specify the organization to be used for precedence in the returned documents, you may also submit an organization object on the request.

Note: This API only works with packages or documents when defined in the knowledge base content; it does not retrieve documents from any package created in Expere EZ Config Packages and Packets.
OperationListDocuments
Styledocument
OperationRequest-response. The endpoint receives a message, and sends a correlated message.
SOAP Actionhttp://www.wolterskluwerfs.com/2012/12/DocGenServices/IDocumentService/ListDocumentshttp://www.wolterskluwerfs.com/2014/05/DocServices/V2/IEDocService/ListDocuments
InputListDocuments_InputMessage (soap:body, use = literal) parameterstype ListDocumentsRequest
OutputListDocuments_OutputMessage (soap:body, use = literal) parameters type ListDocumentsResponse

Request Message

The operation input is ListDocumentsRequest. The request requires a ListDocumentsRequest object containing a account identifier and content identifier as a parameter on the input.

ParameterNameConstraintsDescription
requestListDocumentsInOptionalThe input message for the ListDocuments operation

Response Element

The ListDocumentsResponse object contains request status information based on the ListDocumentsResult returned in the response message.

ElementNameDescription
ListDocumentsResponseListDocumentsResultThe output message for the ListDocuments operation used to return the list of documents.

Request and Response Samples

For sample code, see: ListDocuments.