visualvault-api 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +263 -0
- package/lib/VVRestApi/VVRestApiNodeJs/DocApi.js +66 -0
- package/lib/VVRestApi/VVRestApiNodeJs/FormsApi.js +51 -0
- package/lib/VVRestApi/VVRestApiNodeJs/NotificationsApi.js +39 -0
- package/lib/VVRestApi/VVRestApiNodeJs/StudioApi.js +136 -0
- package/lib/VVRestApi/VVRestApiNodeJs/VVRestApi.js +1889 -0
- package/lib/VVRestApi/VVRestApiNodeJs/app.js +128 -0
- package/lib/VVRestApi/VVRestApiNodeJs/common.js +1598 -0
- package/lib/VVRestApi/VVRestApiNodeJs/config.yml +100 -0
- package/lib/VVRestApi/VVRestApiNodeJs/dts/express.d.ts +125 -0
- package/lib/VVRestApi/VVRestApiNodeJs/dts/node.d.ts +1090 -0
- package/lib/VVRestApi/VVRestApiNodeJs/log.js +20 -0
- package/lib/VVRestApi/VVRestApiNodeJs/public/favicon.ico +0 -0
- package/lib/VVRestApi/VVRestApiNodeJs/routes/scheduledscripts.js +203 -0
- package/lib/VVRestApi/VVRestApiNodeJs/routes/scripts.js +215 -0
- package/lib/VVRestApi/VVRestApiNodeJs/routes/testScheduledScripts.js +131 -0
- package/lib/VVRestApi/VVRestApiNodeJs/samples/SampleScheduledScript.js +90 -0
- package/lib/VVRestApi/VVRestApiNodeJs/samples/SendEmailScript.js +51 -0
- package/lib/VVRestApi/VVRestApiNodeJs/samples/fileTest.js +60 -0
- package/lib/VVRestApi/VVRestApiNodeJs/samples/sampleFormValidationScript.js +126 -0
- package/lib/VVRestApi/VVRestApiNodeJs/views/error.ejs +8 -0
- package/lib/VVRestApi/VVRestApiNodeJs/views/index.ejs +8 -0
- package/package.json +98 -0
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
# VisualVault URIs
|
|
5
|
+
ApiUri: /api/v1/{custalias}/{custdbalias}
|
|
6
|
+
FormsApiUri: /api/v1
|
|
7
|
+
DocApiUri: /api/v1
|
|
8
|
+
NotificationsApiUri: /api/v1
|
|
9
|
+
AutheticateUri: /OAuth/Token
|
|
10
|
+
|
|
11
|
+
# VisualVault endpoints
|
|
12
|
+
ResourceUri:
|
|
13
|
+
ConfigurationDocApi: /configuration/docapi
|
|
14
|
+
ConfigurationFormsApi: /configuration/formsapi
|
|
15
|
+
ConfigurationStudioApi: /configuration/studioapi
|
|
16
|
+
ConfigurationNotificationApi: /configuration/notificationapi
|
|
17
|
+
DocumentsPost: /documents
|
|
18
|
+
DocumentsId: /documents/{id}
|
|
19
|
+
DocumentsIdCopy: /documents/{id}/copy
|
|
20
|
+
DocumentsIdMove: /documents/{id}/move
|
|
21
|
+
DocumentIndexFields: /documents/{id}/indexfields
|
|
22
|
+
DocumentAlertsId: /documents/{documentId}/alerts/{eventId}
|
|
23
|
+
DocumentsIdOcr: /documents/{id}/ocr
|
|
24
|
+
DocumentsIdRelateDocument: /documents/{id}/relateDocument
|
|
25
|
+
DocumentsIdExpiration: /documents/{id}/expiration
|
|
26
|
+
Files: /files
|
|
27
|
+
FilesQuery: /files?q=
|
|
28
|
+
FilesId: /files/{id}
|
|
29
|
+
FormTemplates: /formtemplates
|
|
30
|
+
FormTemplatesImport: /formtemplates/{id}/import
|
|
31
|
+
Forms: /formtemplates/{id}/forms
|
|
32
|
+
FormId: /formtemplates/{id}/forms/{formId}
|
|
33
|
+
FormIdPdf: /formtemplates/{id}/forms/{formId}/pdf
|
|
34
|
+
FormIdFields: /formtemplates/{id}/fields
|
|
35
|
+
FormsId: /forms/{id}
|
|
36
|
+
FormInstance: /forminstance/{id}
|
|
37
|
+
FormInstanceRelatedDocs: /forminstance/{id}/documents
|
|
38
|
+
FormInstanceRelatedForms: /forminstance/{id}/forms
|
|
39
|
+
FormInstanceUpdateOriginator: /forminstance/{id}/updateOriginator
|
|
40
|
+
FormDesignerFormsTemplatesIdFields: /formdesigner/forms/formtemplates/{id}/fields
|
|
41
|
+
FormInstanceImage: /FormEntity/{id}/setFieldImage
|
|
42
|
+
Sites: /sites
|
|
43
|
+
ChangeUserSite: /sites/changeusersite
|
|
44
|
+
User: /users
|
|
45
|
+
Users: /sites/{id}/users
|
|
46
|
+
UserWebToken: /users/{id}/webToken
|
|
47
|
+
UsersGetJwt: /users/getjwt
|
|
48
|
+
UserGroups: /users/{id}/groups
|
|
49
|
+
UserSupervisors: /users/{id}/supervisors
|
|
50
|
+
UserSupervisees: /users/{id}/supervisees
|
|
51
|
+
UserById: /users/{id}
|
|
52
|
+
UserDelete: /customerdatabase/{databaseId}/deleteuser/{authenticationUserId}
|
|
53
|
+
UsersPassword: /users/{id}/password
|
|
54
|
+
UsersIdUserId: /users/{id}/userId
|
|
55
|
+
GetGroups: /groups
|
|
56
|
+
Groups: /sites/{id}/groups
|
|
57
|
+
GroupsUsers: /groups/{id}/users
|
|
58
|
+
GroupsAddUser: /groups/{groupId}/users/{userId}
|
|
59
|
+
Folders: /folders
|
|
60
|
+
FoldersId: /folders/{id}
|
|
61
|
+
FoldersCopy: /folders/copy
|
|
62
|
+
FoldersMove: /folders/move
|
|
63
|
+
FolderIndexFields: /folders/{id}/indexfields
|
|
64
|
+
FoldersIdIndexFieldsId: /folders/{id}/indexfields/{indexFieldId}
|
|
65
|
+
FolderAlertsId: /folders/{folderId}/alerts/{eventId}
|
|
66
|
+
FolderSecurity: /folders/{folderId}/securitymembers
|
|
67
|
+
FolderSecurityId: /folders/{folderId}/securitymembers/{memberId}
|
|
68
|
+
Documents: /folders/{id}/documents
|
|
69
|
+
Emails: /emails
|
|
70
|
+
ScheduledProcess: /scheduledProcess
|
|
71
|
+
CustomQuery: /customquery
|
|
72
|
+
Scripts: /scripts
|
|
73
|
+
ScriptsCompleteWf: /scripts/CompleteWorkflowScript
|
|
74
|
+
ProjectAlertsId: /projects/{projectId}/alerts/{eventId}
|
|
75
|
+
Customers: /customers
|
|
76
|
+
CustomerInvite: /customers/invite
|
|
77
|
+
CustomerInviteId: /customers/invite/{inviteCode}
|
|
78
|
+
CustomerAssignUser: /customer/{customerId}/assignuser
|
|
79
|
+
CustomerDatabaseAssignUser: /customerdatabase/{databaseId}/assignuser
|
|
80
|
+
IndexFields: /indexfields
|
|
81
|
+
OutsideProcesses: /outsideprocesses
|
|
82
|
+
SecurityMembers: /securitymembers
|
|
83
|
+
Layout: /layout
|
|
84
|
+
ReportServerPDF: /ReportServer/{id}/PDF
|
|
85
|
+
DocApi:
|
|
86
|
+
GetRevision: /Documents/revisions/{id}
|
|
87
|
+
OcrStatus: /Documents/ocr/{id}
|
|
88
|
+
AdvancedSearch: /Search/Advanced
|
|
89
|
+
FormsApi:
|
|
90
|
+
FormInstance: /forminstance
|
|
91
|
+
StudioApi:
|
|
92
|
+
WorkflowLatestPublished: /workflows/latest/published
|
|
93
|
+
WorkflowLatestPublishedId: /workflows/latest/published/{id}
|
|
94
|
+
WorkflowVariables: /workflows/{id}/variables
|
|
95
|
+
WorkflowRun: /workflows/{id}/revisions/{revision}/run
|
|
96
|
+
WorkflowTerminate: /workflows/{workflowId}/instances/{instanceId}/complete
|
|
97
|
+
WorkflowHistoryObject: /workflowhistories/{workflowId}/objects/{objectId}
|
|
98
|
+
WorkflowHistoryRunningObject: /workflowhistories/{workflowId}/objects/{objectId}/running
|
|
99
|
+
NotificationsApi:
|
|
100
|
+
ForceUIRefresh: /Users/{id}/ForceUIRefresh
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
///<reference path='.\node.d.ts' />
|
|
2
|
+
|
|
3
|
+
declare module "express" {
|
|
4
|
+
export function createServer(): ExpressServer;
|
|
5
|
+
export function static (path: string): any;
|
|
6
|
+
import http = module("http");
|
|
7
|
+
export var listen;
|
|
8
|
+
|
|
9
|
+
// Connect middleware
|
|
10
|
+
export function bodyParser(options?: any): (req: ExpressServerRequest, res: ExpressServerResponse, next) => void;
|
|
11
|
+
export function errorHandler(opts?: any): (req: ExpressServerRequest, res: ExpressServerResponse, next) => void;
|
|
12
|
+
export function methodOverride(): (req: ExpressServerRequest, res: ExpressServerResponse, next) => void;
|
|
13
|
+
|
|
14
|
+
export interface ExpressSettings {
|
|
15
|
+
env?: string;
|
|
16
|
+
views?: string;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export interface ExpressServer {
|
|
20
|
+
set (name: string): any;
|
|
21
|
+
set (name: string, val: any): any;
|
|
22
|
+
enable(name: string): ExpressServer;
|
|
23
|
+
disable(name: string): ExpressServer;
|
|
24
|
+
enabled(name: string): bool;
|
|
25
|
+
disabled(name: string): bool;
|
|
26
|
+
configure(env: string, callback: () => void ): ExpressServer;
|
|
27
|
+
configure(env: string, env2: string, callback: () => void ): ExpressServer;
|
|
28
|
+
configure(callback: () => void ): ExpressServer;
|
|
29
|
+
settings: ExpressSettings;
|
|
30
|
+
engine(ext: string, callback: any): void;
|
|
31
|
+
param(param: Function): ExpressServer;
|
|
32
|
+
param(name: string, callback: Function): ExpressServer;
|
|
33
|
+
param(name: string, expressParam: any): ExpressServer;
|
|
34
|
+
param(name: any[], callback: Function): ExpressServer;
|
|
35
|
+
get (name: string): any;
|
|
36
|
+
get (path: string, handler: (req: ExpressServerRequest, res: ExpressServerResponse) => void ): void;
|
|
37
|
+
get (path: RegExp, handler: (req: ExpressServerRequest, res: ExpressServerResponse) => void ): void;
|
|
38
|
+
get (path: string, callbacks: any, callback: () => void ): void;
|
|
39
|
+
post(path: string, handler: (req: ExpressServerRequest, res: ExpressServerResponse) => void ): void;
|
|
40
|
+
post(path: RegExp, handler: (req: ExpressServerRequest, res: ExpressServerResponse) => void ): void;
|
|
41
|
+
post(path: string, callbacks: any, callback: () => void ): void;
|
|
42
|
+
all(path: string, callback: Function): void;
|
|
43
|
+
all(path: string, callback: Function, callback2: Function): void;
|
|
44
|
+
locals: any;
|
|
45
|
+
render(view: string, callback: (err: Error, html) => void ): void;
|
|
46
|
+
render(view: string, opts: any, callback: (err: Error, html) => void ): void;
|
|
47
|
+
routes: any;
|
|
48
|
+
router: (req: ExpressServerRequest, res: ExpressServerResponse, next?: Function) => void;
|
|
49
|
+
listen(port: number, hostname: string, backlog: number, callback: Function): void;
|
|
50
|
+
listen(port: number, callback: Function): void;
|
|
51
|
+
listen(path: string, callback?: Function): void;
|
|
52
|
+
listen(handle: any, listeningListener?: Function): void;
|
|
53
|
+
use(route: string, callback: Function): ExpressServer;
|
|
54
|
+
use(route: string, server: ExpressServer): ExpressServer;
|
|
55
|
+
use(callback: Function): ExpressServer;
|
|
56
|
+
use(server: ExpressServer): ExpressServer;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export class ExpressServerRequest extends http.ServerRequest {
|
|
60
|
+
params: any;
|
|
61
|
+
query: any;
|
|
62
|
+
body: any;
|
|
63
|
+
files: any;
|
|
64
|
+
param(name: string): any;
|
|
65
|
+
route: any;
|
|
66
|
+
cookies: any;
|
|
67
|
+
signedCookies: any;
|
|
68
|
+
get (field: string): string;
|
|
69
|
+
accepts(types: string): any;
|
|
70
|
+
accepts(types: string[]): any;
|
|
71
|
+
accepted: any;
|
|
72
|
+
is(type: string): bool;
|
|
73
|
+
ip: string;
|
|
74
|
+
ips: string[];
|
|
75
|
+
path: string;
|
|
76
|
+
host: string;
|
|
77
|
+
fresh: bool;
|
|
78
|
+
stale: bool;
|
|
79
|
+
xhr: bool;
|
|
80
|
+
protocol: string;
|
|
81
|
+
secure: bool;
|
|
82
|
+
subdomains: string[];
|
|
83
|
+
acceptedLanguages: string[];
|
|
84
|
+
acceptedCharsets: string[];
|
|
85
|
+
acceptsCharset(charset: string): bool;
|
|
86
|
+
acceptsLanguage(lang: string): bool;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export class ExpressServerResponse extends http.ServerResponse {
|
|
90
|
+
status(code: number): any;
|
|
91
|
+
set (field: any): void;
|
|
92
|
+
set (field: string, value: string): void;
|
|
93
|
+
header(field: any): void;
|
|
94
|
+
header(field: string, value: string): void;
|
|
95
|
+
get (field: string): any;
|
|
96
|
+
cookie(name: string, value: any, options?: any): void;
|
|
97
|
+
clearcookie(name: string, options?: any): void;
|
|
98
|
+
redirect(status: number, url: string): void;
|
|
99
|
+
redirect(url: string): void;
|
|
100
|
+
charset: string;
|
|
101
|
+
send(bodyOrStatus: any);
|
|
102
|
+
send(body: any, status: any);
|
|
103
|
+
send(body: any, headers: any, status: number);
|
|
104
|
+
json(bodyOrStatus: any);
|
|
105
|
+
json(body: any, status: any);
|
|
106
|
+
json(body: any, headers: any, status: number);
|
|
107
|
+
jsonp(bodyOrStatus: any);
|
|
108
|
+
jsonp(body: any, status: any);
|
|
109
|
+
jsonp(body: any, headers: any, status: number);
|
|
110
|
+
type(type: string): void;
|
|
111
|
+
format(object: any): void;
|
|
112
|
+
attachment(filename?: string);
|
|
113
|
+
sendfile(path: string): void;
|
|
114
|
+
sendfile(path: string, options: any): void;
|
|
115
|
+
sendfile(path: string, options: any, fn: (err: Error) => void ): void;
|
|
116
|
+
download(path: string): void;
|
|
117
|
+
download(path: string, filename: string): void;
|
|
118
|
+
download(path: string, filename: string, fn: (err: Error) => void ): void;
|
|
119
|
+
links(links: any): void;
|
|
120
|
+
locals: any;
|
|
121
|
+
render(view: string, locals: any): void;
|
|
122
|
+
render(view: string, callback: (err: Error, html: any) => void ): void;
|
|
123
|
+
render(view: string, locals: any, callback: (err: Error, html: any) => void ): void;
|
|
124
|
+
}
|
|
125
|
+
}
|