Asset

Search Companies

HTTP Request

POST /api/assets/search

📋 Description: Submits a search query to locate specific assets within the system, enabling efficient asset management and retrieval based on user-defined criteria.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the search results for assets should be returned in a paginated format, enhancing the efficiency of data retrieval.

body

body

FosAssetSearchFilter

true

Request body containing search criteria and filters for retrieving asset information based on user-defined parameters.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "nameLike": "string",
29  "usefulLifeYearsLike": "string",
30  "usefulLifePeriodsLike": "string",
31  "scrapValueLike": "string",
32  "quantityLike": "string",
33  "agreementNumberLike": "string",
34  "companyIdEqual": 0,
35  "companyDisplayIdLike": "string",
36  "assetClassIdEqual": 0,
37  "assetClassDisplayIdLike": "string",
38  "locationIdEqual": 0,
39  "locationDisplayIdLike": "string",
40  "searchTerm": "string"
41}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageAssetDto

Example Responses

 1{
 2  "totalPages": 0,
 3  "totalElements": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "first": true,
18  "last": true,
19  "size": 0,
20  "content": [
21    {
22      "id": 0,
23      "status": "CREATED",
24      "displayId": "string",
25      "erpSystemId": 0,
26      "erpSystemDisplayId": "string",
27      "name": "string",
28      "usefulLifeYears": 0,
29      "usefulLifePeriods": 0,
30      "scrapValue": 0,
31      "quantity": 0,
32      "agreementNumber": "string",
33      "companyId": 0,
34      "companyDisplayId": "string",
35      "assetClassId": 0,
36      "assetClassDisplayId": "string",
37      "locationId": 0,
38      "locationDisplayId": "string"
39    }
40  ],
41  "number": 0,
42  "sort": {
43    "unsorted": true,
44    "sorted": true,
45    "empty": true
46  },
47  "empty": true
48}

Get Asset

HTTP Request

GET /api/assets/{id}

📋 Description: Fetches detailed information about a specific asset identified by the unique asset ID, enabling users to access critical data for 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

OK

AssetDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "usefulLifeYears": 0,
 9  "usefulLifePeriods": 0,
10  "scrapValue": 0,
11  "quantity": 0,
12  "agreementNumber": "string",
13  "companyId": 0,
14  "companyDisplayId": "string",
15  "assetClassId": 0,
16  "assetClassDisplayId": "string",
17  "locationId": 0,
18  "locationDisplayId": "string"
19}