en-US/FreshService.Tools-help.xml
|
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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 |
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-FsRequesterGroupMember</command:name> <command:verb>Add</command:verb> <command:noun>FsRequesterGroupMember</command:noun> <maml:description> <maml:para>Add a new member to a requester group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a Requester to a group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-FsRequesterGroupMember</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Display Id of the Requester Group (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Display Id of the Requester to add to the Group (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-FsRequesterGroupMember -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Id 1 -MemberId 56</dev:code> <dev:remarks> <maml:para>Add Requester with ID 56 to requester group with ID: 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Add Requester to Requester Group</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#add_member_to_requester_group</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsAgent</command:name> <command:verb>Get</command:verb> <command:noun>FsAgent</command:noun> <maml:description> <maml:para>Get details of a Agent, or a list of all Agents</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Agent, given the name or Id. If neither are provided, all Agents are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAgent</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Display Id of the Agent (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Agent</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email Address of the Agent</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter Query for list of agents *Note: *</maml:para> <maml:para>1. Query can be framed using the name of the agent fields, which can be obtained from the Supported Agent Fields Section. 1. Logical operators AND, OR along with parenthesis( ) can be used to group conditions. 1. Relational operators greater than or equal to :> and less than or equal to :< can be used along with date fields and numeric fields. 1. Input for date field should be in UTC Format. 1. To filter for fields with no values assigned, use the null keyword. 1. Please note that any update made to an agent either in Freshservice application or through API may take a few minutes to get indexed, after which the updated results will be available through API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Joe Bloggs"</dev:code> <dev:remarks> <maml:para>Get details of Agent named Joe Bloggs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 007</dev:code> <dev:remarks> <maml:para>Get details of Agent with Id 007.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Email 'joe.bloggs@domain.com'</dev:code> <dev:remarks> <maml:para>Get details of Agent with e-mail address joe.bloggs@domain.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Agents.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Agents</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#agent_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsAgentGroup</command:name> <command:verb>Get</command:verb> <command:noun>FsAgentGroup</command:noun> <maml:description> <maml:para>Get details of a Group, or a list of all Groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Agent Group, given the name or Id. If neither are provided, all Groups are returned. If no match on Name, $null is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAgentGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Agent Group (the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Agent Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>regex</maml:name> <maml:description> <maml:para>Use the Name parameter as a regular expression</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Level 1"</dev:code> <dev:remarks> <maml:para>Get details of Agent Group named Level 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 066</dev:code> <dev:remarks> <maml:para>Get details of Agent Group with Id 066.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Agent Groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Level|Designers" -regex</dev:code> <dev:remarks> <maml:para>Get details of Agent Groups containing 'Level' or 'Design'. Sample: 'Level 1', 'Level 2', 'Web Designers', 'Graphics Designers'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Agent Groups</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#groups</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsAsset</command:name> <command:verb>Get</command:verb> <command:noun>FsAsset</command:noun> <maml:description> <maml:para>Get details of a Asset, or a list of all Assets</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Asset, given the name or Id. If neither are provided, all Assets are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAsset</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Display Id of the Asset (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Asset</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter Query for list of Assets *Note: *</maml:para> <maml:para>1. Query can be framed using the name of the Asset fields, which can be obtained from the Supported Asset Fields Section. 1. Logical operators AND, OR along with parenthesis( ) can be used to group conditions. 1. Relational operators greater than or equal to :> and less than or equal to :< can be used along with date fields and numeric fields. 1. Input for date field should be in UTC Format. 1. To filter for fields with no values assigned, use the null keyword. 1. Please note that any update made to an Asset either in Freshservice application or through API may take a few minutes to get indexed, after which the updated results will be available through API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAsset -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Server1"</dev:code> <dev:remarks> <maml:para>Get details of Asset named Joe Bloggs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAsset -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 23</dev:code> <dev:remarks> <maml:para>Get details of Asset with Id 007.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsAsset -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Assets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Assets</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Asset_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsAsset</command:name> <command:verb>Get</command:verb> <command:noun>FsAsset</command:noun> <maml:description> <maml:para>Get details of an Asset Type, or a list of all Asset Types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Asset Type given the Id. If the Id is not provided, all Asset Types are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAsset</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Internal Id of the Asset Type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAssetTypes -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 1001</dev:code> <dev:remarks> <maml:para>Get details of Asset Type with Id 1001.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAssetTypes -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Asset Typess.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Assets</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Asset_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsChange</command:name> <command:verb>Get</command:verb> <command:noun>FsChange</command:noun> <maml:description> <maml:para>Get details of a Change, or a list of all Changes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a Change, given the Id. Matching changes if using UpdatedSince. If neither are provided, all Changes are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsChange</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Display Id of the Change (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsChange -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -UpdatedSince 2021-08-23</dev:code> <dev:remarks> <maml:para>Get a list of all changes updated since 2012-08-23 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsChange -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 42</dev:code> <dev:remarks> <maml:para>Get details of Change with Id 42.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsChange -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Change_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsChangeFields</command:name> <command:verb>Get</command:verb> <command:noun>FsChangeFields</command:noun> <maml:description> <maml:para>Get details of the fields available/requuired for a Change</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a field available or required for a Change, given the Id or Name. If neither are provided, all Change Form Fields are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsChangeFields</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Internal Id of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Field Name of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsChangeFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name 'external_reference'</dev:code> <dev:remarks> <maml:para>Get details about the Change Field named external_reference</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsChangeFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 8009</dev:code> <dev:remarks> <maml:para>Get details of Change Field= with Id 8009.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsChangeFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Change Fields.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Change_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsRequesterGroup</command:name> <command:verb>Get</command:verb> <command:noun>FsRequesterGroup</command:noun> <maml:description> <maml:para>Get details of a Requester Group, or a list of all Requester Groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Requester Group, given the name or Id. If neither are provided, all Requester Groups are returned. If no match on Name, $null is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsRequesterGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Requester Group (the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Requester Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>regex</maml:name> <maml:description> <maml:para>Use the Name parameter as a regular expression</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsRequesterGroup -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Requester Groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsRequesterGroup -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Id 066</dev:code> <dev:remarks> <maml:para>Get details of Requester Group with Id 066.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsRequesterGroup -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Id 066 -Members</dev:code> <dev:remarks> <maml:para>Get details of Requester Group with Id 066 & include all members</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:> Get-FsRequesterGroup -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Name "Level|Designers" -regex</dev:code> <dev:remarks> <maml:para>Get details of Requester Groups containing 'Level' or 'Design'. Sample: 'Level 1', 'Level 2', 'Web Designers', 'Graphics Designers'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:> $Groups = Get-FsRequesterGroup -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Name "Level|Designers" -regex PS C:> $Group1 = $Groups[0] | Get-FsRequesterGroup -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Members</dev:code> <dev:remarks> <maml:para>> Looking up members uses an extra API call for each group and may return a lot more data depending on how many members there are. Therefore, you may want to only return members for select groups.</maml:para> <maml:para>Get details of Requester Groups containing 'Level' or 'Design'. Sample: 'Level 1', 'Level 2', 'Web Designers', 'Graphics Designers'</maml:para> <maml:para>Then</maml:para> <maml:para>Get the group information and it's members for the first group</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Requester Groups</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#requester-groups</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsTicket</command:name> <command:verb>Get</command:verb> <command:noun>FsTicket</command:noun> <maml:description> <maml:para>Get details of a Ticket, or a list of all Tickets</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a Ticket, given the Id. Matching Tickets if using UpdatedSince or Filter. If none are provided, all Tickets are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsTicket</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Display Id of the Ticket (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UpdatedSince</maml:name> <maml:description> <maml:para>List all ticket since this Date/Time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter Query for list of Tickets *Note: *</maml:para> <maml:para>1. Query can be framed using the name of the agent fields, which can be obtained from the Supported Agent Fields Section. 1. Logical operators AND, OR along with parenthesis( ) can be used to group conditions. 1. Relational operators greater than or equal to :> and less than or equal to :< can be used along with date fields and numeric fields. 1. Input for date field should be in UTC Format. 1. To filter for fields with no values assigned, use the null keyword. 1. Please note that any update made to an agent either in Freshservice application or through API may take a few minutes to get indexed, after which the updated results will be available through API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Only the output of the -Id operations outputs custom fields associated to the Ticket. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicket -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -UpdatedSince 2021-08-23</dev:code> <dev:remarks> <maml:para>Get a list of all Tickets updated since 2012-08-23 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicket -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 42</dev:code> <dev:remarks> <maml:para>Get details of Ticket with Id 42.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicket -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Tickets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Tickets</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Ticket_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsTicketFieldChoice</command:name> <command:verb>Get</command:verb> <command:noun>FsTicketFieldChoice</command:noun> <maml:description> <maml:para>Get the list of choices available for a field in a Ticket</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the list of available values for a field, or $null if all values are valid.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsTicketFieldChoice</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Internal Id of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Field Name of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFieldChoice -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -FieldName 'source' -Id 2 id value -- ----- 2 Portal</dev:code> <dev:remarks> <maml:para>Get the details of the choice for the source field with an id of 2</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFieldChoice -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -FieldName 'status' -name 'New' id value requester_display_value -- ----- ----------------------- 6 New Waiting to be Processed</dev:code> <dev:remarks> <maml:para>Get details of the choice with a value of 'New' in the status field</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFieldChoice -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -FieldName 'my_custom_field' id display_id value -- ---------- ----- 75000100003 3 Value 1 75000100004 4 Value 2 75000100005 5 Value 3 75000100009 6 Value 4 75000100006 7 Value 5</dev:code> <dev:remarks> <maml:para>List all possible values for a custom field named my_custom_field</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Ticket_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FsTicketFields</command:name> <command:verb>Get</command:verb> <command:noun>FsTicketFields</command:noun> <maml:description> <maml:para>Get details of the fields available/requuired for a Ticket</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a field available or required for a Ticket, given the Id or Name. If neither are provided, all Ticket Form Fields are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsTicketFields</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Internal Id of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Field Name of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name 'external_reference'</dev:code> <dev:remarks> <maml:para>Get details about the Ticket Field named external_reference</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 8009</dev:code> <dev:remarks> <maml:para>Get details of Ticket Field with Id 8009.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Ticket Fields.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Ticket_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-FreshServiceAlertRequest</command:name> <command:verb>Invoke</command:verb> <command:noun>FreshServiceAlertRequest</command:noun> <maml:description> <maml:para>Send an alert message to the FreshService Alert Interface.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Send an Alert Message to a FreshService Alert Profile. This allows FreshService to manage escalation and recovery processes, including creating tickets and updating their status as additional alerts are received. Avoids the creation of duplicate tickets when repeat notifications are generated for the same item.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-FreshServiceAlertRequest</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The alert integration URL for the specific Alert Integration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the Auth Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AlertBody</maml:name> <maml:description> <maml:para>A psobject or Hash containing the elements to be sent as part of the alert. Will be converted to JSON before sending.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>*Alert Management overview *</maml:para> <maml:para>Freshservice allows you to seamlessly integrate with multiple monitoring tools and triage all your alert information in one place. The incoming alerts are then intelligently grouped to help you cut through the noise and quickly get to the bottom of the issue. You can also set up alert rules to automatically create actionable-incidents and notify your team to begin immediate resolution. Know more (https://support.freshservice.com/en/support/solutions/articles/50000002885-alert-management-in-freshservice-an-overview) *What is an alert profile? *</maml:para> <maml:para>Alert profiles allow you to integrate with one or more monitoring tools and help you consolidate alerts impacting a specific business or technical service. *Integrations *</maml:para> <maml:para>FreshService provides Out-of-the-Box integrations for a number of common systems, including:</maml:para> <maml:para>* SolarWinds NPM (Orion)</maml:para> <maml:para>* Microsoft Azure - Metric Alerts</maml:para> <maml:para>* NagiosXI</maml:para> <maml:para>* Google Cloud Monitor</maml:para> <maml:para>* Microsoft SCOM</maml:para> <maml:para>* PRTG Network Monitor</maml:para> <maml:para>* ZABBIX</maml:para> <maml:para>* ManageEngine OpManager</maml:para> <maml:para>* Custom Integration</maml:para> <maml:para></maml:para> <maml:para>The list is being regularly expanded, and where a standard integration does not suit requirements, the Custom Integration may be used to implement exactly what you need. *Custom Integration *</maml:para> <maml:para>Each integration works by specifying a JSON body to define the alert content, with a Custom Integration allowing complete control of the JSON Body Content.</maml:para> <maml:para>The JSON body fields are then mapped to Alert Fields within FreshService. The following FreshService AlertFields are available ( italics are mandatory): Resource* - Denotes the name of the monitored entity. It could be the Hostname, Application Name or Service name, based on the monitored entity. Metric Name* - The performance aspect of the resource that is monitored : CPU utilisation, Throughput, etc * Metric Value - Value of the monitored metric</maml:para> <maml:para>* Node - Denotes the MAC Address or IP Address of the machine</maml:para> <maml:para>* Message - The message that denotes the context of the alert</maml:para> <maml:para>* Description - Description of the issue Severity* - Severity denotes the impact and the urgency with which it should be acted upon. * Tags - Tags help you classify incoming alerts using keywords</maml:para> <maml:para>* Additional Information - Select up to 5 fields with additional information about the alert</maml:para> <maml:para>* Occurrence time - Time of creation of the alert</maml:para> <maml:para></maml:para> <maml:para>The severity values provided by the integrated solution are then mapped to severities within FreshService. A Severity of OK is used to reset the alert. *Authorization *</maml:para> <maml:para>To authorize the integration, copy the Endpoint URL and Auth Header values to be used with the call. The Auth Header should be stored securely, hence using this as a PSCredential object with this function. Only store the auth-key value in the PSCredential object, not the entire Auth Header provided by FreshService.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AlertURL = 'https://domain.au-alerts.freshservice.com/alert_profiles/50000000000/integrations/50000000000/alerts' $AlertCred = Get-Credential -Username 'FreshService Alerts Auth Key' > PowerShell credential request > Enter your credentials. > Password for user FreshService Alerts Auth Key: ************************************************************************ $AlertBody = @{} $AlertBody.Add('Severity','high') $AlertBody.Add('Node',$Hostname) $AlertBody.Add('MetricName',$Metric) $AlertBody.Add('Message', $Message) $AlertBody.Add('Description', $Description) $AlertBody.Add('AlertTime', $AlertTime) Invoke-FreshServiceAlertRequest -Uri $AlertUrl -Credential $AlertCred -Body $AlertBody</dev:code> <dev:remarks> <maml:para>Send an alert message to a FreshService Alert integration.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService Alert Management</maml:linkText> <maml:uri>https://support.freshservice.com/en/support/solutions/articles/50000002885-alert-management-in-freshservice-an-overview</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-FsRequesterGroupMember</command:name> <command:verb>Remove</command:verb> <command:noun>FsRequesterGroupMember</command:noun> <maml:description> <maml:para>Removes a current member from a requester group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Requester from a group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-FsRequesterGroupMember</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Display Id of the Requester Group (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Display Id of the Requester to remove from the Group (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-FsRequesterGroupMember -Uri "https://domain.freshservice.com/api/v2" -Credential (Get-PSCredential) -Id 1 -MemberId 56</dev:code> <dev:remarks> <maml:para>Remove Requester with ID 56 from requester group with ID: 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Delete Requester from Requester Group</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#delete_member_from_requester_group</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-FsRequester</command:name> <command:verb>Update</command:verb> <command:noun>FsRequester</command:noun> <maml:description> <maml:para>Update details of a Requester, or a list of all Requesters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the details of a requester, given the requester Id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-FsRequester</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Requester Group (the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>Hashtable containing the updates to the given requester.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Update-FsRequester -Uri "https://ipsec.freshservice.com/api/v2" -Credential (Get-Credential) -Id 888 -Body $Body</dev:code> <dev:remarks> <maml:para>Update details for requester with ID: 888</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\>$Requesters | Update-FsRequester -Uri "https://ipsec.freshservice.com/api/v2" -Credential (Get-Credential) -Body $Body</dev:code> <dev:remarks> <maml:para>Updates details for all requesters in the $Requesters object with the details in $Body</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\>$RequesterChanges Id Body -- ---- 8 {last_name} 9 {last_name} PS C:\>$RequesterChanges[0].Body Name Value ---- ----- last_name Potter PS C:\>$RequesterChanges | Update-FsRequester -Uri "https://ipsec.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Updated the reuqesters with ID 8 & 9 and applies the relevant changes to their last names</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Updateing a Requester</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#update_a_requester</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |