KBaseKnowledgeEngine/KBaseKnowledgeEngine.spec at master · kbaseattic/KBaseKnowledgeEngine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
A KBase module: KBaseKnowledgeEngine
*/

module KBaseKnowledgeEngine {
	/* A boolean. 0 = false, other = true. */
	typedef int boolean;

	/*
	  state - one of queued, started, finished, error.
	  output - either empty for queued/started states or error message for error state or output message for finished.
	*/
	typedef structure {
		string user;
		string obj_ref;
		string obj_type;
		string connector_app;
		string connector_title;
		string job_id;
		string state;
		string output;
		int new_re_nodes;
		int updated_re_nodes;
		int new_re_links;
		int queued_epoch_ms;
		int started_epoch_ms;
		int finished_epoch_ms;
	} ConnectorStatus;

	funcdef getConnectorsStatus() returns (list<ConnectorStatus>) authentication required;

	funcdef cleanConnectorErrors() returns () authentication required;

	/*
	  state - one of none, queued, started, finished, error.
	  output - either empty for queued/started states or error message for error state or output message for finished.
	*/
	typedef structure {
		string user;
		string app;
		string app_title;
		string job_id;
		string state;
		string output;
		int new_re_nodes;
		int updated_re_nodes;
		int new_re_links;
		int queued_epoch_ms;
		int started_epoch_ms;
		int finished_epoch_ms;
		int scheduled_epoch_ms;
	} AppStatus;

	funcdef getAppsStatus() returns (list<AppStatus>) authentication required;

	/*
	  app - name of registered KB-SDK module configured to be compatible with KE.
	  ref_mode - flag for public reference data processing (accessible only for admins).
	*/
	typedef structure {
		string app;
		boolean ref_mode;
	} RunAppParams;

	typedef structure {
		string job_id;
	} RunAppOutput;

	/*
		Execute KE-App.
	*/
	funcdef runApp(RunAppParams params) returns (RunAppOutput) authentication required;

	typedef structure {
		string obj_ref;
	} GetConnectorStateParams;

	funcdef getConnectorState(GetConnectorStateParams params) returns (string) authentication required;

	typedef structure {
		string app;
	} CleanAppDataParams;

	/*
	  Only admins can run this function.
	*/
	funcdef cleanAppData(CleanAppDataParams params) returns () authentication required;

	typedef structure {
		int accessGroupId;
		string accessGroupObjectId;
		int version;
	} LoadEventsForObjRefInput;

	typedef structure {
		string storageCode;
		int accessGroupId;
		string accessGroupObjectId;
		int version;
		string newName;
		int timestamp;
		string eventType;
		string storageObjectType;
		int storageObjectTypeVersion;
		int isGlobalAccessed;
		int processed;
	} WSEvent;

	funcdef loadEventsForObjRef(LoadEventsForObjRefInput params) returns (list<WSEvent>) authentication required;
};