<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- Navigating Apidog</strong></p><p><strong>- Uploading Test Data (CSV)</strong></p><p><strong>- Creating a Test Scenario</strong></p><p><strong>- Authorising the Request</strong></p><p><strong>- Linking Dynamic Values to Test Data</strong></p><p><strong>- Running the Request</strong></p><p><br></p><p><strong><br></strong></p><p><strong>Related Guides:</strong></p><ul><li><a href="https://usehalo.com/haloitsm/guides/1670/" target="_blank" rel="noopener noreferrer"><strong>Setting up an API Agent</strong><br></a></li><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/1499" target="_blank" rel="noopener noreferrer" style="font-weight: bold;"><strong>Using Postman</strong></a></li></ul><p><br></p><p data-pasted="true">Apidog is a tool which can be used to make direct API calls and view the response returned from such calls. </p><p><br></p><p>Download <a href="https://apidog.com/" target="_blank" rel="noopener noreferrer"><strong>here</strong></a>.</p><p><br></p><p><strong><span style="font-size: 14pt;">Navigating Apidog</span></strong></p><p>Open <a target="_blank" rel="noopener noreferrer noopener noreferrer" data-fr-linked="true" href="https://app.apidog.com/" data-pasted="true">https://app.apidog.com/</a> where you will see any teams you are a part of, as well as projects within that team. Click into an existing project, or click "New Project" on the right to create one.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMyZTkxNzAyLTMxYzktNDk2OS04YzJlLTRjNmU2YzEzYmExZCJ9.ZqI6eW2pKXhK_iYTmpgB0l1LRHDVMDykBBamDkAtZyk" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 577.429px;" height="577"></p><p><strong><span style="font-size: 10pt;">Fig 1. Choosing a project</span></strong></p><p><br></p><p>After opening the project, navigate to the "Tests" area on the left hand side.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjJmNjJhMTZhLWQ5YzktNDE4ZC1iNmZmLWE3OTVkOTU4OWNhZSJ9.TOWaGI6eVEWHBxu2iN5pQnh6TU7P4e2t0d00ZRzfkRw" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 579.249px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 2. Opening the Tests area</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Uploading Test Data (CSV)</span></strong></p><p>Within the "Tests" area, you will see a list of your existing tests on the left side, as well as shortcuts to create new ones in the middle.</p><p><br></p><p>If you wish to use a CSV file to create, update or delete entities within Halo, you can upload this here. These CSV files can also be made via reports in Halo, and then exported with the "Export to CSV" button on the report.</p><p><br></p><p>Once you have your file, click "New Test Data (Static)" to upload it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODU3YTQ1LWM0MDEtNGJkZC1iYjE5LWVkMzY2MzIxNzI3NiJ9.yzngEKC9r59pV7oGMfxEYZxTeAYSzvIYydqd2W7eAQE" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 575.848px;" height="576"></p><p><strong><span style="font-size: 10pt;">Fig 3. Creating a new Test Data</span></strong></p><p><br></p><p>You will then see the below screen. Hover over "Import/Export" and choose "Import CSV". </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImIyNDg3NDU0LTJjZDEtNDM2Yy04NWU4LTZmMWRlZjM3MTY0YSJ9.k7ypM8Mnkc2d25DN0KQmnHSLLjzxGMYCqMz_nkw4WSY" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 577.599px;" height="578"></p><p><strong><span style="font-size: 10pt;">Fig 4. Import CSV option</span></strong></p><p><br></p><p>A popup will show to choose the file to upload. Upon upload, the data in the CSV will show in a table format like below. Once uploaded, give the Test Data a relevant name and save.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU3ZDhmZGM5LThhYTAtNDBhZi1hMGU1LTY4ZTdiMzk3ZGEwMiJ9.T5aqBVcGQfZT3iHN9JXK_YJLvFl6EEuvMmqag1ObUns" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 577.429px;" height="577"></p><p><strong><span style="font-size: 10pt;">Fig 5. Naming the Test Data</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Creating a Test Scenario</span></strong></p><p>Now that we have uploaded our Test Data file, we can create a request to run it. Click either the three dots next to "Test Scenarios" on the left, or the shortcut in the middle.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRmMTBmZjc4LWY1MTEtNGMxNS05MmE2LTZjYzU0MDJlMTkzYyJ9.gaSKKhFEuStPtgcLuxp1l2DPaRqdqcnmASOuUzPVifM" class="fr-fic fr-fil fr-dib" width="1218" style="width: 1220px; height: 578.734px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 6. Creating a new Test Scenario</span></strong></p><p><br></p><p>A popup will show to set a name for the Test Scenario, then save.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0MTY3ZWI2LTY5MjMtNDkzNC1hYmIwLTg0NTA4YzI3NDM5NSJ9.i67cEdOv1rGnQv1Th4qpKfct6Gp1VuDxo--4LVHJKek" class="fr-fic fr-fil fr-dib" width="526" height="617"></p><p><strong><span style="font-size: 10pt;">Fig 7. Naming the Test Scenario</span></strong></p><p><br></p><p>The screen below will show to create your Test Scenario. If using a Test Data file, choose the file on the right hand side. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc2YTc1MTJjLTIwOWUtNDU2Yi05N2FkLTM4ZDlhNGYyMmRiNyJ9.042f00wCWH4EEoi4jrEsjxJuohHM0jgjRoOn93w1878" class="fr-fic fr-fil fr-dib" width="1219" style="width: 1221px; height: 578.57px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 8. Adding the Test Data to the Test Scenario</span></strong></p><p><br></p><p>Next, we can add a step to the Test Scenario. Click "Add Step" in the middle.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhlN2YxMDUwLWViMzQtNDg1Zi1hMGUyLWZhZjJkZWYzN2JmNSJ9.8VZYctec3iCvHR_dKwEfzTWF0wMDkOtoY7CxZvyQIP8" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 577.766px;" height="578"></p><p><strong><span style="font-size: 10pt;">Fig 9. Adding a step</span></strong></p><p><br></p><p>You can then choose what kind of step you want to add. Choose "Add HTTP request".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjliYmI3NDI4LWIxZjgtNDUxOS05OTY3LTcyYTFkYTgwYTIyNSJ9.SCYhhShNkp0FCQVcWh3fOvRS6uJe7tNKPtpzvzV2S5Q" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 578.238px;" height="578"></p><p><strong><span style="font-size: 10pt;">Fig 10. Choosing the step type</span></strong></p><p><br></p><p>This is the screen that will show to configure your API request.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkZTVkZDRiLTkwYjAtNDFjMy1iNGM4LTFjNzNhMGUxNjc4NiJ9.fKMvCwTJJ2J3FDBa2oI-2K3c4txuj9FGXQH_K8kdUGk" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 577.634px;" height="578"></p><p><strong><span style="font-size: 10pt;">Fig 11. API request screen</span></strong></p><p><br></p><p>First, we need to work out what endpoint to send the request to. Open the developer console with F12 on your keyboard, and complete the action/field you want to do with the API. The developer console will show a "POST" action. Click on this.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU2ZGQzNWU4LTY3NzctNDYyYy04OWYxLWQzMDNiNDlkNTU5NSJ9.TRjSWIUtxrC7gDJFvFppN8_oVhJrAfAUNNKdKcU1VKs" class="fr-fic fr-fil fr-dib" width="1223" style="width: 1225px; height: 685.697px;" height="686"></p><p><strong><span style="font-size: 10pt;">Fig 12. Creating a POST request</span></strong></p><p><br></p><p>The "Headers" tab of the console will show the "Request URL" you need to use for the request. If you wish to use a Bearer token to authorise your request, this can also be retrieved this way. We will also cover how to use OAuth 2.0 with Client Credentials further into this guide.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY1MWQ5NWJjLTYxZjgtNDZlYi1hOTkxLTBjZTAzNWMwNGMzMSJ9.iLWLJyq7MNACrx2G5hahuhBzpSQdI-iO3sjrZgJHzRc" class="fr-fic fr-fil fr-dib" width="1222" style="width: 1224px; height: 683.11px;" height="683"></p><p><strong><span style="font-size: 10pt;">Fig 13. Finding the request URL</span></strong></p><p><br></p><p>Copy and paste this URL into the highlighted field.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRjOWY4NTBiLWVlNWMtNGQzYi05ZmVhLWNkOWZmYmRhMTgxMiJ9.8YbgWGqLyWYqrEE3m3or0CFBx3Zv5or4mPyfiVfM_HQ" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 579.518px;" height="580"></p><p><strong><span style="font-size: 10pt;">Fig 14. Adding the URL</span></strong></p><p><br></p><p>Next, we need to format the JSON body of the request. This is needed for POST requests and some GET requests, but DELETE will not need these.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhmNjhkZDJkLTRlOGEtNDRjZS1hNjYxLTcxN2E0NWUyNjM1MSJ9.gu4uwLzy1p35-tXJn3UB41t9dboYL8IsMWSjX7hIrmA" class="fr-fic fr-fil fr-dib" width="1217" style="width: 1219px; height: 576.347px;" height="576"></p><p><strong><span style="font-size: 10pt;">Fig 15. Setting the Body as JSON</span></strong></p><p><br></p><p>We can also reference the developer console to format the JSON body. The "Response" tab will show the post that was made within Halo when completing the relevant action to help format your body.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRhOGU1M2I0LWZiNmUtNDNjMS1hMTFkLTlhYWNiNmM3YmM2YiJ9.C1eILxll6O1qwZKEgp5vUZGBhlom7Knc2z_ILs_2bfQ" class="fr-fic fr-fil fr-dib" width="859" height="904"></p><p><strong><span style="font-size: 10pt;">Fig 16. Finding the JSON required</span></strong></p><p><br></p><p>In this example, we are updating a list of billable actions to use the "No Charge" charge type instead. This is a post to the actions endpoint, to update a specific action ID on a specific ticket, and set that charge rate to "0" (No Charge).</p><p><br></p><p><strong><em>Note: Ensure you add "[ ]" around the JSON retrieved from the console.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMyYTUyYWJmLWFmYjMtNGEzOC1hYTQ0LThkOTFlY2E3YzQ3YyJ9.XEbVf7p5t0wQKTGZkRf8MugwN3FKoYP76of5dgtMrqo" class="fr-fic fr-fil fr-dib" width="1224" style="width: 1226px; height: 580.029px;" height="580"></p><p><strong><span style="font-size: 10pt;">Fig 17. JSON added</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Authorising the Request</span></strong></p><p>Switch to the "Auth" tab and select your "Authorization Type". If you are using a Bearer token, this is retrieved during Figure 13.</p><p><br></p><p>We will cover how to use OAuth 2.0 with Client Credentials over the next few steps. Set this dropdown to "OAuth 2.0".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE3NmYyMzY1LWI2OTctNGU1Mi1hMzI2LTk3ZjcxM2M5MTk5YiJ9.7EF0YuQdS6XM44ISiDqskjtHpGghDyTMjivEYbrkz3c" class="fr-fic fr-fil fr-dib" width="1222" style="width: 1224px; height: 578.711px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 18. Setting the Auth type</span></strong></p><p><br></p><p>In Halo, navigate to Configuration > Integrations > Halo API and click the "View Applications" button.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImIzMTViMjUyLTY4OWUtNDMzOS1iOTg4LTJlY2U1ODU4ZWY4YSJ9.GDYD_Xj9Iy2Kkv8ERhB1sZOLfdYzm9zZvFFBCNyQCS4" class="fr-fic fr-fil fr-dib" width="1165" height="814"></p><p><strong><span style="font-size: 10pt;">Fig 19. Halo API module</span></strong></p><p><br></p><p>This will bring up a list of existing API applications. Click the "New" button in the top right.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQ5NjZjMDdkLWM3MzAtNDcxNS04Y2FhLTdkZTgwYjc4YmQyMyJ9.gS3ArJXxep2CFPWTAIiSGkQ3zE6QT8J7SPJCWVvNIaM" class="fr-fic fr-fil fr-dib" width="1217" style="width: 1219px; height: 346.395px;" height="346"></p><p><strong><span style="font-size: 10pt;">Fig 20. List of existing API applications</span></strong></p><p><br></p><p>A screen will then show to create the application. Select "Client ID and Secret (Services)". A Client ID and Client Secret will then show, along with the option to choose the Login Type. In this example, we are using Agent. If you are using an API Agent, this can be set here as well.</p><p><br></p><p><strong><em>Note: Save the application first and the permissions, then click edit again and generate the secret. This ensures the secret has been generated with the correct permission.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjUzMTIyNWZjLTAwZjktNDdiZC1hZDc4LTlmYzdmZDRlMTZhZCJ9.2g8C3eb4axKDSGh5KGeFzcHHDCUYPhcPTTQNzNCGQok" class="fr-fic fr-fil fr-dib" style="width: 1218px; height: 631.526px;" width="1216" height="632"></p><p><strong><span style="font-size: 10pt;">Fig 21. Creating an application</span></strong></p><p><br></p><p>In the "Permissions" tab, set the permissions the application has access to.</p><p><br></p><p><strong><em>Note: If using "Login Type" of "Agent" in the "Details" tab, this will add additional permission restrictions based on what that agent can access.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjJhYTA0YWU3LThmNzMtNGYzOS1iMDJiLTgzNGI2NTNhNDhlNyJ9._aNZ7KJ13J5tQDWbHFYPShw8_Q3LYNqmFv5HX7PNC2U" class="fr-fic fr-fil fr-dib" width="1032" height="483"></p><p><strong><span style="font-size: 10pt;">Fig 22. Adding permissions</span></strong></p><p><br></p><p>Back in Apidog, you can then set these credentials. Ensure you open the "More" dropdown to see the rest of the options.</p><p><br></p><ul><li><strong>Grant Type:</strong> Client Credential</li><li><strong>Access Token URL:</strong> YOURHALOURL/auth/token</li><li><strong>Client ID:</strong> Client ID from Figure 21</li><li><strong>Client Secret: </strong>Client Secret from Figure 21</li><li><strong>Scope:</strong> Type the scope you set in Figure 22</li></ul><p><br></p><p>Once the above is set, click "Get Token".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk4OGYzMmZkLTZkZWEtNDE3NS04N2Y1LTk1MmE4OTk3MDdhNCJ9.Kl_HqVqOcdTP6nHEfWmqyUqsPP2mMv7rBCAE3Bx8K6w" class="fr-fic fr-fil fr-dib" width="1223" style="width: 1225px; height: 579.184px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 23. Adding the base credentials</span></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjUwYmJkOWRlLWU2MmEtNDJlZi05NWIxLTU0NzM5NTE5OWNlZCJ9.B4vKMdvstaj32iJBpHHxKp4S-ivC7872Bj_F8YiB29k" class="fr-fic fr-fil fr-dib" width="1222" style="width: 1224px; height: 578.711px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 24. Adding the scope and getting the token</span></strong></p><p><br></p><p>When authentication is complete, you can see the status code on the right to see if it is successful. You may also want to test with a GET request at this point.</p><p><br></p><p data-pasted="true">If you are running a request without a CSV file, you can use the "Send" button in the top right at this point.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA2NDA0YzJjLWM5N2UtNDg3OS04ZjQzLWZkOTZhNjgwODk3MyJ9.NBv9Ll6R9BWoCtZoDZ5UHJ93NE03MODHnQv89cskiKQ" class="fr-fic fr-fil fr-dib" width="1217" style="width: 1219px; height: 576.347px;" height="576"></p><p><strong><span style="font-size: 10pt;">Fig 25. Testing the connection</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Linking Dynamic Values to Test Data</span></strong></p><p>If using a CSV file, you may want to utilise dynamic values to replace the JSON with column headers from the file.</p><p><br></p><p>Highlight the pre-set value in the JSON you want to replace, and "Insert Dynamic Value". </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjgwNWExNDM3LTJiNTItNGQ2OC04ODUzLWQxNWMwNzdhMzY2ZCJ9.tcAIT2fUxtLAUxPFWwQaWftC12TUJIdlUrTmXqy7ppY" class="fr-fic fr-fil fr-dib" width="1222" style="width: 1224px; height: 578.711px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 26. Replacing static values with a dynamic value</span></strong></p><p><br></p><p>Select "Retrieve Variable".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjgxYzJkZjNkLWU3MWUtNDA0NC1iZGFjLTliMzZjODE1YjIxMyJ9.cUGrEe217ORS5nNvW21TmUoRytD3rTHIlybVp6MhfD4" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 577.634px;" height="578"></p><p><strong><span style="font-size: 10pt;">Fig 27. Retrieve Variable option</span></strong></p><p><br></p><p>Type the name of your column header, then click "Insert". </p><p><br></p><p><strong><em>Note: Variables are case-sensitive.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjAxYmM3Njg1LWI2YTAtNDJiNC05ZGU4LTllMTdjM2FhMDQ2NiJ9.H0zcUTG7z0nDwNXxB9Gpv3yyUhQb1yUxzULnvkZ3KrA" class="fr-fic fr-fil fr-dib" width="1224" style="width: 1226px; height: 579.657px;" height="580"></p><p><strong><span style="font-size: 10pt;">Fig 28. Adding the variable name</span></strong></p><p><br></p><p>This will replace the static value with a dynamic variable.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI5NjM0ODUwLTIzYTMtNDJiOC05ZjdjLTM2NWM1YjI2OGZjMCJ9.IFSFRP_K8NRy_az6ZZkHTol3PdO9EwJsrLws_a2hv2g" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 576.32px;" height="576"></p><p><strong><span style="font-size: 10pt;">Fig 29. Variables have replaced the values</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Running the Request</span></strong></p><p>Once you have the JSON as you need it, click the "Run" button.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJjMDE1ZDU3LWY4NjctNDJkNy1hOTU2LTc5YmMyNTkwNjhjZSJ9.oszh4fhuM-vs3vdlsoeDwn64cRTtDd1PjK05hMEZzLk" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 576.995px;" height="577"></p><p><strong><span style="font-size: 10pt;">Fig 30. Run button</span></strong></p><p><br></p><p>If using a file, a popup will show to set which rows to run. This will auto-select them all, so click "Run" again.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImUxNTRmYmIwLThmMmQtNGMyNi1iYzdjLTMyM2QwMWQ3ZjVkYiJ9.RoYvWnFeT4oejACReHMsfEUVhXhhc4B5afpORWwxA1E" class="fr-fic fr-fil fr-dib" width="730" height="565"></p><p><strong><span style="font-size: 10pt;">Fig 31. Running values from the CSV</span></strong></p><p><br></p><p>The requests will then start, and show the relevant status codes of each iteration.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM5OThkMGIzLTRlMzktNGJhNi04YzA1LTJjOWQyNWRhNThlYSJ9.GDf5RHzLbEj_eynb1dAiZN_-gMXo06TZ8420w4eR9f8" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 578.741px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 32. Running the request</span></strong></p><p><br></p>
