Operations at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window

This page describes the service operations at this endpoint.

Uri Method Description
?tag={tag} POST Create an instance of a window.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/?tag={TAG}
{windowId} DELETE Close the given window
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}
{windowId}/active/ GET Get window defintion with an active structure.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/active/
{windowId}/clear POST Clear the given window
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/clear
{windowId}/data GET Get the data for a given datawindow
GET Get the data for currently visible datawindows on a window
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/data?datawindowName={DATAWINDOWNAME}&activeRows={ACTIVEROWS}
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/data
{windowId}/elements GET Get a tabpage element.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements?tabpage={NAME}
{windowId}/elements/activerow GET Get the current row for a datawindow
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/activerow?datawindowName={DATAWINDOWNAME}
{windowId}/elements/changedata PUT Changes data for to a specific field.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/changedata?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/datawindow/{name} GET Get a datawindow element.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/datawindow/{NAME}
{windowId}/elements/drill POST Execute drill into a field on a window.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/drill?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/drill/row/{rowIndex} POST Execute drill into a field on a window, moving to the actual row.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/drill/row/{ROWINDEX}?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/dws/{datawindowName}/{fieldName}/dropdowndata/ GET Get the values of a specific dropdown field.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/dws/{DATAWINDOWNAME}/{FIELDNAME}/dropdowndata/
{windowId}/elements/dws/{datawindowName}/{fieldName}/lookup/getcontextmenu GET Get context menu for lookups
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/dws/{DATAWINDOWNAME}/{FIELDNAME}/lookup/getcontextmenu
{windowId}/elements/dws/{datawindowName}/{fieldName}/lookup/saveuserpreferences PUT Save user preferences from lookup
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/dws/{DATAWINDOWNAME}/{FIELDNAME}/lookup/saveuserpreferences
{windowId}/elements/dws/row PUT Add a new row to a datawindow.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/dws/row?pageName={PAGENAME}&dws={DATAWINDOWNAME}
{windowId}/elements/dws/row/enter PUT Add a new row to a datawindow with the enter key.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/dws/row/enter?pageName={PAGENAME}&dws={DATAWINDOWNAME}
{windowId}/elements/emailReceipt PUT Add a new row to a datawindow with the enter key.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/emailReceipt?company={COMPANY}&emailAddress={EMAILADDRESS}&invoice={INVOICE}
{windowId}/elements/filedrop PUT Indicate that a file drop action has taken place
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/filedrop?dwName={DWNAME}
{windowId}/elements/focus POST Set focus on the specified field.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/focus?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}&row={ROW}
{windowId}/elements/lookupadvanced PUT Retrieves popup/lookup data, given parameters
GET Retrieves the lookup structure
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/lookupadvanced?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/lookupadvanced
{windowId}/elements/lookupadvancedcount PUT Retrieves popup/lookup data, given paramters
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/lookupadvancedcount?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/processcomponentdata PUT Execute additional logic for custom columns on grid like dropdowns
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/processcomponentdata?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/processdataresult PUT Sends selected popup data
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/processdataresult?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/processvisualruleresult PUT Process values returned from a visual business rule
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/processvisualruleresult
{windowId}/elements/select POST Selects a page and returns its new metadata and its data
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/select?pageName={PAGENAME}
{windowId}/elements/tools GET Get the tools available for a given field
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/tools?datawindowName={DATAWINDOWNAME}&fieldName={FIELDNAME}
{windowId}/elements/tools/run PUT Perform a datawindow action.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/tools/run?dwName={DWNAME}&toolName={TOOLNAME}&dwElementName={DWELEMENTNAME}&row={ROW}
{windowId}/elements/tools/run/treeview PUT Perform a treeview action.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/tools/run/treeview?treeviewName={TREEVIEWNAME}&toolName={TOOLNAME}
{windowId}/elements/tools/treeview GET Get the tools available for currently selected node of a given treeview.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/tools/treeview?treeviewName={TREEVIEWNAME}
{windowId}/elements/treeview/{tvName}/add/{handle} POST Add a new item as the last child of the given item (handle)
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/treeview/{TVNAME}/add/{HANDLE}
{windowId}/elements/treeview/{tvName}/collapse/{handle} POST Collapse the given handle on a treeview
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/treeview/{TVNAME}/collapse/{HANDLE}
{windowId}/elements/treeview/{tvName}/delete/{handle} POST Delete the given handle on a treeview
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/treeview/{TVNAME}/delete/{HANDLE}
{windowId}/elements/treeview/{tvName}/expand/{handle} POST Expand the given handle on a treeview
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/treeview/{TVNAME}/expand/{HANDLE}
{windowId}/elements/treeview/{tvName}/select/{handle} POST Expand the given handle on a treeview
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/elements/treeview/{TVNAME}/select/{HANDLE}
{windowId}/history/elements GET Get history sidebar list for a window.
PUT Loads history element into a specific window.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/history/elements
{windowId}/ping POST Ping to let the server know the window is still alive.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/ping
{windowId}/preference/{name} GET Get the given preference on the window
POST Set the given preference on the window
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/preference/{NAME}
{windowId}/preference/{name}/object/{objectName} GET Get the given preference on the window/object
POST Set the given preference on the window/object
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/preference/{NAME}/object/{OBJECTNAME}
{windowId}/ribbon/ GET Get the ribbon for a window using a specific format.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/ribbon/?format={FORMAT}
{windowId}/save POST Save the given window
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/save
{windowId}/tools/{toolName} PUT Perform a window action.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/tools/{TOOLNAME}
{windowId}/tools/run/email PUT Perform a datawindow action.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/{WINDOWID}/tools/run/email?toolName={TOOLNAME}&filePath={FILEPATH}
drill POST Execute drill from external data source to open appropriate window as defined in Dynachange Navigator.
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/drill
drop PUT Indicate that a drop action has taken place
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/drop
elements/urlhandler PUT Open a specific window and populate its fields with the provided values
OPTIONS Service at https://buildcont.tpcx.com:17143/uiserver0/ui/full/v1/window/elements/urlhandler?window={WINDOW}