Inventory Item
Update Inventory Item
Endpoint to update an existing Inventory Item
put/inventory-item/{id}
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Inventory Item to update
Request body
Example request
{
"data": {
"isArchived": true
}
}Response
Updated successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"entityType": "Example Text",
"entityKey": "Example Text",
"displayName": "Example Text",
"source": "Example Text",
"description": "This is an example of longer text content that provides detailed information.",
"identifyingAttributes": {
"key": "value",
"nested": {
"data": 123
}
},
"descriptiveAttributes": {
"key": "value",
"nested": {
"data": 123
}
},
"labels": {
"key": "value",
"nested": {
"data": 123
}
},
"resourceType": "Example Text",
"resourceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"firstSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"inventoryStatus": "Example Text",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"archivedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"deletedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.