The following examples show samples of the syntax used so you can launch directly to objects in different areas of the Web Client. You launch URLs using the launch path parameter. The other key parameters used to make the URL composition are:
-
config - the UID of the plant or project in which the requested object exists
-
objectName - the name of the requested object
-
objectObid - the OBID of the requested object
-
setName - the set name derived from the appropriate API entry point
The setName parameter can be found in the Set Name column of an API entry point displayed in a results grid.
-
methodName - the name of the method
-
data - an optional parameter to expand a method
The setName parameter is required if you use the objectName parameter instead of the objectObid parameter. The setName parameter is also required if you use the objectUID parameter.
You can combine these various parameters depending on the view being launched and the object being identified by its name or OBID.
For example:
Using objectName to launch a document in the results grid
Where the syntax uses the results, config, setName, and objectName.
https://[localhost]/[webclient]/#/launch/results;config=[UID];setName=[setname];objectName=[objectname]
Using objectName to launch a document in the Info Map
Where the syntax uses infomap, config, objectName, and setName..
https://[localhost]/[webclient]/#/launch/infomap;config=[UID];objectName=[objectname];setName=[setname]
Using objectName to launch an object details
Where the syntax uses details, config, objectName, and setName.
https://[localhost]/[webclient]/#/launch/details;config=[UID];objectName=[objectname];setName=[setname]
Using objectObid to launch a document in results grid
Where the syntax uses details, config, and objectObid.
https://[localhost]/[webclient]/#/launch/results;config=[UID];objectObid=[objectOBID]
Using objectObid to launch an object in the Info Map
Where the syntax uses infomap, config, and objectObid.
https://[localhost]/[webclient]/#/launch/infomap;config=[UID];objectObid=[objectOBID]
Using objectObid to launch an object details
Where the syntax uses details, config, and objectObid.
https://[localhost]/[webclient]/#/launch/details;config=[UID];objectObid=[objectOBID]
Using methodName to launch a document
There may be times when you need to launch a view controlled by a method to invoke the URL path. When launching a method, you combine the use of launch with the run parameter.
When the method needs to point to an object context, such as DocumentCopy, it must be provided using the following arguments:
-
config - the UID of the Plant or Project in which the requested object exists
-
methodName - the name of the method that the URL will invoke, for example, ViewNavigateFiles
-
objectName or objectObid - the object can be identified by its Name if the OBID is not known
-
setName - needed to ensure data of the correct type is retrieved when identifying by Name
For example:
When launching a method to view a file on a document, you can combine the use of launch and run parameters to invoke the path along with the config, methodName, objectName, and SetName arguments:
https://[localhost]/[webclient]/#/launch/run;config=[UID];methodName=[methodname];objectName=[objectname];setName=[setname]
For example:
When launching a method that does not need object context, such as Create or To Do List, you combine the use of launch and run parameters to invoke the path along with the config and methodName arguments. Therefore, to launch a method to the To Do List:
https://[localhost]/[webclient]/#/launch/run;config=[UID];methodName=WFInBox
Using data to view one or more objects in a document or file
When you need to view one or more objects in a model or drawing using the ViewNavigateFiles or FileViewNavigate methods, you must provide one of the following arguments:
-
ITEMSBYUID - the UID of the object
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectObid=[objectOBID];methodName=[methodname];data={"ITEMSBYUID":["UID1", "UID2"]}
-
ITEMSBYOBID - the OBID of the object
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectObid=[objectOBID];methodName=[methodname];data={"ITEMSBYOBID":["OBID1", "OBID2"]}
-
ITEMSBYNAME - the name of the object
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectObid=[objectOBID];methodName=[methodname];data={"ITEMSBYNAME":["Name1", "N1*"]}
-
Use a comma separated list for multiple values.
-
You can use wildcard characters for the ITEMSBYNAME argument. The % wildcard character must be encoded as %25.
-
You must use JSON escape characters when using special characters for the ITEMSBYNAME argument.
-
The launch URL functionality is available only for data published using Integration with SmartPlant Foundation and requires both tags and representation object relationships for the model or drawing.
Using data to launch a visual intelligence report
When you need to launch a specified visual intelligence report using the ViewNavigateFiles method, you must provide the following arguments:
-
config - the UID of the Plant or Project in which the requested object exists
-
objectName or objectObid - the object can be identified by its Name if the OBID is not known
-
setName - needed to ensure data of the correct type is retrieved when identifying by name
-
methodName - the name of the method that the URL will invoke
-
data - the JSON parameters used to execute a Visual Intelligence report (VIR)
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name];setName=[setname]
;methodName=ViewNavigateFiles;data="VIR":["OBID"]
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name];setName=[setname]
;methodName=ViewNavigateFiles;data={"VIR":["OBID"]}
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name];setName=[setname]
;methodName=ViewNavigateFiles;data=%7B%22VIR%22:[%22OBID%22]%7D
Using data to launch a visual intelligence search
When you need to launch a specified visual intelligence search using the ViewNavigateFiles method, you must provide the following arguments:
-
config - the UID of the Plant or Project in which the requested object exists
-
objectName or objectObid - the object can be identified by its Name if the OBID is not known
-
setName - needed to ensure data of the correct type is retrieved when identifying by name
-
methodName - the name of the method that the URL will invoke
-
data - the JSON parameters used to execute a Visual Intelligence search (VIS)
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name]
;setName=[setname];methodName=ViewNavigateFiles;data="VIS":["searchterm1","searchterm2","searchterm3"]
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name]
;setName=[setname];methodName=ViewNavigateFiles;data={"VIS":["searchterm1","searchterm2","searchterm3"]}
For example:
https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name]
;setName=[setname];methodName=ViewNavigateFiles;data=%7B%22VIS%22:[%22searchterm1%22,%22searchterm2%22,%22searchterm3%22]%7D
The % wildcard character must be encoded as %25.