Connectors Reference
Getting Answers Should be Easy. Go beyond the limits of your traditional knowledge base with EV Self Help. Easily capture and deliver knowledge like you never have before. Interact with your whole information system
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Execute |
|
|
GetPausedProcedureList (string sessionId, string locale, string versionId) |
Get paused procedure list |
|
GetProcedureList (string sessionId, string locale, string versionId) |
Get procedure list |
|
GetProjectList (string sessionId, string locale, [Optional]string mode) |
Get project list |
|
Search (string sessionId, string locale, string pattern, [Optional]string versionId) |
Search |
|
Get User |
|
|
Login ([Optional]string locale, string login, string password) |
Login |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Execute
Description: Start a procedure without user interaction
Syntax:
EasyvistaSelfHelp.Execute (string sessionId, string scenarioId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sessionId |
string (Session ID (Use the endpoint "Login")) |
Session ID (Use the endpoint "Login") |
True |
|
|
scenarioId |
string (The identifier or alias of the procedure to be launched) |
The identifier or alias of the procedure to be launched |
True |
Returns:
Type:ExecuteResponse
Summary: Get paused procedure list
Description: Get paused procedure list
Syntax:
EasyvistaSelfHelp.GetPausedProcedureList (string sessionId, string locale, string versionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sessionId |
string (Session ID (Use the endpoint "Login")) |
Session ID (Use the endpoint "Login") |
True |
|
|
locale |
string (Requested language) |
Requested language |
True |
|
|
versionId |
string (Project ID) |
Project ID |
True |
Returns:
Type:GetPausedProcedureListResponse
Summary: Get procedure list
Description: Get procedure list
Syntax:
EasyvistaSelfHelp.GetProcedureList (string sessionId, string locale, string versionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sessionId |
string (Session ID (Use the endpoint "Login")) |
Session ID (Use the endpoint "Login") |
True |
|
|
locale |
string (Requested language) |
Requested language |
True |
|
|
versionId |
string (Project ID) |
Project ID |
True |
Returns:
Summary: Get project list
Description: Get project list
Syntax:
EasyvistaSelfHelp.GetProjectList (string sessionId, string locale, [Optional]string mode)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sessionId |
string (Session ID (Use the endpoint "Login")) |
Session ID (Use the endpoint "Login") |
True |
|
|
locale |
string (Requested language) |
Requested language |
True |
|
|
mode |
string (mode) |
The value "conception" indicates that you want to recover the projects being written, an empty value indicates that you want to recover the published projects |
False |
Returns:
Summary: Search
Description: Search a keyword in one or more projects
Syntax:
EasyvistaSelfHelp.Search (string sessionId, string locale, string pattern, [Optional]string versionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sessionId |
string (Session ID (Use the endpoint "Login")) |
Session ID (Use the endpoint "Login") |
True |
|
|
locale |
string (Requested language) |
Requested language |
True |
|
|
pattern |
string (Request sent to the search engine (Ex : employee)) |
Request sent to the search engine (Ex : employee) |
True |
|
|
versionId |
string (Project ID) |
Project ID |
False |
Returns:
Type:SearchResponse
Summary: Get User
Description: Retrieve information from the logged in user
Syntax:
EasyvistaSelfHelp.GetUser (string sessionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sessionId |
string (Session ID (Use the endpoint "Login")) |
Session ID (Use the endpoint "Login") |
True |
Returns:
Type:GetUserResponse
Summary: Login
Description: Log in to an EasyVista Self Help session
Syntax:
EasyvistaSelfHelp.Login ([Optional]string locale, string login, string password)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
locale |
string (Requested language) |
Requested language |
False |
|
|
login |
string (Login) |
Login |
True |
|
|
password |
string (Password) |
Password |
True |
Returns:
Type:LoginResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
folders |
array of (FoldersItem)
|
folders |
|
hidden |
boolean
|
hidden |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
index |
string
|
index |
|
name |
string
|
name |
|
scenarios |
array of (ScenariosItem)
|
scenarios |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
folders |
array of (FoldersItem)
|
folders |
|
hidden |
boolean
|
hidden |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
index |
string
|
index |
|
name |
string
|
name |
|
scenarios |
array of (ScenariosItem)
|
scenarios |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
folders |
array of (FoldersItem)
|
folders |
|
hidden |
boolean
|
hidden |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
index |
string
|
index |
|
name |
string
|
name |
|
scenarios |
array of (ScenariosItem)
|
scenarios |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
domainId |
string
|
domainId |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
metadataProperties |
|
metadataProperties |
|
name |
string
|
name |
|
rank |
string
|
rank |
|
uid |
string
|
uid |
Summary:
Description: metadataProperties
Properties:
|
Name |
Type |
Summary |
|
ProcedureViewable |
string
|
ProcedureViewable |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
domainId |
string
|
domainId |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
metadataProperties |
|
metadataProperties |
|
name |
string
|
name |
|
rank |
string
|
rank |
|
uid |
string
|
uid |
Summary:
Description: metadataProperties
Properties:
|
Name |
Type |
Summary |
|
ProcedureViewable |
string
|
ProcedureViewable |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
domainList |
array of (DomainListItem)
|
domainList |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
name |
string
|
name |
|
projects |
array of (ProjectsItem)
|
projects |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
id |
string
|
id |
|
metadataProperties |
string
|
metadataProperties |
|
name |
string
|
name |
|
projectName |
string
|
projectName |
|
publicationDate |
string
|
publicationDate |
|
versionNumber |
string
|
versionNumber |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
|
|
expert |
boolean
|
expert |
|
firstName |
string
|
firstName |
|
grps |
|
grps |
|
lastName |
string
|
lastName |
|
login |
string
|
login |
|
properties |
string
|
properties |
|
sessionLess |
boolean
|
sessionLess |
|
title |
string
|
title |
Summary:
Description: grps
Properties:
|
Name |
Type |
Summary |
|
tempAdminGroup-8739-7439 |
string
|
tempAdminGroup-8739-7439 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
availableScenarios |
array of (AvailableScenariosItem)
|
availableScenarios |
|
bestRank |
string
|
bestRank |
|
domainId |
string
|
domainId |
|
locale |
string
|
locale |
|
pattern |
string
|
pattern |
|
scenarios |
array of (ScenariosItem)
|
scenarios |
|
searchTimeMs |
string
|
searchTimeMs |
|
searchUid |
string
|
searchUid |
|
userId |
string
|
userId |
|
userLogin |
string
|
userLogin |
|
versionId |
string
|
versionId |
|
worstRank |
string
|
worstRank |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
domainId |
string
|
domainId |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
metadataProperties |
|
metadataProperties |
|
name |
string
|
name |
|
rank |
string
|
rank |
Summary:
Description: metadataProperties
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
domainId |
string
|
domainId |
|
iconId |
string
|
iconId |
|
id |
string
|
id |
|
metadataProperties |
|
metadataProperties |
|
name |
string
|
name |
|
rank |
string
|
rank |
Summary:
Description: metadataProperties
Properties:
|
Name |
Type |
Summary |