At logon, it is possible to launch any of the APIs available. APIs are divided into those that require an object and those that do not.
|
Parameter |
Required object |
Description |
|---|---|---|
|
API |
API name |
The name of the API to be called. This object is case sensitive. |
|
ARG1 |
First argument |
Depends on the API called. |
|
ARG2 |
Second argument |
Depends on the API called. |
|
ARG3 |
Third argument |
Depends on the API called. |
|
ARG4 |
Fourth argument |
Depends on the API called. |
|
ARG5 |
Fifth argument |
Depends on the API called. |
|
ARG6 |
Sixth argument |
Depends on the API called. |
|
ARG7 |
Seventh argument |
Depends on the API called. |
|
ARG8 |
Eighth argument |
Depends on the API called. |
|
CRITERIA |
Search criteria |
Specifies the search criteria for queries. |
To launch an API from the command line, you need the /API parameter. The arguments are optional and depend on the API being used. To launch an API from a URL, use the API= syntax followed by the name of the API and any parameters for that API. For example, PI=QFindObject&ARG1=Change&ARG4=*.
To launch an API on an object, the following parameters are mandatory.
CLASS classname
NAME name of item
The CRITERIA argument is optional.
Examples
Desktop_Client.exe /PLANT Plant1 /PROJECT ProjectA /API Navigate /ARG1 FRAME /CLASS DocRevision /Name DOC-ACCREP-003
Desktop_Client.exe /U abc /P dFs9921j /PLANT Plant1 /PROJECT ProjectA /S /API ViewAndMarkup /ARG1 FRAME /CLASS DocRevision /Name DOC-ACCREP-003
Desktop_Client.exe /PLANT Plant1 /PROJECT ProjectA /API Navigate /ARG1 FRAME /CLASS DocRevision /Name DOC-ACCREP-003
Desktop_Client.exe /API CMClientEditObj /ARG2 "List of Work" (Inbox)
Desktop_Client.exe /API QFindObject /ARG1 DocRevision /ARG2 False /CRITERIA * (General find)
SPFOpen:S=Server^U=superuser^P=PlantName^API=ShowInbox^ENABLEDEBUG=True