Asset Status Resource¶
Get Asset Status¶
HTTP Request
GET /api/assetStatus/{id}
📋 Description: Retrieves the current status of a specific asset identified by the unique asset ID, providing essential insights for asset management and operational decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "assetStatusType": "string",
10 "isDefaultType": true
11}
Update Asset Status¶
HTTP Request
PUT /api/assetStatus/{id}
📋 Description: Updates the status of a specific asset identified by its unique ID, enabling organizations to maintain accurate asset records and optimize operational efficiency.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated asset status information, including relevant attributes and metadata for the specified asset ID. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "assetStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Asset Status¶
HTTP Request
DELETE /api/assetStatus/{id}
📋 Description: Deletes the specified asset status identified by the unique ID, ensuring the removal of outdated or irrelevant asset information from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Asset Status¶
HTTP Request
GET /api/assetStatus
📋 Description: Fetches the current status of assets within the organization, providing insights into asset performance and availability for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
isAvailable |
query |
boolean |
false |
Whether the resource is available |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
isAvailable |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "isDefault": true,
9 "objectAvailable": true,
10 "assetStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the current status of an asset within the organization, including relevant metadata to facilitate tracking and management in asset lifecycle processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the organization. |
» assetStatusType |
string |
false |
none |
Type of the asset status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Asset Status¶
HTTP Request
POST /api/assetStatus
📋 Description: Submits the current status of an asset for tracking and management purposes, enabling organizations to maintain accurate records and optimize asset utilization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the asset status update information, including asset identifiers and current status details. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "assetStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Asset Status Type¶
HTTP Request
GET /api/assetStatus/assetStatusType
📋 Description: Retrieves the available asset status types, providing essential information for effective asset management and reporting.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "READY"
3]