Account

APIDescription
GET api/Account/GetUserID

Return authorized user GUID as String.

GET api/Account/GetUserInfo

Return user info.

GET api/Account/GetCountries

No documentation available.

POST api/Account/ChangePassword

No documentation available.

POST api/Account/SendDeviceAuthCode?TempToken={TempToken}

Request new device authorization code to email

POST api/Account/Login?UserName={UserName}&Password={Password}

No documentation available.

POST api/Account/SignUpUser?username={username}&pwd={pwd}&company={company}&countrycode={countrycode}&ReqDeviceAuth={ReqDeviceAuth}

Sign up new user(no web access)

ydsets

Retreive available sources.

APIDescription
GET api/ydsets/GetRssItems

Return all verifyed RSS feeds urls

GET api/ydsets/GetAvCustomers

Retreive all available workspaces per user. Best use: after login "pick"

GET api/ydsets/GetSetsInWorkspace?idcust={idcust}

Retreive sets in workspace *OData

GET api/ydsets/GetAllEditorsParamDef?idcust={idcust}

All available special mapping for: Action-Parms-Input type-edit

GET api/ydsets/GetActions?idobject={idobject}&SysParCulture={SysParCulture}

Actions definition per parent object

GET api/ydsets/GetDashList?idcust={idcust}&ObjectsDepth={ObjectsDepth}&SysParCulture={SysParCulture}

Retreive all available dashboard definition per user and workspace, without live data(msgid)

POST api/ydsets/GetMetaData

No documentation available.

POST api/ydsets/SaveMetaData

No documentation available.

POST api/ydsets/GetSingleAction

Retreive active action definition(without data) by ID

POST api/ydsets/GetGlobParamValues

No documentation available.

POST api/ydsets/GetActionEditValues

Lightweight method for GetActionValues Retreive externall values and return VALues for editor. Suitable for actions with NeedEditValues=1

POST api/ydsets/GetActionValues?getallparams={getallparams}

Retreive externall values and return action definition, with filled VAL. Suitable for actions with NeedEditValues=1 Format is same as GetActions, except VAL

POST api/ydsets/GetDashItems?idcust={idcust}&iddash={iddash}&objectsdepth={objectsdepth}

Dashboard items definition, with actions and optionally live data(msgid on request pars.mType)

Device

Devices connected.

APIDescription
GET api/Device/GetUserDevices

Retreive all devies per current user. *OData

Performance

APIDescription
GET api/Performance/GetPerfCNT

Retreive server performance counters. 800ms delay per each call.

GET api/Performance/GetServerTime

Get server current operating date, time, time-zone

GET api/Performance/GetEventLog?idcust={idcust}&gidObject={gidObject}&EntityIDent={EntityIDent}&keystr={keystr}&pageIndex={pageIndex}&pageSize={pageSize}

Retreive logged events for entity

WorkSpace

Work spaces, formerly-Company/Customer IDCust.

APIDescription
GET api/WorkSpace/GetWorkspaces

Retreive all available active workspaces per user. *OData

GET api/WorkSpace/GetAll?pageIndex={pageIndex}&pageSize={pageSize}

Retreive all available active workspaces per user.

GET api/WorkSpace/GetChangedOfflinev1?idcust={idcust}&LastSyncDate={LastSyncDate}&EntityIdent={EntityIdent}&srcType={srcType}

return conversion definition for clientside use

POST api/WorkSpace/Add?idcust={idcust}

Create new empty workspace

POST api/WorkSpace/GetPubWorkspaceMetaData

Get metadata without authorize

POST api/WorkSpace/RemoveUserFromWorkspace?idcust={idcust}&username={username}

Remove user from specified workspace

POST api/WorkSpace/InviteUserToWorkspace?idcust={idcust}&checkPriorAdd={checkPriorAdd}

Generate and send invite for new or existing user by email

DELETE api/WorkSpace/Delete/{ID}?idcust={idcust}

No documentation available.

APIKey

APIDescription
GET api/APIKey/GetAll?idcust={idcust}

No documentation available.

POST api/APIKey/Add?idcust={idcust}

No documentation available.

Lang

Work spaces, formerly-Company/Customer IDCust.

APIDescription
GET api/Lang/GetKeyTexts?idcust={idcust}

Retreive all available locale texts. *OData

GET api/Lang/GetByKeyTexts?idcust={idcust}&KeyTxt={KeyTxt}&GID={GID}

Retreive localized texts for specific KEY criteria

POST api/Lang/Modify?idcust={idcust}

Modify existing text by GID

POST api/Lang/AddMulti?idcust={idcust}

Add new localizations

POST api/Lang/AddSingle?idcust={idcust}

Add new localization

DELETE api/Lang/Delete?idcust={idcust}&GID={GID}

No documentation available.

Package

APIDescription
GET api/Package/GetInStore?idcust={idcust}

All packages in store *OData

GET api/Package/GetInWorkspace?idcust={idcust}

All packages in workspace *OData

GET api/Package/GetPackageParameters?idcust={idcust}&GIDPackage={GIDPackage}

No documentation available.

GET api/Package/GetAllInStore?idcust={idcust}&pageIndex={pageIndex}&pageSize={pageSize}

No documentation available.

GET api/Package/GetAllInWorkspace?idcust={idcust}&pageIndex={pageIndex}&pageSize={pageSize}

No documentation available.

POST api/Package/DeployToWorkspace?idcust={idcust}&GIDPackage={GIDPackage}&DefaultApiKey={DefaultApiKey}&GIDCategory={GIDCategory}

No documentation available.

ytcpmsg

APIDescription
GET api/ytcpmsg/GetAnyData/{id}?waitsec={waitsec}

No documentation available.

GET api/ytcpmsg/GetAnyDataAR4/{id}?waitsec={waitsec}

No documentation available.

GET api/ytcpmsg/GetWaitedRawMSG/{id}?waitsec={waitsec}

No documentation available.

GET api/ytcpmsg/GetStatusFor/{id}?entityIdent={entityIdent}&idcust={idcust}&historyrows={historyrows}

Status of running action by MSGID. Mainly Automatization.

POST api/ytcpmsg/GetGridDef/{id}

Retreive grid type definition + return GUID for awaited dataset Grid definition with message GUID is returned immediately. Next you can call GetAnyData or GetWaitedRawMSG(until timeout)

POST api/ytcpmsg/SaveAnyData?mType={mType}

Save values stored in pars.

POST api/ytcpmsg/GetWaitedObjectMSG/{id}?waitsec={waitsec}

No documentation available.

yBinaries

APIDescription
GET api/yBinaries/GetAnyData?idcust={idcust}&gid={gid}

Retreive one specific row with docdata

GET api/yBinaries/GetAll?idcust={idcust}&withdata={withdata}

Retreive list of available binary files/data per customer

Category

APIDescription
GET api/Category/GetAll?idcust={idcust}&pageIndex={pageIndex}&pageSize={pageSize}

Retreive all available workspace categories.

POST api/Category/Add?idcust={idcust}

No documentation available.

POST api/Category/ModifyUser_Cat?idcust={idcust}

Define access permissions User vs Category

yDirectData

Direct data access.

APIDescription
POST api/yDirectData/FormatRawReturnMessage

No documentation available.