4.5 Working With Asset Statuses
- Laura McWilliams
URL: https://MyIsoraURL/api/assetstatuses
Verb | Address | Notes | Additional Details |
|---|---|---|---|
GET | /assetstatuses | Returns a count of existing asset statuses, along with a list of them. | Use the list retrieved to obtain object ids for existing asset status objects. |
GET | /assetstatuses?search=string | Returns any asset statuses matching the search string. |
|
GET | /assetstatus/<status id> | Retrieves information about an individual asset status. If an invalid id is given, a “Not found” error is returned. | The format of the returned object is: {
"uuid": "object id string",
"code": "alphanumeric code",
"name": "string that shows up in the UI",
"description": "detailed description",
"active": true|false,*
"assets": null*
}*These fields currently do nothing. |
POST | /assetstatuses | Creates a new asset status. The new asset status object is returned. | body { “code”: “string with no hyphens”, “name”: “string”, “description”: “string” }
|
PUT | /assetstatuses/<status id> | Updates (replaces) an existing asset status. Returns the updated object. | body { “code”: “string with no hyphens”, “name”: “string”, “description”: “string”* } *The description is optional and if omitted, the old description will be unchanged. |
PATCH | /assetstatuses/<status id> | Similar to PUT command, but allows you to update one (or more) fields instead of replacing the entire asset status object. Returns the updated object. | Cannot PATCH a managed asset status. Updates only the fields specified. ex: { “description”: “new and improved description string” } |
DELETE | /assetstatuses/<status id> | Removes the asset status. No content is returned. | Cannot DELETE a managed asset status. |
Currently asset statuses are only applicable to vendor products.