Sub Asset Resource¶
Get Sub Asset¶
HTTP Request
GET /api/subAssets/{id}
📋 Description: Retrieves detailed information about a specific sub-asset identified by its unique ID, enabling users to access essential data for effective asset management and 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 "description": "string",
8 "qrCode": "string",
9 "assetParts": [
10 0
11 ],
12 "mainAsset": 0,
13 "subAssets": [
14 0
15 ],
16 "parentAsset": 0
17}
Update Sub Asset¶
HTTP Request
PUT /api/subAssets/{id}
📋 Description: Updates the details of a specified sub-asset, allowing for modifications to its attributes to ensure accurate asset management and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated sub-asset information, including attributes such as name, description, and status, essential for maintaining accurate asset management records. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "qrCode": "string",
9 "assetParts": [
10 0
11 ],
12 "mainAsset": 0,
13 "subAssets": [
14 0
15 ],
16 "parentAsset": 0
17}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Sub Asset¶
HTTP Request
DELETE /api/subAssets/{id}
📋 Description: Deletes a specified sub-asset from the system, ensuring that all associated data is permanently removed to maintain data integrity and compliance.
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 Sub Assets¶
HTTP Request
GET /api/subAssets
📋 Description: Retrieves a list of sub-assets associated with the primary assets, enabling users to efficiently manage and analyze asset performance and allocation.
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 "description": "string",
9 "qrCode": "string",
10 "assetParts": [
11 0
12 ],
13 "mainAsset": 0,
14 "subAssets": [
15 0
16 ],
17 "parentAsset": 0
18 }
19]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a sub-asset within a larger asset management framework, encapsulating key attributes and metadata essential for tracking and managing asset performance and compliance.] |
|
» 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 |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» qrCode |
string |
false |
none |
Code for the qr |
» assetParts |
[integer] |
false |
none |
An array of sub-assets that collectively represent the components of a primary asset, facilitating detailed asset management and tracking. |
» mainAsset |
integer(int64) |
false |
none |
Unique identifier for the primary asset associated with the sub-asset, facilitating efficient asset management and tracking within the system. |
» subAssets |
[integer] |
false |
none |
An array of sub-assets associated with the primary asset, providing detailed information for comprehensive asset management. |
» parentAsset |
integer(int64) |
false |
none |
Unique identifier for the parent asset associated with the sub-asset, facilitating hierarchical asset management. |
Create Sub Asset¶
HTTP Request
POST /api/subAssets
📋 Description: Creates a new sub-asset within the system, enabling efficient management and categorization of assets for enhanced operational oversight.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing detailed information about the sub-assets, including identifiers, attributes, and associated metadata necessary for effective asset management. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "qrCode": "string",
9 "assetParts": [
10 0
11 ],
12 "mainAsset": 0,
13 "subAssets": [
14 0
15 ],
16 "parentAsset": 0
17}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10