The CreateObj client API is used to create various types of objects.
Argument |
Description |
---|---|
Parameter 1 |
ClassDef of object to be created |
Parameter 1 default |
None |
Parameter 1 description |
The class definition of the object to be created. |
Parameter 1 type |
String |
Parameter 2 |
Not used |
Parameter 3 |
Not used |
Parameter 4 |
Not used |
Parameter 5 |
Title |
Parameter 5 default |
None |
Parameter 5 description |
The title of the form that will be used to create the object. |
Parameter 5 type |
String |
Parameter 6 |
File attachment configuration |
Parameter 6 default |
File attachment configuration (optional) FileClassDef~FileRelDef~ReferenceAction~SeedFileTemplateDocName. SPFFileComposition is the default relationship definition if none other is specified. The seed file document is optional. Reference file not found actions are CONTINUE|PROMPT|ABORT. |
Parameter 6 description |
SPFDesignFile~SPFFileComposition~PROMPT |
Parameter 6 type |
String |
Parameter 7 |
Details of secondary class (Not Supported in the Web Client) |
Parameter 7 default |
None |
Parameter 7 description |
Details of the secondary class to create and its relationship to the parent class definition specified in Argument 1. Use ~ as a separator. |
Parameter 7 type |
String |
Parameter 8 |
Workflow processing option |
Parameter 8 default |
None |
Parameter 8 description |
|
Parameter 8 type |
String |
Parameter 9 |
None |
Parameter 9 default |
None |
Parameter 9 description |
Complex Graphs are used to indicate the objects derived from the server side that creates relationships to link the objects together. |
Parameter 9 type |
None |
Parameter 10 |
Post method name (Not Supported in the Web Client) |
Parameter 10 default |
None |
Parameter 10 description |
The method that will be run on the new object. For complex objects, add ~InterfaceDefUI to identify the object on which the method will be run. |
Parameter 10 type |
String |
Parameter 11 |
Not used |
Parameter 12 |
Additional property to set (Not supported in the Desktop Client) |
Parameter 12 default |
None |
Parameter 12 description |
Four ~ separated arguments (UID~Text~Method~Boolean) which set the property identified by the UID to True, and invoke the specified method, when the button with the specified text is clicked. True value navigates to the next screen even when no workflow is attached to the object. The default value of the fourth argument is False. For example, if the user specifies SDACreatedAsDraft~Save As Draft~MTH_SOPSPrepareChangeRequest, a Save As Draft button appears on the form and when clicked, the value of the property with the UID SDACreatedAsDraft is set to True, and the SOPSPrepareChangeRequest method is invoked. |
Parameter 12 type |
String |
Parameter 13 type |
Not used |
Parameter 14 type |
Not used |
Parameter 15 |
Is file attachment mandatory |
Parameter 15 default |
False |
Parameter 15 description |
At least one file attachment is mandatory if this flag is set to True |
Parameter 15 type |
Boolean |
Parameter 16 type |
Not used |
Parameter 17 |
Create Form UID |
Parameter 17 default |
None |
Parameter 17 description |
UID of the create form to be used. (Not supported in the Desktop Client). When configured, the selected create form will be launched during the create object process. |
Parameter 17 type |
String |
Many methods use this client API, and the list can be viewed in the Web Client. To see the methods in your system that use this client API, find the client API, right-click it, and click Show Methods.