UploadDocument client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The UploadDocument client API is used to query for the existing document, retrieve the metadata of the selected document, create a new revision of that document, attach any selected files to this new revision, and upload the document along with the files.

Argument

Description

Parameter 1

Title

Parameter 1 default

None

Parameter 1 description

The title that appears at the top of the dialog box.

Parameter 1 type

String

Parameter 2

Entrypoint set name to query the documents

Parameter 2 default

None

Parameter 2 description

Entrypoint set name to query the documents. For more information on how to configure the entry point, see Configure API Entry Points.

Parameter 2 type

String

Parameter 3

File attachment configuration

Parameter 3 default

SPFDesignFile~SPFFileComposition~PROMPT

Parameter 3 description

File attachment configuration (optional) FileClassDef~FileRelDef~ReferenceAction~SeedFileTemplateDocName. SPFFileComposition is the default relationship definition if none specified and the seed file document is optional. Reference file not found actions are CONTINUE | PROMPT | ABORT

Parameter 3 type

String

Parameter 4

RelDef to navigate to the ClassDef

Parameter 4 default

None

Parameter 4 description

RelDef to navigate to the ClassDef - Used to derive the class definition to create from the classification object.

Parameter 4 type

String

Parameter 5

UID of classification

Parameter 5 default

None

Parameter 5 description

UID of classification

Parameter 5 type

String

Parameter 8

Workflow processing option

Parameter 8 default

None

Parameter 8 description

The Web Client chooses the applicable workflow unless a named workflow is specified. However, if more than one applicable workflow is found, the software does not attach the object to any workflow. The options include Select, SelectRequired, or a named workflow.

Parameter 8 type

String

The following method uses the UploadDocument client API to query for the existing document based on the given arguments.

  • UploadDocument