The DocumentOutput type is a return type that indicates the outputs made for a document for each export method: script, windows directory, Open Bee™ Portal.
This type is an abstract type that can take several forms depending on the type.
DocumentOutputDMS
- Type : Constant: DocumentOutputDMS
- stateToString : The current state of the document relative to this type of output. Securities:
- SENT: Exported Document
- FAILED: The last export attempt failed
- WAITING: Document is not yet sent to output
- IN_PROGRESS: The document is currently being exported
- idDMSDocument : the Open Bee™ Portal identifier of the document (only if the document is already checked in Open Bee™ Portal)
Example
{
type: "DocumentOutputDMS",
stateToString: "SENT",
idDMSDocument: "2569"
}
DocumentOutputFolder
- Type : Constant: DocumentOutputFolder
- stateToString : The current state of the document relative to this type of output. Securities:
- SENT: Exported Document
- FAILED: The last export attempt failed
- WAITING: Document is not yet sent to output
- IN_PROGRESS: The document is currently being exported
Example
{
type: "DocumentOutputFolder",
stateToString: "SENT"
}
DocumentOutputScript
- Type : Constant: DocumentOutputScript
- stateToString : The current state of the document relative to this type of output. Securities:
- SENT: Exported Document
- FAILED: The last export attempt failed
- WAITING: Document is not yet sent to output
- IN_PROGRESS: The document is currently being exported
Example
{
type: "DocumentOutputScript",
stateToString: "SENT"
}