Skip to content

Commit 64c7779

Browse files
sagpembosagpembo
authored
Update README.md
1 parent f62e1f4 commit 64c7779

File tree

1 file changed

+237
-33
lines changed

1 file changed

+237
-33
lines changed

‎README.md‎

Lines changed: 237 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,103 @@ node wmiocli.js --help
3232
Usage: wmiocli [options] [command]
3333
3434
Options:
35-
-V, --version output the version number
36-
-d, --domain <tenantDomain> Tenant Doamin Name, e.g. "tenant.int-aws-us.webmethods.io"
37-
-u, --user <userid> Tenant User ID
38-
-p, --password <password> Tenant User Password
39-
-t, --timeout <delay> timeout in seconds (default: one minute)
40-
--prettyprint Pretty Print JSON output
41-
--verbose Verbose output useful for diagnosing issues
42-
-h, --help display help for command
35+
-V, --version
36+
output the version number
37+
-d, --domain <tenantDomain>
38+
Tenant Doamin Name, e.g. "tenant.int-aws-us.webmethods.io"
39+
-u, --user <userid>
40+
Tenant User ID
41+
-p, --password <password>
42+
Tenant User Password
43+
-t, --timeout <delay>
44+
timeout in seconds (default: one minute)
45+
--prettyprint
46+
Pretty Print JSON output
47+
--verbose
48+
Verbose output useful for diagnosing issues
49+
-h, --help
50+
display help for command
4351
4452
Commands:
45-
project [project-name] Lists all projects or view an individual project, specified via project name or uid
46-
project-assets <project-name> Lists project assets from given project name or uid
47-
project-create <project-name> Create project with given name
48-
project-update <project-id> <project-name> Update project with new name
49-
project-delete <project-id> Delete project with given id
53+
project [project-name]
54+
Lists all projects or view an individual project, specified via project name or uid
55+
project-assets <project-name>
56+
Lists project assets from given project name or uid
57+
project-create <project-name>
58+
Create project with given name
59+
project-update <project-id> <project-name>
60+
Update project with new name
61+
project-delete <project-id>
62+
Delete project with given id
5063
project-publish <project-id> <publish-name> <target-tenant-domain-name> <target-user-id> <target-user-password> <assets-json> Pubilsh project to another tenant with given id
51-
project-deploy <projectName> <version> deploy published project with given version into tenant
52-
role [role-id] Lists all roles or views an individual role
53-
role-create <role-name> <role-description> <roles-list> Create roles and specify the permissions for that role. Roles-list should be provided as follows projectName,r,w,e;project name 2,r;
54-
role-update <role-id> <role-name> <role-description> <roles-list> Create roles and specify the permissions for that role. Roles-list should be provided as follows projectName,r,w,e;project name 2,r;
55-
role-delete <roleId> Delete a roles with the given role id
56-
user Lists all users
57-
user-role-assignment <user-id> <role-names> Assigns a user to roles
58-
workflow-export <project-id> <workflow-id> <filename> Export workflow with id <workflow-id> from project <project-id>
59-
workflow-import <project-id> <filename> Import workflow into project <project-id> from file <filename>
60-
workflow-delete <project-id> <workflow-id> Delete workflow <workflow-id> from project <project-id>
61-
workflow-execute <project-id> <workflow-id> Execute workflow <workflow-id> from project <project-id>
62-
workflow-status <project-id> <run-id> Gets Execution status for workflow execution <run-id>
63-
flowservice-export <project-id> <flow-name> <file-name> Export FlowService with name <flow-name> from project <project-id>
64-
flowservice-import <project-id> <filename> Import FlowService from <filename> into project <project-id>
65-
flowservice-delete <project-id> <flow-name> Delete FlowService <flow-name> from project <project-id>
66-
flowservice-execute <project-id> <flow-name> [input-json] Execute FlowService <flow-name> from project <project-id> with data <input-json>
67-
help [command] display help for command
64+
project-deploy <projectName> <version>
65+
deploy published project with given version into tenant
66+
project-param <project-name> [param-uid]
67+
Lists all project parameters from given project name, or specific parameter with given paramater uid
68+
project-param-create <project-name> <param-name> <param-value> <required> <is-password>
69+
Creates a project parameter with given values
70+
project-param-update <project-name> <param-uid> <param-name> <param-value> <required> <is-password>
71+
Updates a project parameter matching the provided UID with given values
72+
project-param-delete <project-name> <param-uid>
73+
Deletes a project parameter mathcing the given paramater uid
74+
project-webhooks-list <project-id>
75+
List webhooks in a project
76+
project-webhooks-regenerate <project-id> <workflow-uid>
77+
Regenerate a webhook in a project for a given workflow UID
78+
project-webhooks-auth <project-id> <workflow-uid> <auth-type>
79+
Set authenatication type (none,login,token) for a webhook in a project for a given workflow UID
80+
role [role-id]
81+
Lists all roles or views an individual role
82+
role-create <role-name> <role-description> <roles-list>
83+
Create roles and specify the permissions for that role. Roles-list should be provided as follows projectName,r,w,e;project name 2,r;
84+
role-update <role-id> <role-name> <role-description> <roles-list>
85+
Create roles and specify the permissions for that role. Roles-list should be provided as follows projectName,r,w,e;project name 2,r;
86+
role-delete <roleId>
87+
Delete a roles with the given role id
88+
user
89+
Lists all users
90+
user-role-assignment <user-id> <role-names>
91+
Assigns a user to roles
92+
workflow-export <project-id> <workflow-id> <filename>
93+
Export workflow with id <workflow-id> from project <project-id>
94+
workflow-import <project-id> <filename>
95+
Import workflow into project <project-id> from file <filename>
96+
workflow-delete <project-id> <workflow-id>
97+
Delete workflow <workflow-id> from project <project-id>
98+
workflow-execute <project-id> <workflow-id>
99+
Execute workflow <workflow-id> from project <project-id>
100+
workflow-status <project-id> <run-id>
101+
Gets Execution status for workflow execution <run-id>
102+
flowservice-export <project-id> <flow-name> <file-name>
103+
Export FlowService with name <flow-name> from project <project-id>
104+
flowservice-import <project-id> <filename>
105+
Import FlowService from <filename> into project <project-id>
106+
flowservice-delete <project-id> <flow-name>
107+
Delete FlowService <flow-name> from project <project-id>
108+
flowservice-execute <project-id> <flow-name> [input-json]
109+
Execute FlowService <flow-name> from project <project-id> with data <input-json>
110+
theme [theme-uid]
111+
Lists themes or views an individual theme, specified via uid
112+
theme-create <theme-name> <theme-description> <theme-object> [footer-text] [about-page]
113+
Create theme with given data
114+
theme-update <theme-uid> <theme-name> <theme-description> <theme-object> [footer-text] [about-page]
115+
Update theme with the given UID with given data
116+
theme-delete <theme-uid>
117+
Delete theme with the given UID
118+
theme-activate <theme-uid>
119+
Activate theme with the given UID
120+
theme-deactivate <theme-uid>
121+
Deactivate theme with the given UID
122+
recipe [recipe-uid]
123+
List all Workflow recipes, or get a single recipe with a given recipe UID
124+
recipe-delete <recipe-uid>
125+
Delete Workflow recipe with a given recipe UID
126+
recipe-create <filename>
127+
Create Workfllow Receipt from file <filename>
128+
unofficial [recipe-uid]
129+
List all Workflow recipes, or get a single recipe with a given recipe UID
130+
help [command]
131+
display help for command
68132
69133
70134
Examples:
@@ -122,21 +186,80 @@ Examples:
122186
-p password
123187
project-assets fl65d3aa87fc1783ea5cf8c8
124188
125-
/Publish Project to another tenant:
189+
Publish Project to another tenant:
126190
$ node wmiocli.js
127191
-d tenant.int-aws-us.webmethods.io
128192
-u user
129193
-p password
130-
project-publish fl65d3aa87fc1783ea5cf8c8 'My deployment' 'target.int-aws-us.webmethods.io' 'targetuser' 'targetpassword' '{"output":{"workflows":["fla73a20e13dd6736cf9c355","fl3cfd145262bbc5d44acff3"],"flows":["mapLeads"],"rest_api":[],"soap_api":[],"listener":[],"messaging":[]}}'
194+
project-publish fl65d3aa87fc1783ea5cf8c8 'My deployment' 'target.int-aws-us.webmethods.io'
195+
'targetuser' 'targetpassword'
196+
'{"output":{"workflows":["fla73a20e13dd6736cf9c355","fl3cfd145262bbc5d44acff3"],
197+
"flows":["mapLeads"],"rest_api":[],"soap_api":[],"listener":[],"messaging":[]}}'
131198
132199
133-
/Deploy published Project in the tenant with the given name and deploy version:
200+
Deploy published Project in the tenant with the given name and deploy version:
134201
$ node wmiocli.js
135202
-d tenant.int-aws-us.webmethods.io
136203
-u user
137204
-p password
138205
project-deploy projectName 1
139206
207+
208+
List Project Workflow Parameters or gets an individual where name is specified
209+
$ node wmiocli.js
210+
-d tenant.int-aws-us.webmethods.io
211+
-u user
212+
-p password
213+
project-param projectName [param-name]
214+
215+
Create Project Workflow Parameter
216+
$ node wmiocli.js
217+
-d tenant.int-aws-us.webmethods.io
218+
-u user
219+
-p password
220+
project-param-create projectName param-name param-value required isPassword
221+
222+
e.g. node wmiocli.js -d env -u user -p pass project-param-create project name dave false false
223+
224+
Update Project Workflow Parameter
225+
$ node wmiocli.js
226+
-d tenant.int-aws-us.webmethods.io
227+
-u user
228+
-p password
229+
project-param-update projectName param-uid param-name param-value required isPassword
230+
231+
Delete Project Workflow Parameter
232+
$ node wmiocli.js
233+
-d tenant.int-aws-us.webmethods.io
234+
-u user
235+
-p password
236+
project-param-delete projectName param-uid
237+
238+
Project webhooks List
239+
$ node wmiocli.js
240+
-d tenant.int-aws-us.webmethods.io
241+
-u user
242+
-p password
243+
project-webhooks-list [project-uid]
244+
245+
Regenerate webhook token
246+
$ node wmiocli.js
247+
-d tenant.int-aws-us.webmethods.io
248+
-u user
249+
-p password
250+
project-webhooks-regenerate project-uid webhook-uid
251+
252+
Change webhook Auth
253+
$ node wmiocli.js
254+
-d tenant.int-aws-us.webmethods.io
255+
-u user
256+
-p password
257+
project-webhooks-auth project-uid webhook-uid auth-type<none,login,token>
258+
259+
e.g.
260+
node wmiocli.js -d env -u user -p pass project-webhooks-auth flf1111 flf2222 login
261+
262+
140263
Workflow
141264
142265
Export Workflow from a given project (identified from URL in webMethods.io when in workflow canvas,
@@ -237,4 +360,85 @@ Examples:
237360
-u user
238361
-p password
239362
role-delete 'roleId'
363+
364+
365+
Recipes
366+
367+
Get recipe list or individual recipe
368+
$ node wmiocli.js
369+
-d tenant.int-aws-us.webmethods.io
370+
-u user
371+
-p password
372+
recipe [recipe-Uid]
373+
374+
Creates a Workflow recipe from a workflow export
375+
$ node wmiocli.js
376+
-d tenant.int-aws-us.webmethods.io
377+
-u user
378+
-p password
379+
recipe-create export-flf111111.zip
380+
381+
Deletes a Workflow recipe with the provided UID
382+
$ node wmiocli.js
383+
-d tenant.int-aws-us.webmethods.io
384+
-u user
385+
-p password
386+
recipe-delete fl1771d591cfb4f31e558daf
387+
388+
389+
Themes
390+
391+
Lists whitelabel themes
392+
$ node wmiocli.js
393+
-d tenant.int-aws-us.webmethods.io
394+
-u user
395+
-p password
396+
theme [theme-uid]
397+
398+
The theme settings returned can be use as a way to create the theme.
399+
You can use jq to retrieve the theme settings by piping the output to jq, e.g.
400+
401+
node wmiocli.js -d env -u user -p pass theme fl40018d9a1a273bb8aa92bf | jq -c .output.settings.theme > ~/dracula-theme.txt
402+
403+
Deletes a whitelabel theme
404+
$ node wmiocli.js
405+
-d tenant.int-aws-us.webmethods.io
406+
-u user
407+
-p password
408+
theme-delete [theme-uid]
409+
410+
Creates a new whitelabel theme
411+
$ node wmiocli.js
412+
-d tenant.int-aws-us.webmethods.io
413+
-u user
414+
-p password
415+
theme-create dracula 'desc' [theme-settings] "Footer Text" "About Page"
416+
417+
Theme settings can be used from the list example above, e.g.
418+
node wmiocli.js -d env -u user -p pass theme-create dracula7 'updated' "`cat ~/dracula-theme.txt`" 'Footer' 'About'
419+
420+
Updates a whitelabel theme
421+
$ node wmiocli.js
422+
-d tenant.int-aws-us.webmethods.io
423+
-u user
424+
-p password
425+
theme-update themeid dracula 'desc' [theme-settings] "Footer Text" "About Page"
426+
427+
Theme settings can be used from the list example above, e.g.
428+
node wmiocli.js -d env -u user -p pass theme-update themeid dracula7 'updated' "`cat ~/dracula-theme.txt`" 'Footer' 'About'
429+
430+
Activates a whitelabel theme
431+
$ node wmiocli.js
432+
-d tenant.int-aws-us.webmethods.io
433+
-u user
434+
-p password
435+
theme-activate [theme-uid]
436+
437+
Deactivates a whitelabel theme
438+
$ node wmiocli.js
439+
-d tenant.int-aws-us.webmethods.io
440+
-u user
441+
-p password
442+
theme-deactivate [theme-uid]
443+
240444
```

0 commit comments

Comments
 (0)