DocumentSetService Class Reference

Provides methods for working with document set documents, and for evaluating the status of a document / document set. More...

Public Member Functions
JobDocumentSetStatus	AddDocumentToDocumentSet (string sessionId, JobIdentity jobIdentity, DocumentSetDocument documentSetDocument)
	Use the AddDocumentToDocumentSet method to add a document to the document set at runtime. The status of the document set will be re-evaluated and returned. More...

Description

Provides methods for working with document set documents, and for evaluating the status of a document / document set.

Member Functions

JobDocumentSetStatus AddDocumentToDocumentSet	(	string	sessionId,
		JobIdentity	jobIdentity,
		DocumentSetDocument	documentSetDocument
	)

Use the AddDocumentToDocumentSet method to add a document to the document set at runtime. The status of the document set will be re-evaluated and returned.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentity	A JobIdentity identity object that is used to identify the job whose properties are to be retrieved. Name Type Comment Required Id String The job id Yes
documentSetDocument	A DocumentSetDocument object. Specify the document type of the document to be added along with the field values. Name Type Comment Required DocumentSetDocumentIdentity DocumentSetDocumentIdentity The Identity of the associated DocumentSet Document Yes Fields DocumentSetDocumentFieldCollection The fields associated with the DocumentSet Document No DocumentId String The capture document id No Url String The document Url No

Returns

A JobDocumentSetStatus This will rerun all document rules and retrun their status, together with the the overall document set status.

Remarks

documentSetDocument parameter should have DocumentId, Url or neither set if no document is provided. Both DocumentId and Url should not be set.

Security

No restrictions apply.