PowerShellForLockpath/docs/api/insomnia/insomnia.json at master · RobertKlohr/PowerShellForLockpath · GitHub

1
{"_type":"export","__export_format":4,"__export_date":"2022-07-29T20:33:47.443Z","__export_source":"insomnia.desktop.app:v2022.2.1","resources":[{"_id":"req_53a67d369b6b401a9443f311acdf7501","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1659126741167,"created":1639620869987,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/Login","name":"Login","description":"Accepts a username and password, verifies them, and provides encrypted cookies (.ASPXAUTH and NGSecure). The **.ASPXAUTH cookie is used to authenticate additional API transactions.** *The response code will always be 200 but the body will be `true` if the login is sucessful and `false` if the login is unsucessful.*\n\nIf Auto-Provision is enabled for LDAP Profile and the authenticated user does not have a Lockpath application\naccount, one will be created with API access enabled and then authenticated to the application.\n\n* Permissions: The authentication account must have:\n    * API Access enabled in the Integrated Risk Management Platform\n\t\t\n* Input:\n    * Username (string): Username for the Lockpath application account.\n    * Password (string): Password for the Lockpath application account.\n\n```response:200\ntrue\n```\n\n```response:200\nfalse\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n\t\"username\": \"{{ _.apiaccount }}\",\n\t\"password\": \"{{ _.apiPassword }}\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_b284af491eca4211acc1b90f637c25c2"},{"description":"","disabled":false,"id":"pair_0df60d602de94e7aaf8ca12aaa93475e","name":"Content-Type","value":"application/json"}],"authentication":{},"metaSortKey":-1000000000,"isPrivate":false,"settingStoreCookies":true,"settingSendCookies":false,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_ab75d63158be4f209d68cebe4c66b839","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1643963534015,"created":1639624403410,"name":"Security Services","description":"The Security Services include the available methods for logging in and logging out of the Integrated Risk Management Platform and methods for getting, creating, updating, and deleting users and groups.\n\nThe Login call generates an encrypted cookie in the return header. This cookie must be captured and used as a parameter in all ComponentServices, ReportServices, and AssessmentServices calls to verify identity and set permissions.\n\nPermissions for the data that the API can access are based on permissions of the Logon account that is used. For example, if the login account has read-only permissions to an asset table, the API returns data for user viewing but does not allow update or delete functions to be performed.","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1639624481034,"_type":"request_group"},{"_id":"wrk_1c95d493c17a4566a1de3adbb525a18f","parentId":null,"modified":1659126222647,"created":1639525241256,"name":"Lockpath API Documentation 6.0","description":"API endpoint configurations for Lockpath Cloud. To use the requests you first need to configure the host names in the Sandbox and Production environment configurations.\n\nNOTE: API methods are case-sensitive. Verify that you are entering the proper syntax and case for the API call as documented.\n\n***400 Errors***\n\nIf the endpiont request type is **POST** or **DELETE** then it is possible to get the following response if the JSON is not valid.\n\n```response:400\n{\n\t\"Message\": \"Failed to deserialize JSON, please ensure it is formatted correctly.\",\n\t\"StackTrace\": null\n}\n```\n\n***404 Errors***\n\nIf you have an error in your endpoint URI you will get a Content-Type\ttext/html; charset=UTF-8 respone with the following HTML in the response body.\n\n```response:404\n<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n  <head>\n    <title>Service</title>\n    <style>BODY { color: #000000; background-color: white; font-family: Verdana; margin-left: 0px; margin-top: 0px; } #content { margin-left: 30px; font-size: .70em; padding-bottom: 2em; } A:link { color: #336699; font-weight: bold; text-decoration: underline; } A:visited { color: #6699cc; font-weight: bold; text-decoration: underline; } A:active { color: #336699; font-weight: bold; text-decoration: underline; } .heading1 { background-color: #003366; border-bottom: #336699 6px solid; color: #ffffff; font-family: Tahoma; font-size: 26px; font-weight: normal;margin: 0em 0em 10px -20px; padding-bottom: 8px; padding-left: 30px;padding-top: 16px;} pre { font-size:small; background-color: #e5e5cc; padding: 5px; font-family: Courier New; margin-top: 0px; border: 1px #f0f0e0 solid; white-space: pre-wrap; white-space: -pre-wrap; word-wrap: break-word; } table { border-collapse: collapse; border-spacing: 0px; font-family: Verdana;} table th { border-right: 2px white solid; border-bottom: 2px white solid; font-weight: bold; background-color: #cecf9c;} table td { border-right: 2px white solid; border-bottom: 2px white solid; background-color: #e5e5cc;}</style>\n  </head>\n  <body>\n    <div id=\"content\">\n      <p class=\"heading1\">Service</p>\n      <p>Endpoint not found.</p>\n    </div>\n  </body>\n</html>\n```","scope":"collection","_type":"workspace"},{"_id":"req_d077b6a0af2c44fdaa20e0b42c6f35a0","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1644546607087,"created":1643968644686,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/Ping","name":"Ping","description":"Refreshes a valid session.\n\n* Permissions: The authentication account must have:\n    * API Access enabled in the Integrated Risk Management Platform\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"A valid session is required for API access.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999950,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_88ef4cf8f8db4b77b031337315b7b910","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1644546614145,"created":1643968850796,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/Logout","name":"Logout","description":"Terminates a session.\n\n* Permissions: The authentication account must have:\n    * API Access enabled in the Integrated Risk Management Platform\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"A valid session is required for API access.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999900,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_9156af5bb0e94e55b79fc3a891fa3e29","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1659125895348,"created":1644022863812,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/GetUser","name":"Get User","description":"Returns all fields for a given user.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to Administer - Users\n* Vendor Contact accounts must also have:\n    * General Access - Read permissions to Vendor Profiles\n    * View permissions to Vendor Profiles workflow stage\n    * Vendor Profiles record permissions\n\n```response:200\n{\n  \"Id\": 1055,\n  \"FullName\": \"User, Test\",\n  \"Username\": \"testuser\",\n  \"Active\": true,\n  \"Locked\": false,\n  \"Deleted\": false,\n  \"AccountType\": 1,\n  \"FirstName\": \"Test\",\n  \"MiddleName\": \"\",\n  \"LastName\": \"User\",\n  \"Title\": \"\",\n  \"Language\": 1033,\n  \"EmailAddress\": \"test@user.com\",\n  \"HomePhone\": \"\",\n  \"WorkPhone\": \"\",\n  \"MobilePhone\": \"\",\n  \"Fax\": \"\",\n  \"IsSAML\": false,\n  \"IsLDAP\": false,\n  \"SecurityConfiguration\": {\n    \"Id\": 1,\n    \"DisplayName\": \"Standard Configuration\"\n  },\n  \"APIAccess\": false,\n  \"Groups\": [],\n  \"SecurityRoles\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"End User\"\n    }\n  ],\n  \"FunctionalRoles\": []\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"Id","value":"a","description":"The Id of the desired user. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999850,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_48d39769fbb342c0b86aa81a77a22665","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1659125479121,"created":1644024251246,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/GetUsers","name":"Get Users","description":"Returns an integer representing the count of all Full Users, Vendors Contact Users, and Awareness Users in the application. Using the optional FieldFilter you can return records for only certain user types, such as Active, Deleted, or users by a particular AccountType or Vendor Contacts by a certain Vendor Profile.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to Administer - Users\n* Vendor Contact accounts must also have:\n    * General Access - Read permissions to Vendor Profiles\n    * View permissions to Vendor Profiles workflow stage\n    * Vendor Profiles record permissions\n\t\t\n* Input:\n    * pageIndex (Integer): The index of the page of result to return. Must be > 0\n    * pageSize (Integer): The size of the page results to return. Must be >= 1\n    * FieldFilter (optional): The filter parameters the users must meet to be included.\n\n|FieldFilter (ShortName)|FilterType|Value|\n|:--|:--|:--|\n|Active|5 (Equal To)|True, False|\n||6 (NotEqualTo)||\n|Deleted|5 (Equal To)|True, False|\n||6 (NotEqualTo)||\n|AccountType|5 (Equal To)|1 (Full User), 2 (Vendor Contact), 4 (Awareness User)|\n||6 (NotEqualTo)||\n||10002 (Contains Any)||\n|Vendor|5 (Equal To)|Vendor Profile ID for the Vendor Contact|\n\n```response:200\n[\n  {\n    \"Id\": 9,\n    \"FullName\": \"User, Test\",\n    \"Username\": \"testuser\",\n    \"Active\": true,\n    \"Deleted\": false,\n    \"AccountType\": 1\n  },\n  {\n    \"Id\": 10,\n    \"FullName\": \"User, VendorContact\",\n    \"Username\": \"vendorcontactuser\",\n    \"Active\": true,\n    \"Deleted\": false,\n    \"AccountType\": 2,\n    \"Vendor\": {\n      \"Id\": 5,\n      \"DisplayName\": \"Vendor\"\n    }\n  },\n  {\n    \"Id\": 11,\n    \"FullName\": \"User, API\",\n    \"Username\": \"APIuser\",\n    \"Active\": true,\n    \"Deleted\": false,\n    \"AccountType\": 1\n  },\n  {\n    \"Id\": 12,\n    \"FullName\": \"User, Test2\",\n    \"Username\": \"test2user\",\n    \"Active\": true,\n    \"Deleted\": false,\n    \"AccountType\": 1\n  }\n]\n```\n\n```response:400\n{\n  \"Message\":\"Invalid \\\"Account Type\\\" filter.\",\n  \"StackTrace\":null}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid \\\"Active\\\" filter.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"pageIndex\": \"0\",\n  \"pageSize\": \"100\",\n  \"filters\": [\n    {\n      \"Field\": {\n        \"ShortName\": \"Active\"\n      },\n      \"FilterType\": \"5\",\n      \"Value\": \"false\"\n    }\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999825,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_7cbcc1bcaa1d4dc5a0408b0690957521","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1651256152785,"created":1644023569358,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/GetUserCount","name":"Get User Count","description":"Returns an integer representing the count of all Full Users, Vendors Contact Users, and Awareness Users in the application. Using the optional FieldFilter you can return records for only certain user types, such as Active, Deleted, or users by a particular AccountType or Vendor Contacts by a certain Vendor Profile.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to Administer - Users\n* Vendor Contact accounts must also have:\n    * General Access - Read permissions to Vendor Profiles\n    * View permissions to Vendor Profiles workflow stage\n    * Vendor Profiles record permissions\n\t\t\n* Input:\n    * FieldFilter (optional): The filter parameters the users must meet to be included.\n\n|FieldFilter (ShortName)|FilterType|Value|\n|:--|:--|:--|\n|Active|5 (Equal To)|True, False|\n||6 (NotEqualTo)||\n|Deleted|5 (Equal To)|True, False|\n||6 (NotEqualTo)||\n|AccountType|5 (Equal To)|1 (Full User), 2 (Vendor Contact), 4 (Awareness User)|\n||6 (NotEqualTo)||\n||10002 (Contains Any)||\n|Vendor|5 (Equal To)|Vendor Profile ID for the Vendor Contact|\n```response:200\n42\n```\n\n```response:400\n{\n  \"Message\":\"Invalid \\\"Account Type\\\" filter.\",\n  \"StackTrace\":null}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid \\\"Active\\\" filter.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"[\n  {\n    \"Field\": {\n      \"ShortName\": \"AccountType\"\n    },\n    \"FilterType\": \"5\",\n    \"Value\": \"1\"\n  }\n]"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999818.75,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_9c36ca5a47574bbca38f339149a1480c","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1651256153167,"created":1644028407903,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/CreateUser","name":"Create User","description":"Creates a user account.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Create and Read permissions to Administer - Users\n* Vendor Contact accounts must also have:\n    * General Access - Create, Read, and Update permissions to Vendor Profiles\n    * View and Edit permissions to Vendor Profiles workflow stage\n    * Vendor Profiles record permissions\n\n* Input: Language (integer)\n    * The preferred language of the user is stored in the user profile\n\t\n|Language ID|Language Name|Language ID|Language Name|Language ID|Language Name|\n|:--|:--|:--|:--|:--|:--|\n|Afrikaans|54|Hindi|57|Quechua|107|\n|Albanian|28|Hungarian|14|Romanian|24|\n|Alsatian|132|Icelandic|15|Romansh|23|\n|Amharic|94|Igbo|112|Russian|25|\n|Arabic|1|Indonesian|33|Sakha|133|\n|Armenian|43|Inuktitut|93|Sami (Northern)|59|\n|Assamese|77|Irish|60|Sanskrit|79|\n|Azerbaijani|44|Italian|16|Scottish Gaelic|145|\n|Bangla|69|Japanese|17|Serbian|31770|\n|Bashkir|109|K'iche|134|Sesotho sa Leboa|108|\n|Basque|45|Kannada|75|Setswana|50|\n|Belarusian|35|Kazakh|63|Sinhala|91|\n|Bosnian|30746|Khmer|83|Slovak|27|\n|Breton|126|Kinyarwanda|135|Slovenian|36|\n|Bulgarian|2|Kiswahili|65|Spanish (Mexico)|2058|\n|Catalan|3|Konkani|87|Spanish (Spain)|3082|\n|Chinese|30724|Korean|18|Swedish|29|\n|Corsican|131|Kyrgyz|64|Syriac|90|\n|Croatian|26|Lao|84|Tajik|40|\n|Czech|5|Latvian|38|Tamazight|95|\n|Danish|6|Lithuanian|39|Tamil|73|\n|Dari|140|Luxembourgish|110|Tatar|68|\n|Divehi|101|Macedonian (FYROM)|47|Telugu|74|\n|Dutch|19|Malayalam|76|Thai|30|\n|English (United Kingdom)|2057|Malay|62|Tibetan|81|\n|English (United States)|1033|Maltese|58|Turkish|31|\n|Estonian|37|Maori|129|Turkmen|66|\n|Faroese|56|Mapudungun|122|Ukrainian|34|\n|Filipino|100|Marathi|78|Upper Sorbian|46|\n|Finnish|11|Mohawk|124|Urdu|32|\n|French|12|Mongolian|80|Uyghur|128|\n|Frisian|98|Nepali|97|Uzbek|67|\n|Galician|86|Norwegian|20|Vietnamese|42|\n|Georgian|55|Occitan|130|Welsh|82|\n|German|7|Odia|72|Wolof|136|\n|Greek|8|Pashto|99|Yi|120|\n|Greenlandic|111|Persian|41|Yoruba|106|\n|Gujarati|71|Polish|21|isiXhosa|52|\n|Hausa|104|Portuguese|22|isiZulu|53|\n|Hebrew|13|Punjabi|70||||\n\n* Input: Required user fields.\n    * AccountType\n    * EmailAddress\n    * FirstName\n    * LastName\n    * Password\n    * SecurityConfiguration\n    * SecurityRoles\n    * Username\n\n* Input: Optional user fields.\n    * Active\n    * APIAccess\n    * Department\n    * Fax\n    * FunctionalRoles\n    * Groups\n    * HomePhone\n    * IsLDAP\n        * LDAPDirectory\n    * IsSAML\n    * Locked\n    * Language\n    * Manager\n\t\t* MiddleName\n    * MobilePhone\n    * Title\n    * WorkPhone\n\n```response:200\n{\n  \"Id\": 10,\n  \"FullName\": \"User, Test\",\n  \"Username\": \"testuser\",\n  \"Active\": true,\n  \"Locked\": false,\n  \"Deleted\": false,\n  \"AccountType\": 1,\n  \"FirstName\": \"Test\",\n  \"MiddleName\": \"\",\n  \"LastName\": \"User\",\n  \"Title\": \"\",\n  \"Language\": 1033,\n  \"EmailAddress\": \"test@user.com\",\n  \"HomePhone\": \"\",\n  \"WorkPhone\": \"\",\n  \"MobilePhone\": \"\",\n  \"Fax\": \"\",\n  \"Manager\": {\n    \"Id\": 6,\n    \"FullName\": \"Manager\"\n  },\n  \"Department\": {\n    \"Id\": 10,\n    \"Name\": \"Anonymous Incident Analysts\"\n  },\n  \"IsSAML\": false,\n  \"IsLDAP\": true,\n  \"LDAPDirectory\": {\n    \"Id\": 1,\n    \"DisplayName\": \"QE Domain\"\n  },\n  \"SecurityConfiguration\": {\n    \"Id\": 1,\n    \"DisplayName\": \"Administrator Configuration\"\n  },\n  \"APIAccess\": false,\n  \"Groups\": [\n    {\n      \"Id\": 2,\n      \"Name\": \"Exception Analysts\"\n    }\n  ],\n  \"SecurityRoles\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Administration\"\n    }\n  ],\n  \"FunctionalRoles\": [\n    {\n      \"Id\": 9,\n      \"DisplayName\": \"Product Analysis and Design\"\n    }\n  ]\n}\n```\n\n```response:400\n{\n\t\"Message\": \"Invalid Language ID.\",\n\t\"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"Username\": \"test\",\n  \"Password\": \"password\",\n  \"Active\": true,\n  \"Locked\": false,\n  \"AccountType\": 1,\n  \"FirstName\": \"Test\",\n  \"MiddleName\": \"\",\n  \"LastName\": \"User\",\n  \"Title\": \"\",\n  \"Language\": 1033,\n  \"EmailAddress\": \"test@user.com\",\n  \"HomePhone\": \"\",\n  \"WorkPhone\": \"\",\n  \"MobilePhone\": \"\",\n  \"Fax\": \"\",\n  \"IsSAML\": false,\n  \"IsLDAP\": true,\n  \"LDAPDirectory\": {\n    \"Id\": \"1\"\n  },\n  \"Manager\": {\n    \"Id\": \"6\"\n  },\n  \"Department\": {\n    \"Id\": \"10\"\n  },\n  \"SecurityConfiguration\": {\n    \"Id\": \"1\"\n  },\n  \"APIAccess\": false,\n  \"Groups\": [\n    {\n      \"Id\": \"2\"\n    }\n  ],\n  \"SecurityRoles\": [\n    {\n      \"Id\": \"1\"\n    }\n  ],\n  \"FunctionalRoles\": [\n    {\n      \"Id\": \"9\"\n    }\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999812.5,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_5269ad47810f45d9928987e29b421b54","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1651256153548,"created":1644450699893,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/UpdateUser","name":"Update User","description":"Updates a user account.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read and Update permissions to Administer - Users\n* Vendor Contact accounts must also have:\n    * General Access - Read and Update permissions to Vendor Profiles\n    * View and Edit permissions to Vendor Profiles workflow stage\n    * Vendor Profiles record permissions\n\t\t\n* Input: CommitNullProperties (boolean) (optional): Clears all non-required field values.\n\nBy default, the setting is false. Use the GetUser call to retrieve current values of the User object and provide  UpdateUser the same User object in the request, minus whatever fields you intend to clear. The CommitNullProperties tag must be placed at the end of the User object.\n\n* Input: Language (integer)\n    * The preferred language of the user is stored in the user profile\n\t\n|Language ID|Language Name|Language ID|Language Name|Language ID|Language Name|\n|:--|:--|:--|:--|:--|:--|\n|Afrikaans|54|Hindi|57|Quechua|107|\n|Albanian|28|Hungarian|14|Romanian|24|\n|Alsatian|132|Icelandic|15|Romansh|23|\n|Amharic|94|Igbo|112|Russian|25|\n|Arabic|1|Indonesian|33|Sakha|133|\n|Armenian|43|Inuktitut|93|Sami (Northern)|59|\n|Assamese|77|Irish|60|Sanskrit|79|\n|Azerbaijani|44|Italian|16|Scottish Gaelic|145|\n|Bangla|69|Japanese|17|Serbian|31770|\n|Bashkir|109|K'iche|134|Sesotho sa Leboa|108|\n|Basque|45|Kannada|75|Setswana|50|\n|Belarusian|35|Kazakh|63|Sinhala|91|\n|Bosnian|30746|Khmer|83|Slovak|27|\n|Breton|126|Kinyarwanda|135|Slovenian|36|\n|Bulgarian|2|Kiswahili|65|Spanish (Mexico)|2058|\n|Catalan|3|Konkani|87|Spanish (Spain)|3082|\n|Chinese|30724|Korean|18|Swedish|29|\n|Corsican|131|Kyrgyz|64|Syriac|90|\n|Croatian|26|Lao|84|Tajik|40|\n|Czech|5|Latvian|38|Tamazight|95|\n|Danish|6|Lithuanian|39|Tamil|73|\n|Dari|140|Luxembourgish|110|Tatar|68|\n|Divehi|101|Macedonian (FYROM)|47|Telugu|74|\n|Dutch|19|Malayalam|76|Thai|30|\n|English (United Kingdom)|2057|Malay|62|Tibetan|81|\n|English (United States)|1033|Maltese|58|Turkish|31|\n|Estonian|37|Maori|129|Turkmen|66|\n|Faroese|56|Mapudungun|122|Ukrainian|34|\n|Filipino|100|Marathi|78|Upper Sorbian|46|\n|Finnish|11|Mohawk|124|Urdu|32|\n|French|12|Mongolian|80|Uyghur|128|\n|Frisian|98|Nepali|97|Uzbek|67|\n|Galician|86|Norwegian|20|Vietnamese|42|\n|Georgian|55|Occitan|130|Welsh|82|\n|German|7|Odia|72|Wolof|136|\n|Greek|8|Pashto|99|Yi|120|\n|Greenlandic|111|Persian|41|Yoruba|106|\n|Gujarati|71|Polish|21|isiXhosa|52|\n|Hausa|104|Portuguese|22|isiZulu|53|\n|Hebrew|13|Punjabi|70||||\n\n* Input: Required user fields.\n    * Id\n\n* Input: Optional user fields.\n    * AccountType\n    * Active\n    * APIAccess\n    * Department\n    * EmailAddress\n    * Fax\n    * FirstName\n    * FunctionalRoles\n    * Groups\n    * HomePhone\n    * IsLDAP\n        * LDAPDirectory\n    * IsSAML\n    * Language\n    * LastName\n    * Locked\n    * Manager\n    * MiddleName\n    * MobilePhone\n    * Password\n    * SecurityConfiguration\n    * SecurityRoles\n    * Title\n    * Username\n    * WorkPhone\n    * CommitNullProperties\n\n```response:200\n{\n  \"Id\": 10,\n  \"FullName\": \"User, Test\",\n  \"Username\": \"testuser\",\n  \"Active\": true,\n  \"Locked\": false,\n  \"Deleted\": false,\n  \"AccountType\": 1,\n  \"FirstName\": \"Test\",\n  \"MiddleName\": \"\",\n  \"LastName\": \"User\",\n  \"Title\": \"\",\n  \"Language\": 1033,\n  \"EmailAddress\": \"test@user.com\",\n  \"HomePhone\": \"\",\n  \"WorkPhone\": \"\",\n  \"MobilePhone\": \"\",\n  \"Fax\": \"\",\n  \"Manager\": {\n    \"Id\": 6,\n    \"FullName\": \"Manager\"\n  },\n  \"Department\": {\n    \"Id\": 10,\n    \"Name\": \"Anonymous Incident Analysts\"\n  },\n  \"IsSAML\": false,\n  \"IsLDAP\": true,\n  \"LDAPDirectory\": {\n    \"Id\": 1,\n    \"DisplayName\": \"QE Domain\"\n  },\n  \"SecurityConfiguration\": {\n    \"Id\": 1,\n    \"DisplayName\": \"Administrator Configuration\"\n  },\n  \"APIAccess\": false,\n  \"Groups\": [\n    {\n      \"Id\": 2,\n      \"Name\": \"Exception Analysts\"\n    }\n  ],\n  \"SecurityRoles\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Administration\"\n    }\n  ],\n  \"FunctionalRoles\": [\n    {\n      \"Id\": 9,\n      \"DisplayName\": \"Product Analysis and Design\"\n    }\n  ]\n}\n```\n\n```response:400\n{\n\t\"Message\": \"Invalid Language ID.\",\n\t\"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n\t\"Id\": \"6\",\n\t\"Groups\": [\n\t\t{\n\t\t\t\"Id\": 13,\n\t\t\t\"Name\": \"Lockpath Support\"\n\t\t}\n\t],\n\t\"SecurityRoles\": [],\n\t\"CommitNullProperties\": \"true\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999809.375,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_c03450240f4347f7850d517cbbd73ab3","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1659126087128,"created":1644369588802,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/DeleteUser","name":"Delete User","description":"Deletes a user account.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read and Delete permissions to Administer - Users\n* Vendor Contact accounts must also have:\n    * General Access - Read and Delete permissions to Vendor Profiles\n\t\t* View permissions to Vendor Profiles workflow stage\n\t\t* Vendor Profiles record permissions\n\n* Input:\n    * Id (integer): The Id of the user account.\n\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"DELETE","body":{"mimeType":"application/json","text":"10"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999806.25,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_75bd6d9f4d534464bf13ea2ccce0d276","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1646369374985,"created":1644023989362,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/GetGroup","name":"Get Group","description":"Returns all supporting fields for a given group.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to Administer - Groups\n\n```response:200\n{\n  \"Id\": 2,\n  \"Name\": \"Anonymous Incident Analysts\",\n  \"Description\": \"\",\n  \"BusinessUnit\": false,\n  \"SecurityRoles\": [],\n  \"Users\": [\n    {\n      \"Id\": 6,\n      \"FullName\": \"Admin, Lockpath\"\n    },\n    {\n      \"Id\": 27,\n      \"FullName\": \"User, Test\"\n    }\n  ],\n  \"ChildGroups\": [],\n  \"ParentGroups\": []\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"Id","value":"41","description":"The Id of the given group. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999787.5,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_57d33ae80c9b408995302f9a0cf65a3d","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1646369343851,"created":1644026030290,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/GetGroups","name":"Get Groups","description":"Returns the ID and Name for groups. You can filter the list to return only the groups meeting selected criteria.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to Administer - Groups\n\t\t\n* Input:\n    * pageIndex (integer): The index of the page of result to return. Must be ≥ 0.\n    * pageSize (integer): The size of the page results to return. Must be ≥ 1.\n    * FieldFilter: The filter parameters the groups must meet to be included.\n\n|FieldFilter (ShortName)|FilterType|Value|\n|:--|:--|:--|\n|BusinessUnit|5 (Equal To)|True, False|\n||6 (NotEqualTo)|&nbsp;|\n\n```response:200\n[\n  {\n    \"Id\": 10,\n    \"Name\": \"Anonymous Incident Analysts\"\n  },\n  {\n    \"Id\": 6,\n    \"Name\": \"Business Continuity Plan Approvers\"\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Cannot filter records with one or more of the provided field aliases.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"pageIndex\": \"0\",\n  \"pageSize\": \"100\",\n  \"filters\": [\n    {\n      \"Field\": {\n        \"ShortName\": \"BusinessUnit\"\n      },\n      \"FilterType\": \"5\",\n      \"Value\": \"False\"\n    }\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999775,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_54e7f8a914294212abdac63ec9bf881a","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1644964950576,"created":1644519084976,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/CreateGroup","name":"Create Group","description":"Creates a group.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Create and Read permissions to Administer - Groups\n\n* Input: Required group fields.\n    * Name\n\n* Input: Optional group fields.\n    * Description\n    * BusinessUnit\n    * SecurityRoles\n    * Users\n    * ChildGroups\n    * ParentGroups\n\n```response:200\n{\n  \"Id\": 22,\n  \"Name\": \"Government\",\n  \"Description\": \"Government Group\",\n  \"BusinessUnit\": false,\n  \"SecurityRoles\": [],\n  \"Users\": [\n    {\n      \"Id\": 1027,\n      \"FullName\": \"User, Test\"\n    }\n  ],\n  \"ChildGroups\": [],\n  \"ParentGroups\": []\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"Description\": \"Government Group\",\n  \"BusinessUnit\": false,\n  \"SecurityRoles\": \"\",\n  \"Users\": [\n    {\n      \"Id\": 1027\n    }\n  ],\n  \"ChildGroups\": \"\",\n  \"ParentGroups\": \"\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999750,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_eac0aa0d33864de5b6f2abb799f95302","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1646772858598,"created":1644519611561,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/UpdateGroup","name":"Update Group","description":"Creates a group.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read and Update permissions to Administer - Groups\n\n* Input: Required group fields.\n    * Id\n\n* Input: Optional group fields.\n    * Name\n    * Description\n    * BusinessUnit\n    * SecurityRoles\n    * Users\n    * ChildGroups\n    * ParentGroups\n\n```response:200\n{\n  \"Id\": 2,\n  \"Name\": \"API Group\",\n  \"Description\": \"Another API update.\",\n  \"BusinessUnit\": false,\n  \"SecurityRoles\": [],\n  \"Users\": [\n    {\n      \"Id\": 6,\n      \"FullName\": \"Support, Lockpath\"\n    },\n    {\n      \"Id\": 10,\n      \"FullName\": \"User, Test\"\n    }\n  ],\n  \"ChildGroups\": [\n    {\n      \"Id\": 5,\n      \"Name\": \"Policy Incident Analysts\"\n    },\n    {\n      \"Id\": 6,\n      \"Name\": \"Business Continuity Plan Authors\"\n    }\n  ],\n  \"ParentGroups\": [\n    {\n      \"Id\": 3,\n      \"Name\": \"Information Security Incident Analysts\"\n    },\n    {\n      \"Id\": 4,\n      \"Name\": \"Physical Security Incident Analysts\"\n    }\n  ]\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"Id\": 2,\n  \"Name\": \"API Group\",\n  \"Description\": \"Another API update.\",\n  \"BusinessUnit\": false,\n  \"Users\": [\n    {\n      \"Id\": 6\n    },\n    {\n      \"Id\": 14\n    }\n  ],\n  \"ChildGroups\": [\n\t\t{\n\t\t\t\"Id\": 5\n\t\t},\n\t\t{\n\t\t\t\"Id\": 6\n\t\t}\n\t],\n\t\"ParentGroups\": [\n    {\n      \"Id\": 3\n    },\n    {\n      \"Id\": 4\n    }\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999737.5,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_29f412af3c5e49d98d1647a5de368e01","parentId":"fld_ab75d63158be4f209d68cebe4c66b839","modified":1659126092815,"created":1644370021673,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/SecurityService/DeleteGroup","name":"Delete Group","description":"Deletes a group.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read and Delete permissions to Administer - Gropus\n\n* Input:\n    * Id (integer): The Id of the group.\n\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"DELETE","body":{"mimeType":"application/json","text":"10"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999725,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_e37660c9ff994b989050e61fc95c69bb","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644547072816,"created":1639620861029,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetComponent","name":"Get Component","description":"Retrieves a component specified by its ID. A component is a user-defined data object such as a custom content table. The component ID may be found by using GetComponentList.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to the selected component\n\n```response:200\n{\n  \"Id\": 10021,\n  \"Name\": \"Incident Reports\",\n  \"SystemName\": \"IncidentReports\",\n  \"ShortName\": \"IncidentReports\"\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"Id","value":"10021","description":"The Id of the desired component. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-1000000000,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1639624502726,"created":1639624480984,"name":"Component Services","description":"The Component Services include the available methods for retrieving, updating, and deleting data from the Integrated Risk Management Platform.","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1639624480984,"_type":"request_group"},{"_id":"req_15a5459d09bf4756bbe483381e1e7a21","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644554025389,"created":1644520397315,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetComponentList","name":"Get Component List","description":"Returns a complete list of all components available to the user based on account permissions. No input elements are used. The list will be ordered in ascending alphabetical order of the component name.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to the selected components\n\n```response:200\n[\n  {\n    \"Id\": \"10003\",\n    \"Name\": \"Device Types\",\n    \"SystemName\": \"DeviceTypes\",\n    \"ShortName\": \"DeviceTypes\"\n  },\n  {\n    \"Id\": \"10001\",\n    \"Name\": \"Devices\",\n    \"SystemName\": \"Devices\",\n    \"ShortName\": \"Devices\"\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999975,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_f5d37617d5b748d4957ce8b598ecffeb","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1649184028240,"created":1644532311335,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetComponentByAlias","name":"Get Component By Alias","description":"Retrieves a component specified by its Alias. A component is a user-defined data object such as a custom content table. The component Alias may be found by using GetComponentList.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to the specific component\n\n```response:200\n{\n  \"Id\": 10021,\n  \"Name\": \"Incident Reports\",\n  \"SystemName\": \"IncidentReports\",\n  \"ShortName\": \"IncidentReports\"\n}\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"Alias","value":"_JiraProjects","description":"The alias (shortname) of the component. (string)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999925,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_d7def8f760d94413b9ad01d91279826a","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644547119796,"created":1644536343403,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetFieldList","name":"Get Field List","description":"Retrieves a detailed field list for a component specified by its ID. The component ID may be found by using GetComponentList. Assessments field type are not visible in this list.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to the selected component\n    * View field permissions. Fields to which the account does not have access are not returned.\n\n```response:200\n[\n  {\n    \"Id\": 9,\n    \"Name\": \"Acquisition Cost\",\n    \"SystemName\": \"Cost\",\n    \"ShortName\": \"Cost\",\n    \"ReadOnly\": false,\n    \"Required\": false,\n    \"FieldType\": 2,\n    \"Precision\": 15,\n    \"Scale\": 2,\n    \"OneToMany\": false,\n    \"MatrixRows\": []\n  },\n  {\n    \"Id\": 10,\n    \"Name\": \"Acquisition Date\",\n    \"SystemName\": \"AcquisitionDate\",\n    \"ShortName\": \"AcquisitionDate\",\n    \"ReadOnly\": false,\n    \"Required\": false,\n    \"FieldType\": 3,\n    \"OneToMany\": false,\n    \"MatrixRows\": []\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"componentId","value":"10001","description":"The Id of the desired component. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_ac69a933c79d49cc9164f3de3ff38e4b","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644554061389,"created":1644536633686,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetField","name":"Get Field","description":"Retrieves details for a field within a component. The field ID may be found by using GetFieldList.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to the component and field\n\n```response:200\n{\n  \"Id\": 23,\n  \"Name\": \"Device Type\",\n  \"SystemName\": \"DeviceType\",\n  \"ShortName\": \"DeviceType\",\n  \"ReadOnly\": false,\n  \"Required\": false,\n  \"FieldType\": 5,\n  \"OneToMany\": false,\n  \"MatrixRows\": []\n}\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"Id","value":"23","description":"The field Id for the individual field within the component. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999862.5,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_b5f3906b2d1e439b866c0ef1cec6f883","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644555631799,"created":1644554426838,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetAvailableLookupRecords","name":"Get Available Lookup Records","description":"Retrieves records that are available for population for a lookup field.\n\nThe lookupFieldId corresponds to a lookup field with a report definition on it and the fieldPathId corresponds to the field path to retrieve fields from, which is obtained from GetDetailRecord. GetLookupReportColumnFields compliments GetDetailRecord by adding additional details about the lookup report columns returned from GetDetailRecord.\n\n* Permissions: The authentication account must have:\n    * General Access - Create and Read access to the component that contains the lookup field if no recordId is supplied \n    * General Access - Read permissions to:\n        * the recordId\n        * any lookup records\n    * General Access - Read and Update permissions to:\n        * the component that contains the lookup field if a recordId is supplied\n        * the lookup field\n\n* Input:\n    * fieldId (integer): The ID of the desired component.\n    * pageIndex (integer): The index of the page of result to return. Must be ≥ 0.\n    * pageSize (integer): The size of the page results to return. Must be ≥ 1.\n    * recordId (integer) (optional): The ID of the record for which retrieving lookup records.\n\n```response:200\n[\n  {\n    \"Id\": 2,\n    \"DisplayName\": \"Mobile Device\",\n    \"FieldValues\": []\n  },\n  {\n    \"Id\": 4,\n    \"DisplayName\": \"Laptop\",\n    \"FieldValues\": []\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Failed to retrieve original record.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"fieldId\": \"23\",\n  \"pageIndex\": \"0\",\n  \"pageSize\": \"2\",\n  \"recordId\": \"111111\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_18634c9e1c4f4445adcc5a9744f19aba"}],"authentication":{},"metaSortKey":-999999859.375,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_46635adcb315498ba32c258d68a625b9","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1647974222569,"created":1644536995805,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetRecord","name":"Get Record","description":"Returns the set of fields for a given record for which you have permissions within a component. The field keys can be matched with the data from the GetField method to obtain the name of the field.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n```response:200\n{\n  \"Id\": \"1\",\n  \"DisplayName\": \"Test Record\",\n  \"FieldValues\": [\n    {\n      \"Key\": 3,\n      \"Value\": \"2021-05-04T21:51:15.8294916\"\n    },\n    {\n      \"Key\": 7555,\n      \"Value\": {\n        \"Id\": 29,\n        \"DisplayName\": \"Business Unit\",\n        \"FieldValues\": []\n      }\n    }\n  ]\n}\n```\n\n```response:400\n{\n  \"Message\": \"Failed to return original record.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"componentId","value":"10415","description":"The Id of the desired component. (integer)"},{"id":"pair_1c6ba2d4a1c346f3bf38b5122fa1793c","name":"recordId","value":"35","description":"The Id for the individual record within the component. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999856.25,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_78bda22198494888952d8eb09d411172","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1647974490062,"created":1644554852797,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetRecords","name":"Get Records","description":"Returns an array of records within a chosen component. You can use filters to return only the records meeting selected criteria\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n* Input:\n    * componentId (integer): The Id of the desired component.\n    * pageIndex (integer): The index of the page of result to return. Must be ≥ 0.\n    * pageSize (integer): The size of the page results to return. Must be ≥ 1.\n\t\t* filters (various) (optional): The filter parameters the records must meet to be counted.\n\nA variety of filters are available, and an unlimited number of search criteria may be applied to each transaction that supports filtering. Search filters are composed of a field path, filter type, and a value.\n\n**FieldPath**\n\nDescribes the field ID for the column that the records will be filtered on. If the value is stored in the component directly, only one Field Path variable is needed. However, if the value is a lookup to another component, an additional Field Path variable will be required with the column value where the data resides. Field Path variables can be added as many as necessary to provide the correct path to the data.\n\n**Fitler Types**\n\nDescribes the ID for the filter being applied. For example, the FilterType for **Is Null** is 15. If the FilterType would exclude the entry of a value like **Is Empty** (13), **Is Not Empty** (14), **Is Null** (15), or **Is Not Null** (16), the &lt;Value> tags should be removed from the request.\n\n|ID|Option|\n|:--|:--|\n|1|Contains|\n|2|Excludes|\n|3|Starts With|\n|4|Ends With|\n|5|=|\n|6|&lt;>|\n|7|>|\n|8|&lt;|\n|9|≥|\n|10|≤|\n|11|Between|\n|12|Not Between|\n|13|Is Empty|\n|14|Is Not Empty|\n|15|Is Null|\n|16|Is Not Null|\n|10001|Offset|\n|10002|Contains Any (applies only to One-to-Many Lookup fields)|\n|10003|Contains Only (applies only to One-to-Many Lookup fields)|\n|10004|Contains None (applies only to One-to-Many Lookup fields)|\n|10005|Contains At Least (applies only to One-to-Many Lookup fields)|\n\n**Value**\n\t\nDescribes the comparison that the column will be measured again. FilterType 1 applies only to one-to-many lookup fields. For the FilterType 11 and 12, two values are required that are delimited by a pipe (|) symbol. For the FilterTypes 13 - 16 no values are required.\n\n**SearchCriteriaItem**\n\t\nDescribes a single filter. By combining FieldPath, Filter, and Value, a complete search filter is created for the desired parameters.\n\n```response:200\n[\n  {\n    \"Id\": 1,\n    \"DisplayName\": \"192.168.1.84\",\n    \"FieldValues\": []\n  },\n  {\n    \"Id\": 2,\n    \"DisplayName\": \"192.168.1.69\",\n    \"FieldValues\": []\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n \"Message\": \"The given key was not present in the dictionary.\",\n \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n\t\"Message\": \"Property 'System.String IPAddress_sort' is not defined for type 'LockPath.Keylight.MetaRuntime._cambia＿sandbox＿keylightgrc＿com._SteFindings'\",\n\t\"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"10415\",\n  \"pageIndex\": \"0\",\n  \"pageSize\": \"2\",\n  \"filters\": [\n    {\n      \"FieldPath\": [\n        10256\n      ],\n      \"FilterType\": \"16\",\n      \"Value\": \"\"\n    }\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999854.6875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_45bf9c3adc864440a35920f628f60406","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644558781993,"created":1644555377472,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetRecordCount","name":"Get Record Count","description":"Returns the number of records in a given component. You can use filters to return the count of records meeting selected criteria.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n* Input:\n    * componentId (integer): The Id of the desired component.\n\nA variety of filters are available, and an unlimited number of search criteria may be applied to each transaction that supports filtering. Search filters are composed of a field path, filter type, and a value.\n\n**FieldPath**\n\nDescribes the field ID for the column that the records will be filtered on. If the value is stored in the component directly, only one Field Path variable is needed. However, if the value is a lookup to another component, an additional Field Path variable will be required with the column value where the data resides. Field Path variables can be added as many as necessary to provide the correct path to the data.\n\n**Fitler Types**\n\nDescribes the ID for the filter being applied. For example, the FilterType for **Is Null** is 15. If the FilterType would exclude the entry of a value like **Is Empty** (13), **Is Not Empty** (14), **Is Null** (15), or **Is Not Null** (16), the &lt;Value> tags should be removed from the request.\n\n|ID|Option|\n|:--|:--|\n|1|Contains|\n|2|Excludes|\n|3|Starts With|\n|4|Ends With|\n|5|=|\n|6|&lt;>|\n|7|>|\n|8|&lt;|\n|9|≥|\n|10|≤|\n|11|Between|\n|12|Not Between|\n|13|Is Empty|\n|14|Is Not Empty|\n|15|Is Null|\n|16|Is Not Null|\n|10001|Offset|\n|10002|Contains Any (applies only to One-to-Many Lookup fields)|\n|10003|Contains Only (applies only to One-to-Many Lookup fields)|\n|10004|Contains None (applies only to One-to-Many Lookup fields)|\n|10005|Contains At Least (applies only to One-to-Many Lookup fields)|\n\n**Value**\n\t\nDescribes the comparison that the column will be measured again. FilterType 1 applies only to one-to-many lookup fields. For the FilterType 11 and 12, two values are required that are delimited by a pipe (|) symbol. For the FilterTypes 13 - 16 no values are required.\n\n**SearchCriteriaItem**\n\t\nDescribes a single filter. By combining FieldPath, Filter, and Value, a complete search filter is created for the desired parameters.\n\n```response:200\n42\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n \"Message\": \"The given key was not present in the dictionary.\",\n \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"10001\",\n  \"filters\": [\n    {\n      \"FieldPath\": [\n        11\n      ],\n      \"FilterType\": 16,\n      \"Value\": \"\"\n    }\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999853.90625,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_6a397c7ac3f3409c88db094c70457827","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1649798291184,"created":1644538312354,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetDetailRecord","name":"Get Record Detail","description":"Retrieves record information based on the provided component ID and record ID, with lookup field report details. Using the optional boolean parameter \"embedRichTextImages\" you can return records with images contained in rich text fields.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n```response:200\n{\n  \"Id\": \"1\",\n  \"DisplayName\": \"Test Record\",\n  \"FieldValues\": [\n    {\n      \"Key\": 3,\n      \"Value\": \"2021-05-04T21:51:15.8294916\"\n    },\n    {\n      \"Key\": 7555,\n      \"Value\": {\n        \"Id\": 29,\n        \"DisplayName\": \"Business Unit\",\n        \"FieldValues\": [],\n        \"LookupReportColumns\": [\n          {\n            \"FieldPathId\": 2671,\n            \"ColumnName\": \"Name\",\n            \"Value\": \"Business Unit\"\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n```response:400\n{\n  \"Message\": \"Failed to return original record.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"componentId","value":"25","description":"The Id of the desired component. (integer)"},{"id":"pair_1c6ba2d4a1c346f3bf38b5122fa1793c","name":"recordId","value":"1","description":"The Id for the individual record within the component. (integer)"},{"id":"pair_85ca8c14925948bc8efea1b39fb8b2cd","name":"embedRichTextImages","value":"true","description":"Include images contained in rich text fields. (boolean) (optional)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999853.125,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_fbc270cabfab47c2b85481c4616c0804","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1645741796441,"created":1644542528759,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetDetailRecords","name":"Get Records Detail","description":"Retrieves details for each record specified. GetDetailRecords also allows multiple sorts to modify the order of the results. The maximum number of records returned (pageSize) is 1000.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n* Input:\n    * componentId (integer): The Id of the desired component.\n    * pageIndex (integer): The index of the page of result to return. Must be ≥ 0.\n    * pageSize (integer): The size of the page results to return. Must be ≥ 1.\n    * filters (various): The filter parameters the records must meet to be included. A variety of filters are available, and an unlimited number of search criteria may be applied to each transaction that supports filtering. Search filters are composed of a field path, filter type, and a value.\n    * sortOrder (various) (optional): The sort parameters the records must meet to be included in the sort order.\n    * fieldIds (integer) (optional): The Id of the field to be returned. If not provided, returns all accessible fields. If provided, but empty, returns core system fields (CreatedAt, CreatedBy, etc.). If provided, returns core system fields plus accessible fields. Note that system fields will always be returned regardless.\n\n**FieldPath**\n\nDescribes the field ID for the column that the records will be filtered on. If the value is stored in the component directly, only one Field Path variable is needed. However, if the value is a lookup to another component, an additional Field Path variable will be required with the column value where the data resides. Field Path variables can be added as many as necessary to provide the correct path to the data.\n\n**Fitler Types**\n\nDescribes the ID for the filter being applied. For example, the FilterType for **Is Null** is 15. If the FilterType would exclude the entry of a value like **Is Empty** (13), **Is Not Empty** (14), **Is Null** (15), or **Is Not Null** (16), the &lt;Value> tags should be removed from the request.\n\n|ID|Option|\n|:--|:--|\n|1|Contains|\n|2|Excludes|\n|3|Starts With|\n|4|Ends With|\n|5|=|\n|6|&lt;>|\n|7|>|\n|8|&lt;|\n|9|≥|\n|10|≤|\n|11|Between|\n|12|Not Between|\n|13|Is Empty|\n|14|Is Not Empty|\n|15|Is Null|\n|16|Is Not Null|\n|10001|Offset|\n|10002|Contains Any (applies only to One-to-Many Lookup fields)|\n|10003|Contains Only (applies only to One-to-Many Lookup fields)|\n|10004|Contains None (applies only to One-to-Many Lookup fields)|\n|10005|Contains At Least (applies only to One-to-Many Lookup fields)|\n\n**Value**\n\t\nDescribes the comparison that the column will be measured again. FilterType 1 applies only to one-to-many lookup fields. For the FilterType 11 and 12, two values are required that are delimited by a pipe (|) symbol. For the FilterTypes 13 - 16 no values are required.\n\n**SearchCriteriaItem**\n\t\nDescribes a single filter. By combining FieldPath, Filter, and Value, a complete search filter is created for the desired parameters.\n\n```response:200\n[\n  {\n    \"Id\": 374,\n    \"DisplayName\": \"374\",\n    \"FieldValues\": [\n      {\n        \"Key\": 7439,\n        \"Value\": 374\n      },\n      {\n        \"Key\": 7440,\n        \"Value\": 3\n      },\n      {\n        \"Key\": 7442,\n        \"Value\": {\n          \"Id\": 12,\n          \"DisplayName\": \"Name, User\",\n          \"FieldValues\": []\n        }\n      },\n      {\n        \"Key\": 7445,\n        \"Value\": {\n          \"Id\": 12,\n          \"DisplayName\": \"Name, User\",\n          \"FieldValues\": []\n        }\n      },\n      {\n        \"Key\": 7448,\n        \"Value\": false\n      },\n      {\n        \"Key\": 7449,\n        \"Value\": {\n          \"Id\": 301,\n          \"DisplayName\": \"Published\",\n          \"FieldValues\": []\n        }\n      },\n      {\n        \"Key\": 7451,\n        \"Value\": 3\n      },\n      {\n        \"Key\": 7454,\n        \"Value\": \"Cable\"\n      },\n      {\n        \"Key\": 7455,\n        \"Value\": \"Printer\"\n      }\n    ]\n  },\n  {\n    \"Id\": 375,\n    \"DisplayName\": \"375\",\n    \"FieldValues\": [\n      {\n        \"Key\": 7439,\n        \"Value\": 375\n      },\n      {\n        \"Key\": 7440,\n        \"Value\": 1\n      },\n      {\n        \"Key\": 7442,\n        \"Value\": {\n          \"Id\": 12,\n          \"DisplayName\": \"Name, User\",\n          \"FieldValues\": []\n        }\n      },\n      {\n        \"Key\": 7445,\n        \"Value\": {\n          \"Id\": 12,\n          \"DisplayName\": \"Name, User\",\n          \"FieldValues\": []\n        }\n      },\n      {\n        \"Key\": 7448,\n        \"Value\": false\n      },\n      {\n        \"Key\": 7449,\n        \"Value\": {\n          \"Id\": 301,\n          \"DisplayName\": \"Published\",\n          \"FieldValues\": []\n        }\n      },\n      {\n        \"Key\": 7451,\n        \"Value\": 1\n      },\n      {\n        \"Key\": 7454,\n        \"Value\": \"Keyboard\"\n      },\n      {\n        \"Key\": 7455,\n        \"Value\": \"Printer\"\n      }\n    ]\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Value cannot be null.\\r\\nParameter name: source\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"10013\",\n  \"pageIndex\": \"0\",\n  \"pageSize\": \"10\",\n  \"filters\": [\n    {\n      \"FieldPath\": [\n        594\n      ],\n      \"FilterType\": 16\n    }\n  ],\n  \"sortOrder\": [\n    {\n      \"FieldPath\": [\n        594\n      ],\n      \"Ascending\": false\n    }\n  ],\n  \"fieldIds\": [\n    601,\n    628,\n    609\n  ]\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d7fd08996f3a485584d7c1fb323014df"}],"authentication":{},"metaSortKey":-999999852.34375,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_1725784edf0a44fdbb36ce0bb6ed429e","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1659125796413,"created":1644540734963,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetLookupReportColumnFields","name":"Get Lookup Report Columns Field","description":"Retrieves the field information of each field in a field path that corresponds to a lookup report column.\n\nThe lookupFieldId corresponds to a lookup field with a report definition on it and the fieldPathId corresponds to the field path to retrieve fields from, which is obtained from GetDetailRecord. GetLookupReportColumnFields compliments GetDetailRecord by adding additional details about the lookup report columns returned from GetDetailRecord.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n```response:200\n[\n  {\n    \"Id\": 3,\n    \"ComponentId\": 10001,\n    \"Name\": \"Workflow Stage\",\n    \"SystemName\": \"WorkflowStage\"\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Failed to retrieve fields.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"lookupFieldId","value":"610","description":"The id of the desired lookup field. (integer)"},{"id":"pair_1c6ba2d4a1c346f3bf38b5122fa1793c","name":"fieldPathId","value":"131","description":"The Id for the desired lookup field path. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999851.5625,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_9e9c0c9decc5411da619c0cec898833d","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644547214194,"created":1644539036540,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetRecordAttachment","name":"Get Record Attachment","description":"Retrieves a single attachment for a given field on a record. The record ID and field ID may be found by using GetDetailRecord.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n```response:200\n{\n\"FileName\": \"Attachment.txt\",\n\"FileData\": \"QW4gYXR0YWNobWVudCBmb3IgdGVzdGluZyBwdXJwb3Nlcw==\"\n}\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"componentId","value":"10013","description":"The Id of the desired component. (integer)"},{"id":"pair_1c6ba2d4a1c346f3bf38b5122fa1793c","name":"recordId","value":"17","description":"The Id for the individual record within the component. (integer)"},{"id":"pair_d02820422ae6470abcd31d590ec4adcc","name":"fieldId","value":"618","description":"The Id for the individual field within the component. (integer)"},{"id":"pair_10d428dc85c5465990732fdfd4047014","name":"documentId","value":"4367","description":"The Id for the individual document within the component. (integer)","disabled":false}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999803.125,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_8628e2bb642940d1a699db874e8ea14f","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644547229267,"created":1644539535238,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetRecordAttachments","name":"Get Record Attachments","description":"Retrieves a list of information for all attachments associated with the provided component ID, record ID, and field\nID. No file data is returned, only file name, field ID, and document ID information.\n\n* Permissions: The authentication account must have:\n    * General Access - Read permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n```response:200\n[\n  {\n    \"FileName\": \"AttachmentTest1.txt\",\n    \"FieldId\": 34,\n    \"DocumentId\": 55\n  },\n  {\n    \"FileName\": \"AttachmentTest2.txt\",\n    \"FieldId\": 34,\n    \"DocumentId\": 56\n  }\n]\n```\n\n```response:200\n[]\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"componentId","value":"10013","description":"The Id of the desired component. (integer)"},{"id":"pair_1c6ba2d4a1c346f3bf38b5122fa1793c","name":"recordId","value":"17","description":"The Id for the individual record within the component. (integer)"},{"id":"pair_d02820422ae6470abcd31d590ec4adcc","name":"fieldId","value":"618","description":"The Id for the individual field within the component. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999801.171875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_779d9d0f70924ab28785b6c066bad496","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1647974128875,"created":1644540180342,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetWorkflow","name":"Get Workflow","description":"Retrieves workflow details and all workflow stages specified by ID. The ID for a workflow may be found by using GetWorkflows.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to the selected component\n\n```response:200\n{\n  \"Id\": 10,\n  \"Name\": \"Default\",\n  \"IsActive\": true,\n  \"IsDefault\": true,\n  \"RoutingCriteria\": [],\n  \"WorkflowOwnerGroups\": [],\n  \"WorkflowOwnerUsers\": [],\n  \"WorkflowStages\": [\n    {\n      \"Id\": 15,\n      \"Name\": \"Published\",\n      \"Description\": \"\",\n      \"IsInitial\": true,\n      \"IsActive\": true,\n      \"IsVoting\": false,\n      \"GroupAccess\": [\n        {\n          \"Group\": {\n            \"Id\": 0,\n            \"Name\": \"Everyone\"\n          },\n          \"CanViewAll\": true,\n          \"CanEdit\": true,\n          \"CanTransition\": false\n        }\n      ],\n      \"UserAccess\": [],\n      \"UseAssignments\": false,\n      \"Transitions\": [],\n      \"CanAutoApprove\": false\n    }\n  ]\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"Id","value":"212","description":"The Id of the desired workflow. (integer)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999799.21875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_c957b93625d24fac88b1909133dd967b","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1647974114394,"created":1644540360101,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/GetWorkflows","name":"Get Workflows","description":"Retrieves all workflows for a component specified by its Alias. A component is a user-defined data object such as a custom content table. The component Alias may be found by using GetComponentList.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read permissions to the selected component\n\n```response:200\n[\n  {\n    \"Id\": 2,\n    \"Name\": \"Default\",\n    \"IsActive\": true,\n    \"IsDefault\": true\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_921b5b18eb6b4f4dbf6e6531f54b6cd3","name":"componentalias","value":"_stefindings","description":"The Alias of the desired component. (string)"}],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"}],"authentication":{},"metaSortKey":-999999793.359375,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_0d1ad8d7620e455b96f83fceb12d3146","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644564227866,"created":1644555649378,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/TransitionRecord","name":" Transition Record","description":"Transitions a record in a workflow stage. The transitionId may be found by using GetWorkflow.\n\n* Permissions: The authentication account must have:\n    * General Access - Read and Update permissions to the defined table.\n    * View and Transition workflow stage permissions.\n    * Record permission\n\n* Input:\n    * tableAlias (string): The Alias for the table.\n    * recordId (integer): The Id of the record to be transitioned.\n    * transitionId (integer): The Id of the workflow stage transition.\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"tableAlias\": \"Exceptions\",\n  \"recordId\": \"17\",\n  \"transitionId\": \"42\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999743.359375,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_43cf3187d6f94772a37f0749a55f0c73","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644564225463,"created":1644557741326,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/VoteRecord","name":"Vote Record","description":"Casts a vote for a record in a workflow stage. The transition ID may be found by using GetWorkflow.\n\n* Permissions: The authentication account must have:\n    * General Access - Read and Update permissions to the defined table.\n    * View and Vote workflow stage permissions.\n    * Record permission\n\n* Input:\n    * tableAlias (string): The Alias for the table.\n    * recordId (integer): The Id of the record to be transitioned.\n    * transitionId (integer): The Id of the workflow stage transition.\n    * votingComments (string) (optional): A comment regarding the vote.\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"tableAlias\": \"_STE\",\n  \"recordId\": \"1\",\n  \"transitionId\": \"242\",\n  \"votingComments\": \"API Approved\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999740.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_9d7f9a55bdb94b508698f70b1237f9d3","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1649794177897,"created":1644558462318,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/CreateRecord","name":"Create Record","description":"Creates a new record within the specified component of the application.\n\n**NOTE:** The Required option for a field is only enforced through the user interface, not through the API. Therefore, CreateRecord does not enforce the Required option for fields. The response will include the complete set of fields for the specified record.\n\n* Permissions: The authentication account must have:\n    * General Access - Create permissions to the selected component\n    * Edit permission to any field into which data is to be entered\n\n* Input:\n    * componentId (integer): The ID of the desired component.\n    * dynamicRecord (FieldValues - KeyValuePair): Fields for the component to be created.\n\n**Dynamic Record**\n\nA dynamic record is defined by key-value pairs that contain a field ID (where the data will be entered) and a value that contains the type of the data and the data itself.\n\nApplicable types are string, decimal, boolean, dateTime, and DynamicRecordItem. For example, the XML syntax for the types is shown below.\n\n**Empty Fields**\n\nIf a field is not included in the input for CreateRecord, the field remains empty/null for the created record.\nTo create empty/null data for a field that is defined in the input is to use: \"value i:nil=\"true\"\n\n**Matrix**\n\nMatrix records can only be created after the parent record is created. The Matrix componentId can be retrieved with GetComponentList and the Matrix column fields can be retrieved with GetFieldList, using the Matrix componentId. Matrix row ID’s must be retrieved from the table in the database.\n\n**Master/Detail**\n\nMaster/Detail records can only be created after the parent record has been created. The Master/Detail componentId can be retrieved with GetComponentList and the master/detail subfields can be retrieved with GetFieldList, using the Master/Detail componentId.\n\n**Workflow Stage ID**\n\nWorkflow contains a Workflow Stage field ID and the Workflow Stage ID.\n\n**System Fields**\n\nThe platform populates system fields when a user enters values for their custom created fields. The response contains values for these system fields.\n\n|Field|Value Source|\n|:--|:--|\n|CreatedAt|TimeStamp record created|\n|CreatedBy|User Id (API logon)|\n|Id|Unique record identifier|\n|CurrentRevision|Tracks revision history starting at 0|\n|UpdatedAt|TimeStamp record updated|\n|UpdatedBy|User Id (API logon)|\n|Workflow Stage|Workflow stage for record|\n\n\n\n\n\n```response:200\n{\n  \"Id\": 2043,\n  \"DisplayName\": \"2043\",\n  \"FieldValues\": [\n    {\n      \"Key\": 3,\n      \"Value\": \"API Example DNS Name\"\n    },\n    {\n      \"Key\": 4,\n      \"Value\": null\n    },\n    {\n      \"Key\": 6,\n      \"Value\": null\n    },\n    {\n      \"Key\": 7,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8,\n      \"Value\": null\n    },\n    {\n      \"Key\": 9,\n      \"Value\": 250.0\n    },\n    {\n      \"Key\": 10,\n      \"Value\": \"2020-12-25T00:00:00\"\n    },\n    {\n      \"Key\": 11,\n      \"Value\": \"127.0.0.1\"\n    },\n    {\n      \"Key\": 12,\n      \"Value\": null\n    },\n    {\n      \"Key\": 13,\n      \"Value\": null\n    },\n    {\n      \"Key\": 14,\n      \"Value\": null\n    },\n    {\n      \"Key\": 15,\n      \"Value\": null\n    },\n    {\n      \"Key\": 16,\n      \"Value\": null\n    },\n    {\n      \"Key\": 23,\n      \"Value\": null\n    },\n    {\n      \"Key\": 24,\n      \"Value\": null\n    },\n    {\n      \"Key\": 28,\n      \"Value\": []\n    },\n    {\n      \"Key\": 30,\n      \"Value\": []\n    },\n    {\n      \"Key\": 32,\n      \"Value\": null\n    },\n    {\n      \"Key\": 33,\n      \"Value\": null\n    },\n    {\n      \"Key\": 34,\n      \"Value\": []\n    },\n    {\n      \"Key\": 35,\n      \"Value\": []\n    },\n    {\n      \"Key\": 294,\n      \"Value\": []\n    },\n    {\n      \"Key\": 300,\n      \"Value\": 2043\n    },\n    {\n      \"Key\": 301,\n      \"Value\": \"2022-02-11T05:58:40.87431Z\"\n    },\n    {\n      \"Key\": 302,\n      \"Value\": \"2022-02-11T05:58:40.87431Z\"\n    },\n    {\n      \"Key\": 303,\n      \"Value\": {\n        \"Id\": 14,\n        \"DisplayName\": \"API, Lockpath\",\n        \"FieldValues\": []\n      }\n    },\n    {\n      \"Key\": 305,\n      \"Value\": {\n        \"Id\": 14,\n        \"DisplayName\": \"API, Lockpath\",\n        \"FieldValues\": []\n      }\n    },\n    {\n      \"Key\": 342,\n      \"Value\": []\n    },\n    {\n      \"Key\": 351,\n      \"Value\": {\n        \"Id\": 5,\n        \"DisplayName\": \"Published\",\n        \"FieldValues\": []\n      }\n    },\n    {\n      \"Key\": 617,\n      \"Value\": []\n    },\n    {\n      \"Key\": 713,\n      \"Value\": []\n    },\n    {\n      \"Key\": 748,\n      \"Value\": 1\n    },\n    {\n      \"Key\": 823,\n      \"Value\": null\n    },\n    {\n      \"Key\": 859,\n      \"Value\": []\n    },\n    {\n      \"Key\": 933,\n      \"Value\": []\n    },\n    {\n      \"Key\": 1614,\n      \"Value\": null\n    },\n    {\n      \"Key\": 1676,\n      \"Value\": []\n    },\n    {\n      \"Key\": 1718,\n      \"Value\": []\n    },\n    {\n      \"Key\": 2266,\n      \"Value\": null\n    },\n    {\n      \"Key\": 2267,\n      \"Value\": null\n    },\n    {\n      \"Key\": 2335,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3042,\n      \"Value\": null\n    },\n    {\n      \"Key\": 3611,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3639,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3690,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3836,\n      \"Value\": null\n    },\n    {\n      \"Key\": 5320,\n      \"Value\": null\n    },\n    {\n      \"Key\": 7980,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8282,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8294,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8295,\n      \"Value\": null\n    },\n    {\n      \"Key\": 10231,\n      \"Value\": []\n    },\n    {\n      \"Key\": 11222,\n      \"Value\": []\n    }\n  ]\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"10001\",\n  \"dynamicRecord\": {\n    \"FieldValues\": [\n      {\n        \"key\": \"3\",\n        \"value\": \"API Example DNS Name\"\n      },\n      {\n        \"key\": \"9\",\n        \"value\": 250.0\n      },\n      {\n        \"key\": \"10\",\n        \"value\": \"12/25/2020\"\n      },\n      {\n        \"key\": \"11\",\n        \"value\": \"127.0.0.1\"\n      }\n    ]\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999690.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_236a9b07d838469c80a41529786115d3","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1649798125223,"created":1644559167029,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/UpdateRecord","name":"Update Record","description":"Updates a record within the specified component of the application.\n\n**NOTE:** The Required option for a field is only enforced through the user interface, not through the API. Therefore, UpdateRecord does not enforce the Required option for fields. The response will include the complete set of fields for the specified record.\n\n* Permissions: The authentication account must have:\n    * General Access - Read and Update permissions to the selected component\n    * Edit permission to any field into which data is to be entered\n    * Read permission to the selected record\n\n* Input:\n    * componentId (integer): The ID of the desired component.\n    * dynamicRecord (FieldValues - KeyValuePair): Fields for the component to be created.\n\n**Dynamic Record**\n\nA dynamic record is defined by key-value pairs that contain a field ID (where the data will be entered) and a value that contains the type of the data and the data itself.\n\nApplicable types are string, decimal, boolean, dateTime, and DynamicRecordItem. For example, the XML syntax for the types is shown below.\n\n**Empty Fields**\n\nIf a field is not included in the input for CreateRecord, the field remains empty/null for the created record.\nTo create empty/null data for a field that is defined in the input is to use: \"value i:nil=\"true\"\n\n**Matrix**\n\nMatrix records can only be created after the parent record is created. The Matrix componentId can be retrieved with GetComponentList and the Matrix column fields can be retrieved with GetFieldList, using the Matrix componentId. Matrix row ID’s must be retrieved from the table in the database.\n\n**Master/Detail**\n\nMaster/Detail records can only be created after the parent record has been created. The Master/Detail componentId can be retrieved with GetComponentList and the master/detail subfields can be retrieved with GetFieldList, using the Master/Detail componentId.\n\n**Workflow Stage ID**\n\nWorkflow contains a Workflow Stage field ID and the Workflow Stage ID.\n\n**System Fields**\n\nThe platform populates system fields when a user enters values for their custom created fields. The response contains values for these system fields.\n\n|Field|Value Source|\n|:--|:--|\n|CreatedAt|TimeStamp record created|\n|CreatedBy|User Id (API logon)|\n|Id|Unique record identifier|\n|CurrentRevision|Tracks revision history starting at 0|\n|UpdatedAt|TimeStamp record updated|\n|UpdatedBy|User Id (API logon)|\n|Workflow Stage|Workflow stage for record|\n\n```response:200\n{\n  \"Id\": 2043,\n  \"DisplayName\": \"2043\",\n  \"FieldValues\": [\n    {\n      \"Key\": 3,\n      \"Value\": \"API Example DNS Name\"\n    },\n    {\n      \"Key\": 4,\n      \"Value\": null\n    },\n    {\n      \"Key\": 6,\n      \"Value\": \"Asset: IT Department\"\n    },\n    {\n      \"Key\": 7,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8,\n      \"Value\": null\n    },\n    {\n      \"Key\": 9,\n      \"Value\": 250.0\n    },\n    {\n      \"Key\": 10,\n      \"Value\": \"2020-12-25T00:00:00\"\n    },\n    {\n      \"Key\": 11,\n      \"Value\": \"127.0.0.1\"\n    },\n    {\n      \"Key\": 12,\n      \"Value\": null\n    },\n    {\n      \"Key\": 13,\n      \"Value\": null\n    },\n    {\n      \"Key\": 14,\n      \"Value\": null\n    },\n    {\n      \"Key\": 15,\n      \"Value\": null\n    },\n    {\n      \"Key\": 16,\n      \"Value\": null\n    },\n    {\n      \"Key\": 23,\n      \"Value\": null\n    },\n    {\n      \"Key\": 24,\n      \"Value\": null\n    },\n    {\n      \"Key\": 28,\n      \"Value\": []\n    },\n    {\n      \"Key\": 30,\n      \"Value\": []\n    },\n    {\n      \"Key\": 32,\n      \"Value\": null\n    },\n    {\n      \"Key\": 33,\n      \"Value\": null\n    },\n    {\n      \"Key\": 34,\n      \"Value\": []\n    },\n    {\n      \"Key\": 35,\n      \"Value\": []\n    },\n    {\n      \"Key\": 294,\n      \"Value\": []\n    },\n    {\n      \"Key\": 300,\n      \"Value\": 2043\n    },\n    {\n      \"Key\": 301,\n      \"Value\": \"2022-02-11T05:58:40.87431Z\"\n    },\n    {\n      \"Key\": 302,\n      \"Value\": \"2022-02-11T05:58:40.87431Z\"\n    },\n    {\n      \"Key\": 303,\n      \"Value\": {\n        \"Id\": 14,\n        \"DisplayName\": \"API, Lockpath\",\n        \"FieldValues\": []\n      }\n    },\n    {\n      \"Key\": 305,\n      \"Value\": {\n        \"Id\": 14,\n        \"DisplayName\": \"API, Lockpath\",\n        \"FieldValues\": []\n      }\n    },\n    {\n      \"Key\": 342,\n      \"Value\": []\n    },\n    {\n      \"Key\": 351,\n      \"Value\": {\n        \"Id\": 5,\n        \"DisplayName\": \"Published\",\n        \"FieldValues\": []\n      }\n    },\n    {\n      \"Key\": 617,\n      \"Value\": []\n    },\n    {\n      \"Key\": 713,\n      \"Value\": []\n    },\n    {\n      \"Key\": 748,\n      \"Value\": 1\n    },\n    {\n      \"Key\": 823,\n      \"Value\": null\n    },\n    {\n      \"Key\": 859,\n      \"Value\": []\n    },\n    {\n      \"Key\": 933,\n      \"Value\": []\n    },\n    {\n      \"Key\": 1614,\n      \"Value\": null\n    },\n    {\n      \"Key\": 1676,\n      \"Value\": []\n    },\n    {\n      \"Key\": 1718,\n      \"Value\": []\n    },\n    {\n      \"Key\": 2266,\n      \"Value\": null\n    },\n    {\n      \"Key\": 2267,\n      \"Value\": null\n    },\n    {\n      \"Key\": 2335,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3042,\n      \"Value\": null\n    },\n    {\n      \"Key\": 3611,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3639,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3690,\n      \"Value\": []\n    },\n    {\n      \"Key\": 3836,\n      \"Value\": null\n    },\n    {\n      \"Key\": 5320,\n      \"Value\": null\n    },\n    {\n      \"Key\": 7980,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8282,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8294,\n      \"Value\": null\n    },\n    {\n      \"Key\": 8295,\n      \"Value\": null\n    },\n    {\n      \"Key\": 10231,\n      \"Value\": []\n    },\n    {\n      \"Key\": 11222,\n      \"Value\": []\n    }\n  ]\n}\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n\t\"Message\": \"The given key was not present in the dictionary.\",\n\t\"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"10001\",\n  \"dynamicRecord\": {\n    \"Id\": \"2043\",\n    \"FieldValues\": [\n      {\n        \"key\": \"6\",\n        \"value\": \"Asset: IT Department\"\n      }\n    ]\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999640.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_2d9b4775d7b5466fa635c5929eaac551","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1659125821222,"created":1644561783076,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/UpdateRecordAttachments","name":"Update Record Attachments","description":"Adds new attachments and/or updates existing attachments to the provided documents field(s) on a specific record, where the FileData is represented as a Base64 string. The maximum data size of the request is controlled by the maxAllowedContentLength and maxReceivedMessageSize values in the API web.config file.\n\n***NOTE:*** Adding an attachment to a record increments the record version. Adding an attachment with the same file name as an existing attachment will overwrite the existing file attachment.\n\n* Permissions: The authentication account must have:\n    * General Access - Read and Update permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n* Input:\n    * componentId (integer): The ID of the desired component.\n    * recordId (integer): The Id for the individual record within the component.\n    * fieldId (integer): The Id for the individual field within the component.\n\n```response:200\n[\n  {\n    \"OperationSucceeded\": true,\n    \"Message\": \"Attachment was successfully added to the Documents field.\",\n    \"ComponentId\": 10001,\n    \"RecordId\": 2,\n    \"AttachmentInfo\": {\n      \"FileName\": \"AttachmentTest1.txt\",\n      \"FieldId\": 34,\n      \"DocumentId\": 4368\n    }\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Error occurred processing AttachmentTest1.txt. The input is not a valid Base-64 string as it contains a non-base 64 character, more than two padding characters, or an illegal character among the padding characters. \",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Failed to retrieve original record.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": 10001,\n  \"dynamicRecord\": {\n    \"Id\": 4,\n    \"FieldValues\": [\n      {\n        \"key\": 34,\n        \"value\": [\n          {\n            \"FileName\": \"AttachmentTest1.txt\",\n            \"FileData\": \"SGVsbG8gV29ybGQ=\"\n          }\n        ]\n      }\n    ]\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999615.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_e514d9196a48427eb43840aa17083f87","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1659126096681,"created":1644561072510,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/DeleteRecord","name":"Delete Record","description":"Deletes a user account.\n\n* Permissions: The authentication account must have:\n    * Administrative Access - Read and Delete permissions to the selected component\n    * Read permissions to the selected record\n\n* Input:\n    * componentId (integer): The Id of the desired component.\n    * recordId (integer): The Id for the individual record within the component.\n\n```response:200\ntrue\n```\n\n```response:200\nfalse\n```\n\n```response:400\n{\n  \"Message\": \"Object reference not set to an instance of an object.\",\n  \"StackTrace\": null\n}\n```","method":"DELETE","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"100011\",\n  \"recordId\": \"1\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_d9812594a9014685a862951cb15f37f5"}],"authentication":{},"metaSortKey":-999999590.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_640ae0fdcd66498c94903809a7ecee34","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644565503451,"created":1644562452324,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/DeleteRecordAttachments","name":"Delete Record Attachments","description":"Deletes the specified attachments from the provided document fields on a specific record.\n\n***NOTE:*** Deleting an attachment to a record increments the record version ***even if the attachment is not present***.\n\n* Permissions: The authentication account must have:\n    * General Access - Read and Delete permissions to:\n        * Selected component\n        * Selected record\n        * Applicable fields in the component (table)\n\n* Input:\n    * componentId (integer): The ID of the desired component.\n    * recordId (integer): The Id for the individual record within the component.\n    * fieldId (integer): The Id for the individual field within the component.\n    * attachmentId (integer): The Id for the individual attachment within the component.\n\n```response:200\n[\n  {\n    \"OperationSucceeded\": true,\n    \"Message\": \"Attachment was successfully deleted from the Documents field.\",\n    \"ComponentId\": 10001,\n    \"RecordId\": 2,\n    \"AttachmentInfo\": {\n      \"FileName\": \"Attachment.txt\",\n      \"FieldId\": 34,\n      \"DocumentId\": 1\n    }\n  }\n]\n```\n\n```response:200\n[\n  {\n    \"OperationSucceeded\": false,\n    \"Message\": \"Invalid document ID provided, attachment was not deleted.\",\n    \"ComponentId\": 10001,\n    \"RecordId\": 2,\n    \"AttachmentInfo\": {\n      \"FileName\": \"\",\n      \"FieldId\": 34,\n      \"DocumentId\": 4368\n    }\n  }\n]\n```\n\n```response:400\n{\n  \"Message\": \"Failed to retrieve original record.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"The given key was not present in the dictionary.\",\n  \"StackTrace\": null\n}\n```\n\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"componentId\": \"10001\",\n  \"dynamicRecord\": {\n    \"Id\": \"5\",\n    \"FieldValues\": [\n      {\n        \"key\": \"314\",\n        \"value\": [\n          {\n            \"Id\": \"1\"\n          }\n        ]\n      }\n    ]\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999540.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_243a8e2eca4b4eebb4c2ac10ae43dd01","parentId":"fld_dd5f1a4f0dff4d508fed55d34e42fb02","modified":1644566946230,"created":1644562825618,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ComponentService/ImportFile","name":"Import File","description":"Queues a job to import a file for a defined import template.\n\n* Permissions: The authentication account must have:\n    * General Access - Read, Create, Update, and Import/Bulk permissions to the defined table.\n    * To enable the Run As System option the authentication account must have also have Administrative Access - Read, Create, and Update permissions to the defined table\n\n* Input:\n    * tableAlias (string): The Alias for the table to import into.\n    * importTemplateName (string): The Name of the import template.\n    * fileName (string): The Name of the import file.\n    * fileData (string): Base64 encoded string of file contents.\n    * runAsSystem (boolean): Run import as the System account rather than authentication account.\t\t\t\t\n\n```response:200\ntrue\n```\n\n```response:400\n{\n  \"Message\": \"Error occurred processing AttachmentTest1.txt. The input is not a valid Base-64 string as it contains a non-base 64 character, more than two padding characters, or an illegal character among the padding characters. \",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"tableAlias\": \"_ERMActivities\",\n  \"importTemplateName\": \"import\",\n  \"fileName\": \"import_temp.csv\",\n  \"fileData\": \"SGVsbG8gV29ybGQ=\",\n  \"runAsSystem\": \"false\"\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_5353aec91dac4ffeb85a79e4dbbae7d1"},{"name":"Content-Type","value":"application/json","id":"pair_74d6aa2d67e94d49ac7dc4ad9ee7cabc"}],"authentication":{},"metaSortKey":-999999490.4296875,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_7915bef1280542009417a1fc5d880dec","parentId":"fld_75572a11cff6427993d19dc41acdf6bf","modified":1659125447619,"created":1639525241336,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/AssessmentService/IssueAssessment","name":"Issue Immediate Assessment","description":"A one-time assessment issued to a user today.\n\n* Permissions: The authentication account must have General Access - Create, Read and Update permissions to:\n    * Applicable component\n    * Applicable records\n    * Applicable fields in the component (table)\n* The user account must have \"Accessible to\" permissions to:\n    * Applicable assessment category\n\n```response:200\n{\n  \"AssessmentIssuanceItem\": {\n    \"ProjectId\": 16,\n    \"TableId\": \"\",\n    \"FieldId\": \"\",\n    \"ContentId\": \"\",\n    \"VendorId\": \"\",\n    \"IsVendorInternalMode\": \"\",\n    \"Name\": \"Assessment Issued Today\",\n    \"TemplateId\": 21,\n    \"UserIds\": 1027,\n    \"VendorContactId\": \"\",\n    \"GroupIds\": \"\",\n    \"AllowDelegation\": false,\n    \"AssignedUserOnly\": \"\",\n    \"ReviewerId\": \"\",\n    \"GenerateFindings\": false,\n    \"FindingsOutputTableId\": \"\",\n    \"FindingsOutputFieldId\": \"\",\n    \"FindingsParentGroupingFieldId\": \"\",\n    \"FindingsControlsFieldId\": \"\",\n    \"ShowUserScores\": false,\n    \"IssuanceScheduleType\": \"immediate\",\n    \"BeginningDate\": \"\",\n    \"IssueDate\": \"\",\n    \"DueDate\": \"3/12/2021\",\n    \"EndingDate\": \"\",\n    \"RepeatUnit\": \"\",\n    \"RepeatInterval\": \"\",\n    \"RepeatsSunday\": \"\",\n    \"RepeatsMonday\": \"\",\n    \"RepeatsTuesday\": \"\",\n    \"RepeatsWednesday\": \"\",\n    \"RepeatsThursday\": \"\",\n    \"RepeatsFriday\": \"\",\n    \"RepeatsSaturday\": \"\",\n    \"DueUnit\": \"\",\n    \"DueInterval\": \"\",\n    \"PrepopulatePriorAnswers\": false,\n    \"EmailSubject\": \"Immediate Assessment\",\n    \"EmailBody\": \"Immediate Assessment\",\n    \"SendReviewerOrIssuerEmail\": \"\",\n    \"SendCategoryEmail\": \"\",\n    \"AdministrativeEmailSubject\": \"\",\n    \"AdministrativeEmailBody\": \"\",\n    \"ScheduledAssessmentId\": 165\n  }\n}\n```\n\n```response:400\n{\n  \"Message\":\"Insufficient information supplied in assessment issuance XML.\",\n  \"StackTrace\":null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"IssueAssessment\": {\n    \"assessmentIssuance\": {\n      \"ProjectId\": 16,\n      \"Name\": \"Assessment Issues Today\",\n      \"TemplateId\": 21,\n      \"UserIds\": 1027,\n      \"GroupIds\": \"\",\n      \"AllowDelegation\": false,\n      \"GenerateFindings\": false,\n      \"AssignedUserOnly\": false,\n      \"ShowUserScores\": false,\n      \"IssuanceScheduleType\": \"immediate\",\n      \"DueDate\": \"3/12/2021\",\n      \"PrepopulatePriorAnswers\": false,\n      \"EmailSubject\": \"Immediate Assessment\",\n      \"EmailBody\": \"Immediate Assessment\"\n    }\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_2a2cc695c67c414e9f110987cc4df1d6"},{"name":"Content-Type","value":"application/json","description":"","id":"pair_9be16585b0bc4fbfafd625b28c4aaf5b"}],"authentication":{},"metaSortKey":-1559308248629.8125,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_75572a11cff6427993d19dc41acdf6bf","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1644024498986,"created":1639525241335,"name":"Assessment Services","description":"The Assessment Services include the available methods for initiating assessments into fields on DCF tables and records in the Integrated Risk Management Platform.\n\nAssessments can be issued according to a specified schedule. Assessments can be issued directly to a vendor or you can issue an assessment internally to a Lockpath user to perform assessments of a vendor without the assessment being viewable by external vendor contacts that have access to the Lockpath Vendor Portal.\n\n**Sechedule Types**\n\n|Schedule Type|Description|\n|:--|:--|\n|Immediate|A one-time assessment issued today.|\n|Onetime|A one-time assessment issued at a future date.|\n|Recurring|An assessment that repeats how often you want it to be issued according to a schedule.|\n\n**Parameters**\n\n|Parameter|Additional parameters|Description|\n|:--|:--|:--|\n|ProjectId||Specifies the id of the project defined in Compliance Manager associated with the assessment. When an assessment is issued from a DCF table or master/detail record this parameter is not required.|\n|TableId||Specifies the id of the table to which the assessment is associated. For master/detail record assessments, TableId is the master field ID.|\n|FieldId||Specifies the id of the field to which the assessment is associated. For master/detail record assessments, FieldId is the assessment field ID of the master/detail table.|\n|ContentId||Specifies the id of the record of the table to which the assessment is associated. For master/detail record assessments, ContentId is the specific record within the master/detail table.|\n|VendorId||Specifies the id of the vendor for the issuance. When an assessment is issued to a vendor this parameter is required.|\n|IsVendorInternalMode||Although this parameter exists, it has no content.|\n|Name||Specifies the name identifying the assessment.|\n|TemplateId||Specifies the id of the template containing the questions for the assessment.|\n|VendorContactId||Specifies the id of the vendor contact. When an assessment is issued to a vendor this parameter is required.|\n|UsersIds||Specifies the id of the user to which you want to issue the assessment. Use a comma to separate the ids of multiple users.|\n|GroupIds||Specifies the id of the group to which you want to issue the assessment. Use a comma to separate the ids of multiple groups.|\n|AssignedUserOnly||Determines whether a review or multiple reviewers are required. When this parameter is set to True, optional parameters are required.|\n||ReviewerId|Specifies the id of the user designated to review the assessment once it has been submitted. Use a comma to separate the ids of multiple reviewers.|\n|AllowDelegation||Determines whether to allow the assessment to be delegated.|\n|GenerateFindings||Determines whether to automatically generate findings.|\n||FindingsOutputTableId|Specifies the table (ComponentId) into which you want the record automatically generated for the question specified in the applicable assessment template. This parameter appears when GenerateFindings is set to True.|\n||FindingsOutputFieldId|Specifies the field (FieldId) into which you want the record automatically generated for the question specified in the applicable assessment template. This parameter appears when GenerateFindings is set to True.|\n||FindingsParentGroupingFieldId|Specifies the field (FieldId) into which the findings are grouped together and recorded in one single table record. This parameter appears when GenerateFindings is set to True.|\n||FindingsControlsFieldId|Specifies the field (FieldId) into which the controls that are mapped to the assessment question are automatically populated. This parameter appears when GenerateFindings is set to True.|\n|ShowUserScores||Determines whether user scores are written to a record. This parameter is only applicable if the assessment template has score-based enabled.|\n|IssuanceScheduleType||Specifies whether to issue the assessment immediately, onetime, or on a recurring basis.|\n||IssueDate|Specifies the issuance date of the assessment. The default is today’s date. This parameter appears when IssuanceScheduleType is set to onetime.|\n||DueDate|Specifies the due date of the issuance. The date may not precede the issuance date. This parameter appears when IssuanceScheduleType is set to onetime.|\n||BeginningDate|Specifies the date when the assessment is initially issued. This parameter appears when IssuanceScheduleType is set to recurring.|\n||EndingDate|Specifies the date when the issuing of the assessment is to stop. This parameter appears when IssuanceScheduleType is set to recurring.|\n||RepeatInterval|Specifies whether the issuance repeats Daily, Weekly, Monthly, or Annually. This parameter appears when IssuanceScheduleType is set to recurring.|\n||RepeatUnit|Specifies the number of times the assessment is repeated. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Daily, Monthly, or Annually.|\n||RepeatsSunday|Determines whether the issuance repeats on Sunday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||RepeatsMonday|Determines whether the issuance repeats on Monday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||RepeatsTuesday|Determines whether the issuance repeats on Tuesday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||RepeatsWednesday|Determines whether the issuance repeats on Wednesday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||RepeatsThursday|Determines whether the issuance repeats on Thursday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||RepeatsFriday|Determines whether the issuance repeats on Friday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||RepeatsSaturday|Determines whether the issuance repeats on Saturday. This parameter appears when IssuanceScheduleType is set to recurring and is required when RepeatInterval is set to Weekly.|\n||DueUnit|Specifies the number of days, weeks, months, or years until the assessment is due. This parameter appears when IssuanceScheduleType is set to recurring.|\n||DueInterval|Determines whether the due date interval is days, weeks, months, or years. This parameter appears when IssuanceScheduleType is set to recurring.|\n|PrepopulatePriorAnswers||Determines whether the questions specified in the applicable assessment template are populated with the answers submitted previously.|\n|EmailSubject||Specifies the text in the subject of the email that is sent notifying the issuer of the assessment.|\n|EmailBody||Specifies the text in the body of the email that is sent notifying the issuer of the assessment.|\n|SendCategoryEmail||Determines whether email is sent to the assessment category owner.|\n|SendReviewersOrIssueEmail||Determines whether email is sent to reviewers.|\n||AdministrativeEmailSubject|Specifies the text in the subject of the email that is sent to the user designated to review the assessment. This parameter appears when SendReviewersOrIssueEmail is set to True.|\n||AdministrativeEmailBody|Specifies the text in the body of the email that is sent to the user designated to review the assessment. This parameter appears when SendReviewersOrIssueEmail is set to True.|\n|ScheduledAssessmentId||Specifies the Id of the assessment itself and is found at the end of the response object.|","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1639624403460,"_type":"request_group"},{"_id":"req_739a285d9f7443c294877a2c9976d42c","parentId":"fld_75572a11cff6427993d19dc41acdf6bf","modified":1659125444070,"created":1643966842741,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/AssessmentService/IssueAssessment","name":"Issue Onetime Scheduled Assessment","description":"A one-time assessment issued to a user at a future date.\n\n* Permissions: The authentication account must have General Access - Create, Read and Update permissions to:\n    * Applicable component\n    * Applicable records\n    * Applicable fields in the component (table)\n* The user account must have \"Accessible to\" permissions to:\n    * Applicable assessment category\n\n```response:200\n{\n  \"AssessmentIssuanceItem\": {\n    \"ProjectId\": 16,\n    \"TableId\": \"\",\n    \"FieldId\": \"\",\n    \"ContentId\": \"\",\n    \"VendorId\": \"\",\n    \"IsVendorInternalMode\": \"\",\n    \"Name\": \"Onetime Scheduled Assessment\",\n    \"TemplateId\": 21,\n    \"UserIds\": 1027,\n    \"VendorContactId\": \"\",\n    \"GroupIds\": \"\",\n    \"AllowDelegation\": false,\n    \"AssignedUserOnly\": \"\",\n    \"ReviewerId\": \"\",\n    \"GenerateFindings\": false,\n    \"FindingsOutputTableId\": \"\",\n    \"FindingsOutputFieldId\": \"\",\n    \"FindingsParentGroupingFieldId\": \"\",\n    \"FindingsControlsFieldId\": \"\",\n    \"ShowUserScores\": false,\n    \"IssuanceScheduleType\": \"onetime\",\n    \"BeginningDate\": \"\",\n    \"IssueDate\": \"03/05/2021\",\n    \"DueDate\": \"03/31/2021\",\n    \"EndingDate\": \"\",\n    \"RepeatUnit\": \"\",\n    \"RepeatInterval\": \"\",\n    \"RepeatsSunday\": \"\",\n    \"RepeatsMonday\": \"\",\n    \"RepeatsTuesday\": \"\",\n    \"RepeatsWednesday\": \"\",\n    \"RepeatsThursday\": \"\",\n    \"RepeatsFriday\": \"\",\n    \"RepeatsSaturday\": \"\",\n    \"DueUnit\": \"\",\n    \"DueInterval\": \"\",\n    \"PrepopulatePriorAnswers\": false,\n    \"EmailSubject\": \"Onetime Scheduled Assessment\",\n    \"EmailBody\": \"Onetime Scheduled Assessment\",\n    \"SendReviewerOrIssuerEmail\": \"\",\n    \"SendCategoryEmail\": \"\",\n    \"AdministrativeEmailSubject\": \"\",\n    \"AdministrativeEmailBody\": \"\",\n    \"ScheduledAssessmentId\": 168\n  }\n}\n```\n\n```response:400\n{\n  \"Message\":\"Insufficient information supplied in assessment issuance XML.\",\n  \"StackTrace\":null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"IssueAssessment\": {\n    \"assessmentIssuance\": {\n      \"ProjectId\": 16,\n      \"Name\": \"Onetime Scheduled Assessment\",\n      \"TemplateId\": 21,\n      \"UserIds\": 1027,\n      \"GroupIds\": \"\",\n      \"AllowDelegation\": false,\n      \"GenerateFindings\": false,\n      \"AssignedUserOnly\": false,\n      \"ShowUserScores\": false,\n      \"IssuanceScheduleType\": \"onetime\",\n      \"IssueDate\": \"03/05/2021\",\n      \"DueDate\": \"03/31/2021\",\n      \"PrepopulatePriorAnswers\": false,\n      \"EmailSubject\": \"Onetime Scheduled Assessment\",\n      \"EmailBody\": \"Onetime Scheduled Assessment\"\n    }\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_2a2cc695c67c414e9f110987cc4df1d6"},{"name":"Content-Type","value":"application/json","description":"","id":"pair_9be16585b0bc4fbfafd625b28c4aaf5b"}],"authentication":{},"metaSortKey":-1559296226421.4375,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_485054859700417e9f0fe54358d13f35","parentId":"fld_75572a11cff6427993d19dc41acdf6bf","modified":1659125445568,"created":1643966951510,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/AssessmentService/IssueAssessment","name":"Issue Recurring Scheduled Assessment","description":"An assessment issued to a user that repeats how often you want it to be issued according to a schedule.\n\n* Permissions: The authentication account must have General Access - Create, Read and Update permissions to:\n    * Applicable component\n    * Applicable records\n    * Applicable fields in the component (table)\n* The user account must have \"Accessible to\" permissions to:\n    * Applicable assessment category\n\n```response:200\n{\n  \"AssessmentIssuanceItem\": {\n    \"ProjectId\": \"\",\n    \"TableId\": 10383,\n    \"FieldId\": 6543,\n    \"ContentId\": 1,\n    \"VendorId\": \"\",\n    \"IsVendorInternalMode\": \"\",\n    \"Name\": \"Recurring Scheduled Assessment\",\n    \"TemplateId\": 21,\n    \"UserIds\": 1027,\n    \"VendorContactId\": \"\",\n    \"GroupIds\": \"\",\n    \"AllowDelegation\": false,\n    \"AssignedUserOnly\": \"\",\n    \"ReviewerId\": \"\",\n    \"GenerateFindings\": false,\n    \"FindingsOutputTableId\": \"\",\n    \"FindingsOutputFieldId\": \"\",\n    \"FindingsParentGroupingFieldId\": \"\",\n    \"FindingsControlsFieldId\": \"\",\n    \"ShowUserScores\": false,\n    \"IssuanceScheduleType\": \"recurring\",\n    \"BeginningDate\": \"03/03/2021\",\n    \"IssueDate\": \"\",\n    \"DueDate\": \"\",\n    \"EndingDate\": \"\",\n    \"RepeatUnit\": \"monthly\",\n    \"RepeatInterval\": 1,\n    \"RepeatsSunday\": \"\",\n    \"RepeatsMonday\": \"\",\n    \"RepeatsTuesday\": \"\",\n    \"RepeatsWednesday\": \"\",\n    \"RepeatsThursday\": \"\",\n    \"RepeatsFriday\": \"\",\n    \"RepeatsSaturday\": \"\",\n    \"DueUnit\": \"daily\",\n    \"DueInterval\": 1,\n    \"PrepopulatePriorAnswers\": \"\",\n    \"EmailSubject\": \"Recurring Scheduled Assessment\",\n    \"EmailBody\": \"Recurring Scheduled Assessment\",\n    \"SendReviewerOrIssuerEmail\": \"\",\n    \"SendCategoryEmail\": \"\",\n    \"AdministrativeEmailSubject\": \"\",\n    \"AdministrativeEmailBody\": \"\",\n    \"ScheduledAssessmentId\": 169\n  }\n}\n```\n\n```response:400\n{\n  \"Message\":\"Insufficient information supplied in assessment issuance XML.\",\n  \"StackTrace\":null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"IssueAssessment\": {\n    \"assessmentIssuance\": {\n      \"TableId\": 10383,\n      \"FieldId\": 6543,\n      \"ContentId\": 1,\n      \"Name\": \"Recurring Scheduled Assessment\",\n      \"TemplateId\": 21,\n      \"UserIds\": 1027,\n      \"GroupIds\": \"\",\n      \"AllowDelegation\": false,\n      \"GenerateFindings\": false,\n      \"AssignedUserOnly\": false,\n      \"ShowUserScores\": false,\n      \"IssuanceScheduleType\": \"recurring\",\n      \"BeginningDate\": \"03/03/2021\",\n      \"RepeatUnit\": \"monthly\",\n      \"EndingDate\": \"11/05/2021\",\n      \"RepeatInterval\": 1,\n      \"DueUnit\": \"daily\",\n      \"DueInterval\": 1,\n      \"EmailSubject\": \"Recurring Scheduled Assessment\",\n      \"EmailBody\": \"Recurring Scheduled Assessment\"\n    }\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_2a2cc695c67c414e9f110987cc4df1d6"},{"name":"Content-Type","value":"application/json","description":"","id":"pair_9be16585b0bc4fbfafd625b28c4aaf5b"}],"authentication":{},"metaSortKey":-1559290215317.25,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_3bf1a5e896bc467097ba51612f473de6","parentId":"fld_75572a11cff6427993d19dc41acdf6bf","modified":1659125446127,"created":1643967033032,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/AssessmentService/IssueAssessment","name":"Issue Vendor Internal Assessment","description":"A one-time assessment issued to a vendor today.\n\n* Permissions: The authentication account must have General Access - Create, Read and Update permissions to:\n    * Applicable component\n    * Applicable records\n    * Applicable fields in the component (table)\n* The user account must have \"Accessible to\" permissions to:\n    * Applicable assessment category\n\n```response:200\n{\n  \"AssessmentIssuanceItem\": {\n    \"ProjectId\": \"\",\n    \"TableId\": 10066,\n    \"FieldId\": 1439,\n    \"ContentId\": 7,\n    \"VendorId\": 7,\n    \"IsVendorInternalMode\": \"\",\n    \"Name\": \"Vendor Internal Assessment\",\n    \"TemplateId\": 21,\n    \"UserIds\": \"\",\n    \"VendorContactId\": 1048,\n    \"GroupIds\": \"\",\n    \"AllowDelegation\": false,\n    \"AssignedUserOnly\": \"\",\n    \"ReviewerId\": \"\",\n    \"GenerateFindings\": false,\n    \"FindingsOutputTableId\": \"\",\n    \"FindingsOutputFieldId\": \"\",\n    \"FindingsParentGroupingFieldId\": \"\",\n    \"FindingsControlsFieldId\": \"\",\n    \"ShowUserScores\": false,\n    \"IssuanceScheduleType\": \"immediate\",\n    \"BeginningDate\": \"\",\n    \"IssueDate\": \"\",\n    \"DueDate\": \"03/12/2021\",\n    \"EndingDate\": \"\",\n    \"RepeatUnit\": \"\",\n    \"RepeatInterval\": \"\",\n    \"RepeatsSunday\": \"\",\n    \"RepeatsMonday\": \"\",\n    \"RepeatsTuesday\": \"\",\n    \"RepeatsWednesday\": \"\",\n    \"RepeatsThursday\": \"\",\n    \"RepeatsFriday\": \"\",\n    \"RepeatsSaturday\": \"\",\n    \"DueUnit\": \"\",\n    \"DueInterval\": \"\",\n    \"PrepopulatePriorAnswers\": false,\n    \"EmailSubject\": \"Vendor Internal Assessment\",\n    \"EmailBody\": \"Vendor Internal Assessment\",\n    \"SendReviewerOrIssuerEmail\": \"\",\n    \"SendCategoryEmail\": \"\",\n    \"AdministrativeEmailSubject\": \"\",\n    \"AdministrativeEmailBody\": \"\",\n    \"ScheduledAssessmentId\": 171\n  }\n}\n```\n\n```response:400\n{\n  \"Message\":\"Insufficient information supplied in assessment issuance XML.\",\n  \"StackTrace\":null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"IssueAssessment\": {\n    \"assessmentIssuance\": {\n      \"TableId\": 10066,\n      \"FieldId\": 1439,\n      \"ContentId\": 7,\n      \"VendorId\": 7,\n      \"Name\": \"Vendor Internal Assessment\",\n      \"TemplateId\": 21,\n      \"VendorContactId\": 1048,\n      \"AllowDelegation\": false,\n      \"GenerateFindings\": false,\n      \"AssignedUserOnly\": false,\n      \"ShowUserScores\": false,\n      \"IssuanceScheduleType\": \"immediate\",\n      \"DueDate\": \"03/12/2021\",\n      \"PrepopulatePriorAnswers\": false,\n      \"EmailSubject\": \"Vendor Internal Assessment\",\n      \"EmailBody\": \"Vendor Internal Assessment\"\n    }\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_2a2cc695c67c414e9f110987cc4df1d6"},{"name":"Content-Type","value":"application/json","description":"","id":"pair_9be16585b0bc4fbfafd625b28c4aaf5b"}],"authentication":{},"metaSortKey":-1559287209765.1562,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_730ef13c38d24d0196a6e9f31345637e","parentId":"fld_75572a11cff6427993d19dc41acdf6bf","modified":1659125446723,"created":1643967101481,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/AssessmentService/IssueAssessment","name":"Issue Vendor Recurring Assessment","description":"An assessment to a vendor that repeats how often you want it to be issued according to a schedule.\n\n* Permissions: The authentication account must have General Access - Create, Read and Update permissions to:\n    * Applicable component\n    * Applicable records\n    * Applicable fields in the component (table)\n* The user account must have \"Accessible to\" permissions to:\n    * Applicable assessment category\n\n```response:200\n{\n  \"AssessmentIssuanceItem\": {\n    \"ProjectId\": \"\",\n    \"TableId\": 10066,\n    \"FieldId\": 1439,\n    \"ContentId\": 6,\n    \"VendorId\": 6,\n    \"IsVendorInternalMode\": \"\",\n    \"Name\": \"Vendor Recurring Assessment [Vendor Name]\",\n    \"TemplateId\": 21,\n    \"UserIds\": \"\",\n    \"VendorContactId\": 1059,\n    \"GroupIds\": \"\",\n    \"AllowDelegation\": false,\n    \"AssignedUserOnly\": \"\",\n    \"ReviewerId\": \"\",\n    \"GenerateFindings\": false,\n    \"FindingsOutputTableId\": \"\",\n    \"FindingsOutputFieldId\": \"\",\n    \"FindingsParentGroupingFieldId\": \"\",\n    \"FindingsControlsFieldId\": \"\",\n    \"ShowUserScores\": false,\n    \"IssuanceScheduleType\": \"recurring\",\n    \"BeginningDate\": \"03/08/2021\",\n    \"IssueDate\": \"\",\n    \"DueDate\": \"\",\n    \"EndingDate\": \"\",\n    \"RepeatUnit\": \"Monthly\",\n    \"RepeatInterval\": 1,\n    \"RepeatsSunday\": \"\",\n    \"RepeatsMonday\": \"\",\n    \"RepeatsTuesday\": \"\",\n    \"RepeatsWednesday\": \"\",\n    \"RepeatsThursday\": \"\",\n    \"RepeatsFriday\": \"\",\n    \"RepeatsSaturday\": \"\",\n    \"DueUnit\": \"Weeks\",\n    \"DueInterval\": 1,\n    \"PrepopulatePriorAnswers\": \"\",\n    \"EmailSubject\": \"Vendor Recurring Assessment\",\n    \"EmailBody\": \"Vendor Recurring Assessment [Vendor Name]\",\n    \"SendReviewerOrIssuerEmail\": false,\n    \"SendCategoryEmail\": \"\",\n    \"AdministrativeEmailSubject\": \"\",\n    \"AdministrativeEmailBody\": \"\",\n    \"ScheduledAssessmentId\": 173\n  }\n}\n```\n\n```response:400\n{\n  \"Message\":\"Insufficient information supplied in assessment issuance XML.\",\n  \"StackTrace\":null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"POST","body":{"mimeType":"application/json","text":"{\n  \"IssueAssessment\": {\n    \"assessmentIssuance\": {\n      \"TableId\": 10066,\n      \"FieldId\": 1439,\n      \"ContentId\": 6,\n      \"VendorId\": 6,\n      \"Name\": \"Vendor Recurring Assessment [Vendor Name]\",\n      \"TemplateId\": 21,\n      \"VendorContactId\": 1059,\n      \"AllowDelegation\": false,\n      \"GenerateFindings\": false,\n      \"AssignedUserOnly\": false,\n      \"ShowUserScores\": false,\n      \"IssuanceScheduleType\": \"recurring\",\n      \"BeginningDate\": \"03/08/2021\",\n      \"RepeatUnit\": \"Monthly\",\n      \"EndingDate\": \"11/05/2022\",\n      \"RepeatInterval\": 1,\n      \"DueUnit\": \"Weeks\",\n      \"DueInterval\": 1,\n      \"EmailSubject\": \"Vendor Recurring Assessment\",\n      \"EmailBody\": \"Vendor Recurring Assessment [Vendor Name]\",\n      \"SendReviewerOrIssuerEmail\": false\n    }\n  }\n}"},"parameters":[],"headers":[{"name":"Accept","value":"application/json","description":"","id":"pair_2a2cc695c67c414e9f110987cc4df1d6"},{"name":"Content-Type","value":"application/json","description":"","id":"pair_9be16585b0bc4fbfafd625b28c4aaf5b"}],"authentication":{},"metaSortKey":-1559285706989.1094,"isPrivate":false,"settingStoreCookies":false,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_092f8e1f97444cfb9ae498597a59c498","parentId":"fld_288e0bf7f77a47589932636ce2582f72","modified":1644554307386,"created":1639525241334,"url":"{{ _.scheme }}{{ _.host }}{{ _.port }}/ReportService/ExportReport","name":"Export Report","description":"Outputs report data to a CSV, PDF, or XLSX file format. The My Reports tab in the user interface contains the ID for the desired report. If a report is not found or permissions are not granted to export data, the message \"Report does not exist or is inaccessible\" appears.\n\n* Permissions: The authentication account must have General Access - Read and Print/Export permissions to:\n    * Applicable component\n    * Applicable records\n    * Applicable fields in the component (table)\n\n```response:200\nId,Name,Created At,Updated At\n1,Test Record 1,6/29/2020 4:02:17 PM,1/25/2022 11:58:21 AM\n2,Test Record 2 Clone,11/4/2021 9:04:44 AM,11/4/2021 9:19:57 AM\n3,Test Record 3 notes,1/12/2022 12:55:30 PM,1/12/2022 1:10:09 PM\n```\n\n```response:400\n{\n  \"Message\": \"Report does not exist or is inaccessible.\",\n  \"StackTrace\": null\n}\n```\n\n```response:400\n{\n  \"Message\": \"Invalid permissions.\",\n  \"StackTrace\": null\n}\n```","method":"GET","body":{},"parameters":[{"disabled":false,"id":"pair_0fbffb169c444462b9c484419c8a2ce7","name":"id","value":"3736","description":"The Id of the desired report. (integer)"},{"disabled":false,"id":"pair_dc771f91638c4909b20b77a3749efdfe","name":"fileExtension","value":"csv","description":"The file type to export. (string [csv | pdf | xlsx])"}],"headers":[{"name":"Accept","value":"application/json","description":" ","id":"pair_2f439481fc614d158f1d157f83d7910b"}],"authentication":{},"metaSortKey":-1559284204213.0625,"isPrivate":false,"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":false,"settingRebuildPath":false,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_288e0bf7f77a47589932636ce2582f72","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1639624519655,"created":1639525241333,"name":"Report Services","description":"The Report Services include the available methods for reporting about the data in the Integrated Risk Management Platform.","environment":{},"environmentPropertyOrder":{},"metaSortKey":-1639624403435,"_type":"request_group"},{"_id":"env_ba935943e8c74835a99a22a7c6ec8034","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1659126727100,"created":1639525241258,"name":"New Environment","data":{},"dataPropertyOrder":{},"color":null,"isPrivate":false,"metaSortKey":1557197943331,"_type":"environment"},{"_id":"jar_8747b52d01424db9a17505fe71639e2d","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1659126756467,"created":1639525241268,"name":"Default Jar","cookies":[],"_type":"cookie_jar"},{"_id":"spc_81d0aa9546544255bebe3c17f0197064","parentId":"wrk_1c95d493c17a4566a1de3adbb525a18f","modified":1639525241695,"created":1639525241269,"fileName":"Lockpath v 6.0 Github","contents":"","contentType":"yaml","_type":"api_spec"},{"_id":"env_3c8b2a5340464ed2b1e7d331bfc23063","parentId":"env_ba935943e8c74835a99a22a7c6ec8034","modified":1659126730162,"created":1659125061234,"name":"Documentation","data":{"scheme":"https://","host":"[customer instance].keylightgrc.com","port":":4443","apiaccount":"FakeUsername","apiPassword":"FakePassword"},"dataPropertyOrder":{"&":["scheme","host","port","apiaccount","apiPassword"]},"color":null,"isPrivate":false,"metaSortKey":1.5,"_type":"environment"}]}