9 "systemCommand": "true",
10 "description": "quit execution of command handling, this command quits immediately without saving the model"
18 "systemCommand": "true",
19 "description": "go back one level in editor context hierarchy"
27 "systemCommand": "true",
28 "description": "output help information appropriate to this point in the editor context hierarchy"
37 "argumentName": "fileName",
39 "description": "Name of a file containing an Apex model in JSON or XML format"
42 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.loadFromFile",
43 "description": "Load an Apex model from a file"
52 "argumentName": "fileName",
54 "description": "Name of the file to save the model to"
57 "argumentName": "xmlFlag",
59 "description": "Flag indicating that the model should be saved in XML format, model saved in JSON format if flag is false or is not specified"
62 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.saveToFile",
63 "description": "Save an Apex model to a file"
71 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.analyse",
72 "description": "Analyse an Apex model to show concept usage"
80 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.validate",
81 "description": "Validate the entire Apex model to ensure it is consistent"
90 "argumentName": "otherModelFileName",
92 "description": "The file name of the other model"
95 "argumentName": "diffsOnly",
97 "description": "Flag indicating that only differences between the model are returned when set"
100 "argumentName": "keysOnly",
102 "description": "Flag indicating that only keys are printed when set, more terse output"
105 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.compare",
106 "description": "Compare an Apex model with another Apex model"
115 "argumentName": "targetModelName",
117 "description": "the file name of the target model in which to store the model split out from the original model"
120 "argumentName": "splitOutPolicies",
122 "description": "the policies form the original model to include in the split out model, specified as a comma delimited list of policy names"
125 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.split",
126 "description": "Split an Apex model into a separate Apex model with only the specified policies"
135 "argumentName": "mergeInModelName",
137 "description": "the file name of the model to merge into the current model"
140 "argumentName": "keepOriginal",
142 "description": "if true, if a concept exists in both models, the original model copy of that concept is kept, if false, the mreged model overwrites"
145 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexModel.merge",
146 "description": "Merge another Apex model into this model"
149 "name": "createModel",
156 "argumentName": "name",
158 "description": "name of the model"
161 "argumentName": "version",
163 "description": "version of the model, omit to use the default version"
166 "argumentName": "uuid",
168 "description": "model UUID, omit to generate a UUID"
171 "argumentName": "description",
173 "description": "model description, omit to generate a description"
176 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createModel",
177 "description": "Create an Apex model."
186 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listModel",
187 "description": "List an Apex model, list all the concepts in the model"
190 "name": "deleteModel",
196 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteModel",
197 "description": "Delete an Apex model, clear all the concepts in the model"
200 "name": "createKeyInformation",
207 "argumentName": "name",
209 "description": "name of the concept for the key information"
212 "argumentName": "version",
214 "description": "version of the concept for the key information, omit to use the default version"
217 "argumentName": "uuid",
219 "description": "key information UUID, set to null to generate a UUID"
222 "argumentName": "description",
224 "description": "concept description, omit to generate a description"
227 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createKeyInformation",
228 "description": "Create key information"
231 "name": "updateKeyInformation",
238 "argumentName": "name",
240 "description": "name of the concept for the key information"
243 "argumentName": "version",
245 "description": "version of the concept for the key information, omit to update the latest version"
248 "argumentName": "uuid",
250 "description": "key information UUID, omit to not update"
253 "argumentName": "description",
255 "description": "concept description, omit to not update"
258 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updateKeyInformation",
259 "description": "Update key information"
262 "name": "listKeyInformation",
269 "argumentName": "name",
271 "description": "name of the concept for the key information, omit to list all"
274 "argumentName": "version",
276 "description": "starting version of the concept for the key information, omit to list all versions"
279 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.ListKeyInformation",
280 "description": "List key information"
283 "name": "deleteKeyInformation",
290 "argumentName": "name",
292 "description": "name of the concept for the key information"
295 "argumentName": "version",
297 "description": "version of the concept for the key information, omit to delete all versions"
300 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteKeyInformation",
301 "description": "Delete key information"
304 "name": "validateKeyInformation",
311 "argumentName": "name",
313 "description": "name of the concept for the key information"
316 "argumentName": "version",
318 "description": "version of the concept for the key information, omit to validate all versions"
321 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.validateKeyInformation",
322 "description": "Validate key information"
325 "name": "createSchema",
332 "argumentName": "name",
334 "description": "name of the schema"
337 "argumentName": "version",
339 "description": "version of the schema, omit to use the default version"
342 "argumentName": "flavour",
344 "description": "the flavour of the technology for this schema, defaults to \"Java\""
347 "argumentName": "schema",
349 "description": "the schema text that describes the item represented by the schema"
352 "argumentName": "uuid",
354 "description": "schema UUID, omit to generate a UUID"
357 "argumentName": "description",
359 "description": "schema description, omit to generate a description"
362 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createContextSchema",
363 "description": "Create a schema."
366 "name": "updateSchema",
373 "argumentName": "name",
375 "description": "name of the schema"
378 "argumentName": "version",
380 "description": "version of the schema, omit to use the default version"
383 "argumentName": "flavour",
385 "description": "the flavour of the technology for this schema, defaults to \"Java\""
388 "argumentName": "schema",
390 "description": "the schema text that describes the item represented by the schema"
393 "argumentName": "uuid",
395 "description": "schema UUID, omit to generate a UUID"
398 "argumentName": "description",
400 "description": "schema description, omit to generate a description"
403 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updateContextSchema",
404 "description": "Update a schema."
407 "name": "listSchemas",
414 "argumentName": "name",
416 "description": "name of the schema, omit to list all"
419 "argumentName": "version",
421 "description": "starting version of the schema, omit to list all versions"
424 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listContextSchemas",
425 "description": "List schemas."
428 "name": "deleteSchema",
435 "argumentName": "name",
437 "description": "name of the schema"
440 "argumentName": "version",
442 "description": "version of the schema, omit to delete all versions"
445 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteContextSchema",
446 "description": "Delete a schema."
449 "name": "validateSchemas",
456 "argumentName": "name",
458 "description": "name of the schema, omit to list all"
461 "argumentName": "version",
463 "description": "starting version of the schema, omit to list all versions"
466 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.validateContextSchemas",
467 "description": "Validate context schemas."
470 "name": "createEvent",
477 "argumentName": "name",
479 "description": "name of the event"
482 "argumentName": "version",
484 "description": "version of the event, omit to use the default version"
487 "argumentName": "nameSpace",
489 "description": "of the event, omit to use the default value"
492 "argumentName": "source",
494 "description": "of the event, omit to use the default value"
497 "argumentName": "target",
499 "description": "of the event, omit to use the default value"
502 "argumentName": "uuid",
504 "description": "event UUID, omit to generate a UUID"
507 "argumentName": "description",
509 "description": "event description, omit to generate a description"
512 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createEvent",
513 "description": "Create an event."
516 "name": "updateEvent",
523 "argumentName": "name",
525 "description": "name of the event"
528 "argumentName": "version",
530 "description": "version of the event, omit to use the latest version"
533 "argumentName": "nameSpace",
535 "description": "of the event, omit to not update"
538 "argumentName": "source",
540 "description": "of the event, omit to not update"
543 "argumentName": "target",
545 "description": "of the event, omit to not update"
548 "argumentName": "uuid",
550 "description": "event UUID, omit to not update"
553 "argumentName": "description",
555 "description": "event description, omit to not update"
558 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updateEvent",
559 "description": "Update an event."
569 "argumentName": "name",
571 "description": "name of the event, omit to list all"
574 "argumentName": "version",
576 "description": "starting version of the event, omit to list all versions"
579 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listEvent",
580 "description": "List events."
583 "name": "deleteEvent",
590 "argumentName": "name",
592 "description": "name of the event"
595 "argumentName": "version",
597 "description": "version of the event, omit to delete all versions"
600 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteEvent",
601 "description": "Delete an event."
604 "name": "validateEvent",
611 "argumentName": "name",
613 "description": "name of the event, omit to list all"
616 "argumentName": "version",
618 "description": "starting version of the event, omit to list all versions"
621 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.validateEvent",
622 "description": "Validate events."
625 "name": "createEventPar",
633 "argumentName": "name",
635 "description": "name of the event"
638 "argumentName": "version",
640 "description": "version of the event, omit to use the latest version"
643 "argumentName": "parName",
645 "description": "of the parameter"
648 "argumentName": "schemaName",
650 "description": "name of the parameter schema"
653 "argumentName": "schemaVersion",
655 "description": "version of the parameter schema, omit to use the latest version"
658 "argumentName": "optional",
660 "description": "indicates if the parameter is optional, if omitted, the parameter is mandatory"
663 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createEventPar",
664 "description": "Create an event parameter."
667 "name": "listEventPar",
675 "argumentName": "name",
677 "description": "name of the event"
680 "argumentName": "version",
682 "description": "version of the event, omit to list latest version"
685 "argumentName": "parName",
687 "description": "name of the parameter, omit to list all parameters of the event"
690 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listEventPar",
691 "description": "List event parameters."
694 "name": "deleteEventPar",
702 "argumentName": "name",
704 "description": "name of the event"
707 "argumentName": "version",
709 "description": "version of the event, omit to use the latest version"
712 "argumentName": "parName",
714 "description": "of the parameter, omit to delete all parameters"
717 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteEventPar",
718 "description": "Delete an event parameter."
721 "name": "createAlbum",
728 "argumentName": "name",
730 "description": "name of the context album"
733 "argumentName": "version",
735 "description": "version of the context album, omit to use the default version"
738 "argumentName": "scope",
740 "description": "scope of application of the context album"
743 "argumentName": "writable",
745 "description": "true if the album is writable, false otherwise, album defaults to writable if omitted"
748 "argumentName": "schemaName",
750 "description": "name of the album schema"
753 "argumentName": "schemaVersion",
755 "description": "version of the album schema, omit to use the latest version"
758 "argumentName": "uuid",
760 "description": "context album UUID, omit to generate a UUID"
763 "argumentName": "description",
765 "description": "album description, omit to generate a description"
768 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createContextAlbum",
769 "description": "Create a context album."
772 "name": "updateAlbum",
779 "argumentName": "name",
781 "description": "name of the context album"
784 "argumentName": "version",
786 "description": "version of the context album, omit to use the latest version"
789 "argumentName": "scope",
791 "description": "scope of application of the context album"
794 "argumentName": "writable",
796 "description": "true if the album is writable, false otherwise, album defaults to writable if omitted"
799 "argumentName": "schemaName",
801 "description": "name of the album schema"
804 "argumentName": "schemaVersion",
806 "description": "version of the album schema, omit to use the latest version"
809 "argumentName": "uuid",
811 "description": "context album UUID, omit to not update"
814 "argumentName": "description",
816 "description": "album description, omit to not update"
819 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updateContextAlbum",
820 "description": "Update a context album."
830 "argumentName": "name",
832 "description": "name of the context album, omit to list all"
835 "argumentName": "version",
837 "description": "starting version of the context album, omit to list all versions"
840 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listContextAlbum",
841 "description": "List context albums."
844 "name": "deleteAlbum",
851 "argumentName": "name",
853 "description": "name of the context album"
856 "argumentName": "version",
858 "description": "version of the context album, omit to delete versions"
861 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteContextAlbum",
862 "description": "Delete a context album."
865 "name": "validateAlbum",
872 "argumentName": "name",
874 "description": "name of the context album, omit to list all"
877 "argumentName": "version",
879 "description": "starting version of the context album, omit to list all versions"
882 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.validateContextAlbum",
883 "description": "Validate context albums."
886 "name": "createTask",
893 "argumentName": "name",
895 "description": "name of the task"
898 "argumentName": "version",
900 "description": "version of the task, omit to use the default version"
903 "argumentName": "uuid",
905 "description": "task UUID, omit to generate a UUID"
908 "argumentName": "description",
910 "description": "task description, omit to generate a description"
913 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createTask",
914 "description": "Create a task."
917 "name": "updateTask",
924 "argumentName": "name",
926 "description": "name of the task"
929 "argumentName": "version",
931 "description": "version of the task, omit to use the latest version"
934 "argumentName": "uuid",
936 "description": "task UUID, omit to not update"
939 "argumentName": "description",
941 "description": "task description, omit to not update"
944 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updateTask",
945 "description": "Update a task."
955 "argumentName": "name",
957 "description": "name of the task, omit to list all"
960 "argumentName": "version",
962 "description": "starting version of the task, omit to list all versions"
965 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listTask",
966 "description": "List tasks."
969 "name": "deleteTask",
976 "argumentName": "name",
978 "description": "name of the task"
981 "argumentName": "version",
983 "description": "version of the task, omit to use the latest version"
986 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteTask",
987 "description": "Delete a task."
990 "name": "validateTask",
997 "argumentName": "name",
999 "description": "name of the task, omit to list all"
1002 "argumentName": "version",
1004 "description": "starting version of the task, omit to list all versions"
1007 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.validateTask",
1008 "description": "Validate tasks."
1011 "name": "createTaskLogic",
1019 "argumentName": "name",
1021 "description": "name of the task"
1024 "argumentName": "version",
1026 "description": "version of the task, omit to use the latest version"
1029 "argumentName": "logicFlavour",
1031 "description": "the task logic flavour for the task, omit to use the default task logic flavour"
1034 "argumentName": "logic",
1036 "description": "the source code for the logic of the task"
1039 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createTaskLogic",
1040 "description": "Create logic for a task."
1043 "name": "updateTaskLogic",
1051 "argumentName": "name",
1053 "description": "name of the task"
1056 "argumentName": "version",
1058 "description": "version of the task, omit to use the latest version"
1061 "argumentName": "logicFlavour",
1063 "description": "the task logic flavour for the task, omit to not update"
1066 "argumentName": "logic",
1068 "description": "the source code for the logic of the task, omit to not update"
1071 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updateTaskLogic",
1072 "description": "Update logic for a task."
1075 "name": "listTaskLogic",
1083 "argumentName": "name",
1085 "description": "name of the task"
1088 "argumentName": "version",
1090 "description": "version of the task, omit to list the latest version"
1093 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listTaskLogic",
1094 "description": "List task logic."
1097 "name": "deleteTaskLogic",
1105 "argumentName": "name",
1107 "description": "name of the task"
1110 "argumentName": "version",
1112 "description": "version of the task, omit to use the latest version"
1115 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteTaskLogic",
1116 "description": "Delete logic for a task."
1119 "name": "createTaskInputField",
1127 "argumentName": "name",
1129 "description": "name of the task"
1132 "argumentName": "version",
1134 "description": "version of the task, omit to use the latest version"
1137 "argumentName": "fieldName",
1139 "description": "of the input field"
1142 "argumentName": "schemaName",
1144 "description": "name of the input field schema"
1147 "argumentName": "schemaVersion",
1149 "description": "version of the input field schema, omit to use the latest version"
1152 "argumentName": "optional",
1154 "description": "indicates if the field is optional, if omitted, the field is mandatory"
1157 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createTaskInputField",
1158 "description": "Create a task input field."
1161 "name": "listTaskInputField",
1169 "argumentName": "name",
1171 "description": "name of the task"
1174 "argumentName": "version",
1176 "description": "version of the task, omit to use the latest version"
1179 "argumentName": "fieldName",
1181 "description": "field name of the input field, omit to list all input fields of the task"
1184 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listTaskInputField",
1185 "description": "List task input fields."
1188 "name": "deleteTaskInputField",
1196 "argumentName": "name",
1198 "description": "name of the task"
1201 "argumentName": "version",
1203 "description": "version of the task, omit to use the latest version"
1206 "argumentName": "fieldName",
1208 "description": "of the input field, omit to delete all input fields"
1211 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteTaskInputField",
1212 "description": "Delete a task input field."
1215 "name": "createTaskOutputField",
1223 "argumentName": "name",
1225 "description": "name of the task"
1228 "argumentName": "version",
1230 "description": "version of the task, omit to use the latest version"
1233 "argumentName": "fieldName",
1235 "description": "of the output field"
1238 "argumentName": "schemaName",
1240 "description": "name of the output field schema"
1243 "argumentName": "schemaVersion",
1245 "description": "version of the output field schema, omit to use the latest version"
1248 "argumentName": "optional",
1250 "description": "indicates if the field is optional, if omitted, the field is mandatory"
1253 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createTaskOutputField",
1254 "description": "Create a task output field."
1257 "name": "listTaskOutputField",
1265 "argumentName": "name",
1267 "description": "name of the task"
1270 "argumentName": "version",
1272 "description": "version of the task, omit to use the latest version"
1275 "argumentName": "fieldName",
1277 "description": "field name of the output field, omit to list all output fields of the task"
1280 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listTaskOutputField",
1281 "description": "List task output fields."
1284 "name": "deleteTaskOutputField",
1292 "argumentName": "name",
1294 "description": "name of the task"
1297 "argumentName": "version",
1299 "description": "version of the task, omit to use the latest version"
1302 "argumentName": "fieldName",
1304 "description": "of the output field, omit to delete all output fields"
1307 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteTaskOutputField",
1308 "description": "Delete a task output field."
1311 "name": "createTaskParameter",
1319 "argumentName": "name",
1321 "description": "name of the task"
1324 "argumentName": "version",
1326 "description": "version of the task, omit to use the latest version"
1329 "argumentName": "parName",
1331 "description": "of the parameter"
1334 "argumentName": "defaultValue",
1336 "description": "of the parameter"
1339 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createTaskParameter",
1340 "description": "Create a task parameter."
1343 "name": "listTaskParameter",
1351 "argumentName": "name",
1353 "description": "name of the task"
1356 "argumentName": "version",
1358 "description": "version of the task, omit to use the latest version"
1361 "argumentName": "parName",
1363 "description": "name of the parameter, omit to list all parameters of the task"
1366 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listTaskParameter",
1367 "description": "List task parameters."
1370 "name": "deleteTaskParameter",
1378 "argumentName": "name",
1380 "description": "name of the task"
1383 "argumentName": "version",
1385 "description": "version of the task, omit to use the latest version"
1388 "argumentName": "parName",
1390 "description": "of the parameter, omit to delete all task parameters"
1393 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteTaskParameter",
1394 "description": "Delete a task parameter."
1397 "name": "createTaskContextRef",
1405 "argumentName": "name",
1407 "description": "name of the task"
1410 "argumentName": "version",
1412 "description": "version of the task, omit to use the latest version"
1415 "argumentName": "albumName",
1417 "description": "name of the context album for the context reference"
1420 "argumentName": "albumVersion",
1422 "description": "version of the context album for the context reference, omit to use the latest version"
1425 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createTaskContextRef",
1426 "description": "Create a task context reference."
1429 "name": "listTaskContextRef",
1437 "argumentName": "name",
1439 "description": "name of the task"
1442 "argumentName": "version",
1444 "description": "version of the task, omit to use the latest version"
1447 "argumentName": "albumName",
1449 "description": "name of the context album for the context reference, omit to list all task context references"
1452 "argumentName": "albumVersion",
1454 "description": "version of the context album for the context reference, omit to use the latest version"
1457 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listTaskContextRef",
1458 "description": "List task context references."
1461 "name": "deleteTaskContextRef",
1469 "argumentName": "name",
1471 "description": "name of the task"
1474 "argumentName": "version",
1476 "description": "version of the task, omit to use the latest version"
1479 "argumentName": "albumName",
1481 "description": "name of the context album for the context reference, omit to delete all task context references"
1484 "argumentName": "albumVersion",
1486 "description": "version of the context album for the context reference, omit to use the latest version"
1489 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deleteTaskContextRef",
1490 "description": "Delete a task context reference."
1493 "name": "createPolicy",
1500 "argumentName": "name",
1502 "description": "name of the policy"
1505 "argumentName": "version",
1507 "description": "version of the policy, omit to use the default version"
1510 "argumentName": "template",
1512 "description": "template used to create the policy, omit to use the default template"
1515 "argumentName": "firstState",
1517 "description": "the first state of the policy"
1520 "argumentName": "uuid",
1522 "description": "policy UUID, omit to generate a UUID"
1525 "argumentName": "description",
1527 "description": "policy description, omit to generate a description"
1530 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicy",
1531 "description": "Create a policy."
1534 "name": "updatePolicy",
1541 "argumentName": "name",
1543 "description": "name of the policy"
1546 "argumentName": "version",
1548 "description": "version of the policy, omit to use the latest version"
1551 "argumentName": "template",
1553 "description": "template used to create the policy, omit to not update"
1556 "argumentName": "firstState",
1558 "description": "the first state of the policy"
1561 "argumentName": "uuid",
1563 "description": "policy UUID, omit to not update"
1566 "argumentName": "description",
1568 "description": "policy description, omit to not update"
1571 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updatePolicy",
1572 "description": "Update a policy."
1575 "name": "listPolicy",
1582 "argumentName": "name",
1584 "description": "name of the policy, omit to list all"
1587 "argumentName": "version",
1589 "description": "starting version of the policy, omit to list all versions"
1592 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicy",
1593 "description": "List policies."
1596 "name": "deletePolicy",
1603 "argumentName": "name",
1605 "description": "name of the policy"
1608 "argumentName": "version",
1610 "description": "version of the policy, omit to use the latest version"
1613 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicy",
1614 "description": "Delete a policy."
1617 "name": "validatePolicy",
1624 "argumentName": "name",
1626 "description": "name of the policy, omit to list all"
1629 "argumentName": "version",
1631 "description": "starting version of the policy, omit to list all versions"
1634 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.validatePolicy",
1635 "description": "Validate policies."
1638 "name": "createPolicyState",
1646 "argumentName": "name",
1648 "description": "name of the policy"
1651 "argumentName": "version",
1653 "description": "version of the policy, omit to use the latest version"
1656 "argumentName": "stateName",
1658 "description": "of the state"
1661 "argumentName": "triggerName",
1663 "description": "name of the trigger event for this state"
1666 "argumentName": "triggerVersion",
1668 "description": "version of the trigger event for this state, omit to use the latest version"
1671 "argumentName": "defaultTaskName",
1673 "description": "the default task name"
1676 "argumentName": "defaultTaskVersion",
1678 "description": "the default task version, omit to use the latest version"
1681 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicyState",
1682 "description": "Create a policy state."
1685 "name": "updatePolicyState",
1693 "argumentName": "name",
1695 "description": "name of the policy"
1698 "argumentName": "version",
1700 "description": "version of the policy, omit to use the latest version"
1703 "argumentName": "stateName",
1705 "description": "of the state"
1708 "argumentName": "triggerName",
1710 "description": "name of the trigger event for this state, omit to not update"
1713 "argumentName": "triggerVersion",
1715 "description": "version of the trigger event for this state, set to use latest version of trigger event"
1718 "argumentName": "defaultTaskName",
1720 "description": "the default task name, omit to not update"
1723 "argumentName": "defaultTaskVersion",
1725 "description": "the default task version, set to use latest version of default task"
1728 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updatePolicyState",
1729 "description": "Update a policy state."
1732 "name": "listPolicyState",
1740 "argumentName": "name",
1742 "description": "name of the policy"
1745 "argumentName": "version",
1747 "description": "version of the policy, omit to use the latest version"
1750 "argumentName": "stateName",
1752 "description": "of the state, omit to list all states of the policy"
1755 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicyState",
1756 "description": "List policy states."
1759 "name": "deletePolicyState",
1767 "argumentName": "name",
1769 "description": "name of the policy"
1772 "argumentName": "version",
1774 "description": "version of the policy, omit to use the latest version"
1777 "argumentName": "stateName",
1779 "description": "of the state, omit to delete all states"
1782 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicyState",
1783 "description": "Delete a policy state."
1786 "name": "createPolicyStateTaskSelectionLogic",
1795 "argumentName": "name",
1797 "description": "name of the policy"
1800 "argumentName": "version",
1802 "description": "version of the policy, omit to use the latest version"
1805 "argumentName": "stateName",
1807 "description": "of the state"
1810 "argumentName": "logicFlavour",
1812 "description": "the task selection logic flavour for the state, omit to use the default task logic flavour"
1815 "argumentName": "logic",
1817 "description": "the source code for the logic of the state"
1820 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicyStateTaskSelectionLogic",
1821 "description": "Create task selection logic for a state."
1824 "name": "updatePolicyStateTaskSelectionLogic",
1833 "argumentName": "name",
1835 "description": "name of the policy"
1838 "argumentName": "version",
1840 "description": "version of the policy, omit to use the latest version"
1843 "argumentName": "stateName",
1845 "description": "of the state"
1848 "argumentName": "logicFlavour",
1850 "description": "the task selection logic flavour for the state, omit to not update"
1853 "argumentName": "logic",
1855 "description": "the source code for the logic of the state, omit to not update"
1858 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updatePolicyStateTaskSelectionLogic",
1859 "description": "Update task selection logic for a state."
1862 "name": "listPolicyStateTaskSelectionLogic",
1871 "argumentName": "name",
1873 "description": "name of the policy"
1876 "argumentName": "version",
1878 "description": "version of the policy, omit to use the latest version"
1881 "argumentName": "stateName",
1883 "description": "of the state"
1886 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicyStateTaskSelectionLogic",
1887 "description": "List task selection logic for a state."
1890 "name": "deletePolicyStateTaskSelectionLogic",
1899 "argumentName": "name",
1901 "description": "name of the policy"
1904 "argumentName": "version",
1906 "description": "version of the policy, omit to use the latest version"
1909 "argumentName": "stateName",
1911 "description": "of the state"
1914 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicyStateTaskSelectionLogic",
1915 "description": "Delete task selection logic for a state."
1918 "name": "createPolicyStateOutput",
1927 "argumentName": "name",
1929 "description": "name of the policy"
1932 "argumentName": "version",
1934 "description": "version of the policy, omit to use the latest version"
1937 "argumentName": "stateName",
1939 "description": "of the state"
1942 "argumentName": "outputName",
1944 "description": "of the state output"
1947 "argumentName": "eventName",
1949 "description": "name of the output event for this state output"
1952 "argumentName": "eventVersion",
1954 "description": "version of the output event for this state output, omit to use the latest version"
1957 "argumentName": "nextState",
1959 "description": "for this state to transition to, omit if this is the last state that the policy transitions to on this branch"
1962 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicyStateOutput",
1963 "description": "Create a policy state output."
1966 "name": "listPolicyStateOutput",
1975 "argumentName": "name",
1977 "description": "name of the policy"
1980 "argumentName": "version",
1982 "description": "version of the policy, omit to use the latest version"
1985 "argumentName": "stateName",
1987 "description": "of the state"
1990 "argumentName": "outputName",
1992 "description": "of the state output, omit to list all outputs of the state"
1995 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicyStateOutput",
1996 "description": "List policy state outputs."
1999 "name": "deletePolicyStateOutput",
2008 "argumentName": "name",
2010 "description": "name of the policy"
2013 "argumentName": "version",
2015 "description": "version of the policy, omit to use the latest version"
2018 "argumentName": "stateName",
2020 "description": "of the state"
2023 "argumentName": "outputName",
2025 "description": "of the state output, omit to delete all state outputs"
2028 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicyStateOutput",
2029 "description": "Delete a policy state output."
2032 "name": "createPolicyStateFinalizerLogic",
2041 "argumentName": "name",
2043 "description": "name of the policy"
2046 "argumentName": "version",
2048 "description": "version of the policy, omit to use the latest version"
2051 "argumentName": "stateName",
2053 "description": "of the state"
2056 "argumentName": "finalizerLogicName",
2058 "description": "name of the state finalizer logic"
2061 "argumentName": "logicFlavour",
2063 "description": "the policy finalizer logic flavour for the state, omit to use the default task logic flavour"
2066 "argumentName": "logic",
2068 "description": "the source code for the logic of the state"
2071 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicyStateFinalizerLogic",
2072 "description": "Create policy finalizer logic for a state."
2075 "name": "updatePolicyStateFinalizerLogic",
2084 "argumentName": "name",
2086 "description": "name of the policy"
2089 "argumentName": "version",
2091 "description": "version of the policy, omit to use the latest version"
2094 "argumentName": "stateName",
2096 "description": "of the state"
2099 "argumentName": "finalizerLogicName",
2101 "description": "name of the state finalizer logic"
2104 "argumentName": "logicFlavour",
2106 "description": "the policy finalizer logic flavour for the state, omit to not update"
2109 "argumentName": "logic",
2111 "description": "the source code for the logic of the state, omit to not update"
2114 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.updatePolicyStateFinalizerLogic",
2115 "description": "Update policy finalizer logic for a state."
2118 "name": "listPolicyStateFinalizerLogic",
2127 "argumentName": "name",
2129 "description": "name of the policy"
2132 "argumentName": "version",
2134 "description": "version of the policy, omit to use the latest version"
2137 "argumentName": "stateName",
2139 "description": "of the state"
2142 "argumentName": "finalizerLogicName",
2144 "description": "name of the state finalizer logic"
2147 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicyStateFinalizerLogic",
2148 "description": "List policy finalizer logic for a state."
2151 "name": "deletePolicyStateFinalizerLogic",
2160 "argumentName": "name",
2162 "description": "name of the policy"
2165 "argumentName": "version",
2167 "description": "version of the policy, omit to use the latest version"
2170 "argumentName": "stateName",
2172 "description": "of the state"
2175 "argumentName": "finalizerLogicName",
2177 "description": "name of the state finalizer logic"
2180 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicyStateFinalizerLogic",
2181 "description": "Delete policy finalizer logic for a state."
2184 "name": "createPolicyStateTaskRef",
2193 "argumentName": "name",
2195 "description": "name of the policy"
2198 "argumentName": "version",
2200 "description": "version of the policy, omit to use the latest version"
2203 "argumentName": "stateName",
2205 "description": "of the state"
2208 "argumentName": "taskLocalName",
2210 "description": "local name of the task in the state, omit to use the task name"
2213 "argumentName": "taskName",
2215 "description": "name of the task"
2218 "argumentName": "taskVersion",
2220 "description": "version of the task, omit to use the latest version"
2223 "argumentName": "outputType",
2225 "description": "Type of output for the task, must be DIRECT for direct output to a state output or LOGIC for output to state finalizer logic"
2228 "argumentName": "outputName",
2230 "description": "the name of the state output or state state finalizer logic to handle the task output"
2233 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicyStateTaskRef",
2234 "description": "Create a policy state task reference."
2237 "name": "listPolicyStateTaskRef",
2246 "argumentName": "name",
2248 "description": "name of the policy"
2251 "argumentName": "version",
2253 "description": "version of the policy, omit to use the latest version"
2256 "argumentName": "stateName",
2258 "description": "of the state"
2261 "argumentName": "taskName",
2263 "description": "name of the task, omit to list all task references"
2266 "argumentName": "taskVersion",
2268 "description": "version of the task, omit to use the latest version"
2271 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicyStateTaskRef",
2272 "description": "List policy state task references."
2275 "name": "deletePolicyStateTaskRef",
2284 "argumentName": "name",
2286 "description": "name of the policy"
2289 "argumentName": "version",
2291 "description": "version of the policy, omit to use the latest version"
2294 "argumentName": "stateName",
2296 "description": "of the state"
2299 "argumentName": "taskName",
2301 "description": "name of the task, omit to delete all task references"
2304 "argumentName": "taskVersion",
2306 "description": "version of the task, omit to use the latest version"
2309 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicyStateTaskRef",
2310 "description": "Delete a policy state task reference."
2313 "name": "createPolicyStateContextRef",
2322 "argumentName": "name",
2324 "description": "name of the policy"
2327 "argumentName": "version",
2329 "description": "version of the policy, omit to use the latest version"
2332 "argumentName": "stateName",
2334 "description": "of the state"
2337 "argumentName": "albumName",
2339 "description": "name of the context album for the context reference"
2342 "argumentName": "albumVersion",
2344 "description": "version of the context album for the context reference, omit to use the latest version"
2347 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.createPolicyStateContextRef",
2348 "description": "Create a policy state context reference."
2351 "name": "listPolicyStateContextRef",
2360 "argumentName": "name",
2362 "description": "name of the policy"
2365 "argumentName": "version",
2367 "description": "version of the policy, omit to use the latest version"
2370 "argumentName": "stateName",
2372 "description": "of the state"
2375 "argumentName": "albumName",
2377 "description": "name of the context album for the context reference, omit to list all task context references"
2380 "argumentName": "albumVersion",
2382 "description": "version of the context album for the context reference, omit to use the latest version"
2385 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.listPolicyStateContextRef",
2386 "description": "List policy state context references."
2389 "name": "deletePolicyStateContextRef",
2398 "argumentName": "name",
2400 "description": "name of the policy"
2403 "argumentName": "version",
2405 "description": "version of the policy, omit to use the default version"
2408 "argumentName": "stateName",
2410 "description": "of the state"
2413 "argumentName": "albumName",
2415 "description": "name of the context album for the context reference, omit to delete all task context references"
2418 "argumentName": "albumVersion",
2420 "description": "version of the context album for the context reference, omit to use the latest version"
2423 "apiMethod": "org.onap.policy.apex.model.modelapi.ApexEditorAPI.deletePolicyStateContextRef",
2424 "description": "Delete a policy state context reference."