Does anybody know the location in the API docs to check in a device/asset via API?
Solved
How to use API to check in device/asset
Best answer by athaxton_iiQ
Good Afternoon Everyone,
I hope you are all doing well! My name is Drew Thaxton. I am a Customer Support Specialist from Incident IQ who specializes in helping our customers with API. I just wanted to reach out to help assist with any API questions or concerns and to provide some API calls that may be helpful as well.
Regarding the API documentation, you should be able to locate our new API documentation site at https://incidentiq.stoplight.io/docs/v1. Previously, we did have two additional API documentation sites that we did recommend to districts as well, but as functionality of Incident IQ has expanded and been enhanced, these endpoints provided and information requested changed as well which did require us to create new documentation. With that said though, I do apologize that these additional calls identified may not have been included in this documentation, but we are looking to expand this documentation and help it grow to help suit your districts needs. Below, you should be able to find two API calls which I hope will be able to help assist in updating an Asset Owner as well as updating an Asset’s location. Please note, in the two calls below you may notice {} brackets in the API URL, headers, and body of the call. For each of these {} brackets, you will want to replace the brackets with the Value it asks for in the brackets.
API call to Update Asset Owner:
curl --location 'https://{SITE}.incidentiq.com/api/v1.0/assets/{ASSETID}/owner' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'client: WebBrowser' \
--header 'content-type: application/json' \
--header 'productid: 88df910c-91aa-e711-80c2-0004ffa00010' \
--header 'siteid: {SITEID}' \
--header 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{"OwnerId":"{OWNERID}"}'
API call to update Asset Location:
curl --location 'https://{SITE}.incidentiq.com/api/v1.0/assets/bulk/set-location' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'client: WebBrowser' \
--header 'content-type: application/json' \
--header 'productid: 88df910c-91aa-e711-80c2-0004ffa00010' \
--header 'siteid: {SITEID}' \
--header 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{"AssetIds":["{ASSETID}"],"Request":{"LocationId":"{LOCATIONID}","RoomId":null,"LocationDetails":null,"UpdateAssetToOwnersLocation":null},"IsSelectAll":false,"AssetsRequest":{"OnlyShowDeleted":false,"Filters":[],"FilterByViewPermission":true,"BypassIndex":true,"FilterByViewProduct":true,"ProductId":"88df910c-91aa-e711-80c2-0004ffa00010"}}’
I am also currently working with getting these two calls added to our documentation at https://incidentiq.stoplight.io/docs/v1, but if you may have any questions or concerns regarding any additional calls though, please let me know, and I will be more than happy to help assist in getting these calls as well!
Best Regards,
Drew
+18I believe it should be in the API documentation that is updated within the platform. If not, it will be posted soon. Thank you for your continued patience on this update.
+1I am also trying to figure this out. I am not seeing it in the API documentation (but I also don’t think my full access has been approved yet).
+18
+18
Not to sound like a broken record, but I’ve commented in various places on the community how the API documentation kind of took a step backwards. It looks better, but missing a LOT of endpoints that were previously included in the old documentation.
Here’s what I think you might need...
POST to endpoint
https://{district}.incidentiq.com/api/v1.0/assets/{AssetId}/owner
Payload (I believe OwnerId would be blank if checking-in)
{"OwnerId":{OwenerId},"UpdateLastInventoryDate":true}
Hopefully someone can confirm.
Not to sound like a broken record, but I’ve commented in various places on the community how the API documentation kind of took a step backwards. It looks better, but missing a LOT of endpoints that were previously included in the old documentation.
Agreed. It is impacting the usefulness of the system.
To do some would the body include something like
{“Location”:{LocationID}}
Really difficult to use an API without documentation.
To do some would the body include something like
{“Location”:{LocationID}}
Really difficult to use an API without documentation.
I don’t think I’ve had to use that one yet myself. I can try to figure it out, but hoping someone from iiQ can chime in to help out too.
+13FWIW I find it easier just to update the status (or something similar) and let an iiQ rule handle the rest. By easiest I mean from a scripting standpoint but that’s more to work around my novice ability.
/api/v1.0/assets/bulk/set-status is an endpoint that works well for me. I have it changing to a status titled “Check into storage” and rules process it from there. That status is also used by our helpdesk to cut down on the number of steps for them to check something in manually for times they don’t want to use rollout scout.
+13Adding to the documentation confusion, aside from the method
+7Good Afternoon Everyone,
I hope you are all doing well! My name is Drew Thaxton. I am a Customer Support Specialist from Incident IQ who specializes in helping our customers with API. I just wanted to reach out to help assist with any API questions or concerns and to provide some API calls that may be helpful as well.
Regarding the API documentation, you should be able to locate our new API documentation site at https://incidentiq.stoplight.io/docs/v1. Previously, we did have two additional API documentation sites that we did recommend to districts as well, but as functionality of Incident IQ has expanded and been enhanced, these endpoints provided and information requested changed as well which did require us to create new documentation. With that said though, I do apologize that these additional calls identified may not have been included in this documentation, but we are looking to expand this documentation and help it grow to help suit your districts needs. Below, you should be able to find two API calls which I hope will be able to help assist in updating an Asset Owner as well as updating an Asset’s location. Please note, in the two calls below you may notice {} brackets in the API URL, headers, and body of the call. For each of these {} brackets, you will want to replace the brackets with the Value it asks for in the brackets.
API call to Update Asset Owner:
curl --location 'https://{SITE}.incidentiq.com/api/v1.0/assets/{ASSETID}/owner' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'client: WebBrowser' \
--header 'content-type: application/json' \
--header 'productid: 88df910c-91aa-e711-80c2-0004ffa00010' \
--header 'siteid: {SITEID}' \
--header 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{"OwnerId":"{OWNERID}"}'
API call to update Asset Location:
curl --location 'https://{SITE}.incidentiq.com/api/v1.0/assets/bulk/set-location' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'client: WebBrowser' \
--header 'content-type: application/json' \
--header 'productid: 88df910c-91aa-e711-80c2-0004ffa00010' \
--header 'siteid: {SITEID}' \
--header 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{"AssetIds":["{ASSETID}"],"Request":{"LocationId":"{LOCATIONID}","RoomId":null,"LocationDetails":null,"UpdateAssetToOwnersLocation":null},"IsSelectAll":false,"AssetsRequest":{"OnlyShowDeleted":false,"Filters":[],"FilterByViewPermission":true,"BypassIndex":true,"FilterByViewProduct":true,"ProductId":"88df910c-91aa-e711-80c2-0004ffa00010"}}’
I am also currently working with getting these two calls added to our documentation at https://incidentiq.stoplight.io/docs/v1, but if you may have any questions or concerns regarding any additional calls though, please let me know, and I will be more than happy to help assist in getting these calls as well!
Best Regards,
Drew
+18I see this issue is marked as solved… but honestly, it isn’t. Neither of these requests are documented in either of the API docs, and there does not appear to be any meaningful error-handling when updating {OWNERID} through the API- you will get a response like this, with the information in the Message and StatusCode keys being the only hint an update went through, and you will get the same message whether a valid userId has been used or not… meaning an asset can get unassigned if an invalid userId is passed in.
{
"UserToken": "30079798-531a-41eb-a2e3-78fb2d11023c",
"RequestDate": "2025-03-12T23:36:29.3532178Z",
"ExecutionTime": 796.3824,
"StatusCode": 200,
"Message": "Asset Owner was changed.",
"ServerName": "wintgt0000FS",
"ProcessId": 3772,
"OperationId": "7Z6vzbyv",
"Properties": {}
}
I would expect to get same response that the GET Asset call returns, so some error-handling could be implemented without requiring a second API call to check that the asset has been assigned properly. Our school is hoping to implement some large scale inventory automations with a white glove vendor that will be handling a lot of our device prep next school year, and the lack of concise documentation on what seems to be a pretty basic task is a little discouraging.
+18
Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.
