CheckInFiles 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 CheckInFiles client API is used to check in documents that have been checked out for editing.

Argument

Description

Parameter 1

CheckIn Action

Parameter 1 default

CHECKIN

Parameter 1 description

Action to be performed on the document while checking in the file. Options are CHECKIN, CHECKINANDSIGNOFF, or CHECKINANDPROPMTFORSIGNOFF.

Parameter 1 type

String

Parameter 2

Column set to present results

Parameter 2 default

None

Parameter 2 description

UID of the column set to present the results.

Parameter 2 type

String

The following table describes the behavior of the options available in Argument 1:

Value

Result

CHECKIN

The document is checked in.

CHECKINANDSIGNOFF

The document is checked in and signed off at the same time.

CHECKINANDPROMPTFORSIGNOFF

You are prompted to confirm the signoff.

If Yes, the document is checked in and signed off at the same time.

If No, the document is only checked in.

The following methods use the CheckInFiles client API to check in the document.

  • VersionCheckIn

  • VersionCheckInReplace