Premise Resource¶
Get All Premise¶
HTTP Request
GET /api/premises
📋 Description: Retrieves a list of premises, providing essential details for effective space management and operational planning.
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 "premiseName": "string",
8 "description": "string",
9 "address": "string",
10 "internalTeamNames": [
11 "string"
12 ],
13 "internalTeamIds": [
14 0
15 ],
16 "premiseAvailable": true,
17 "premiseFromNrm": true,
18 "nlmId": 0,
19 "nlmDisplayId": "string",
20 "nlmUsed": true,
21 "manager": 0,
22 "managerName": "string",
23 "imageId": 0,
24 "area": "string",
25 "modifiedAt": "2019-08-24T14:15:22Z"
26 }
27]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning.] |
|
» 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 |
» premiseName |
string |
false |
none |
Name of the premise |
» description |
string |
false |
none |
Description of the resource |
» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
» managerName |
string |
false |
none |
Name of the manager |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Create Premise¶
HTTP Request
POST /api/premises
📋 Description: Creates a new premises entry in the system, allowing businesses to effectively manage and track their physical locations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the premises to be added, including address, type, and associated business information. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "premiseName": "string",
7 "description": "string",
8 "address": "string",
9 "internalTeamNames": [
10 "string"
11 ],
12 "internalTeamIds": [
13 0
14 ],
15 "premiseAvailable": true,
16 "premiseFromNrm": true,
17 "nlmId": 0,
18 "nlmDisplayId": "string",
19 "nlmUsed": true,
20 "manager": 0,
21 "managerName": "string",
22 "imageId": 0,
23 "area": "string",
24 "modifiedAt": "2019-08-24T14:15:22Z"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "premiseName": "string",
7 "description": "string",
8 "address": "string",
9 "internalTeamNames": [
10 "string"
11 ],
12 "internalTeamIds": [
13 0
14 ],
15 "premiseAvailable": true,
16 "premiseFromNrm": true,
17 "nlmId": 0,
18 "nlmDisplayId": "string",
19 "nlmUsed": true,
20 "manager": 0,
21 "managerName": "string",
22 "imageId": 0,
23 "area": "string",
24 "modifiedAt": "2019-08-24T14:15:22Z"
25}
Search User Workload By Premises ID¶
HTTP Request
POST /api/premises/{premisesId}/workload
📋 Description: Creates a new workload entry for the specified premises, enabling effective management and allocation of resources to meet operational demands.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premisesId |
path |
integer(int64) |
true |
Unique identifier for the premises |
pageable |
query |
true |
Indicates whether the response should be paginated, allowing for efficient retrieval of workload data associated with the specified premises. |
|
body |
body |
true |
Request body containing the workload allocation details for the specified premises, including resource requirements and scheduling information. |
Body Parameters
1{
2 "userNameLike": "string"
3}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "userName": "string",
23 "totalWorkOrderCount": 0,
24 "reactiveWorkOrderCount": 0,
25 "preventativeWorkOrderCount": 0,
26 "dueTodayWorkOrderCount": 0,
27 "totalInspectionCount": 0,
28 "assetInspectionCount": 0,
29 "facilityInspectionCount": 0,
30 "totalWorkloadCount": 0
31 }
32 ],
33 "number": 0,
34 "sort": {
35 "unsorted": true,
36 "sorted": true,
37 "empty": true
38 },
39 "empty": true
40}
Get Premise¶
HTTP Request
GET /api/premises/{id}
📋 Description: Fetches detailed information about a specific premises identified by the provided ID, enabling users to access essential data for 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 "premiseName": "string",
7 "description": "string",
8 "address": "string",
9 "internalTeamNames": [
10 "string"
11 ],
12 "internalTeamIds": [
13 0
14 ],
15 "premiseAvailable": true,
16 "premiseFromNrm": true,
17 "nlmId": 0,
18 "nlmDisplayId": "string",
19 "nlmUsed": true,
20 "manager": 0,
21 "managerName": "string",
22 "imageId": 0,
23 "area": "string",
24 "modifiedAt": "2019-08-24T14:15:22Z"
25}
Update Premise¶
HTTP Request
POST /api/premises/{id}
📋 Description: Updates the details of a specific premises identified by the provided ID, allowing for efficient management of property-related information within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated premises information, including attributes such as address, contact details, and operational status. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "premiseName": "string",
7 "description": "string",
8 "address": "string",
9 "internalTeamNames": [
10 "string"
11 ],
12 "internalTeamIds": [
13 0
14 ],
15 "premiseAvailable": true,
16 "premiseFromNrm": true,
17 "nlmId": 0,
18 "nlmDisplayId": "string",
19 "nlmUsed": true,
20 "manager": 0,
21 "managerName": "string",
22 "imageId": 0,
23 "area": "string",
24 "modifiedAt": "2019-08-24T14:15:22Z"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Premise¶
HTTP Request
DELETE /api/premises/{id}
📋 Description: Deletes a specified premises record from the system, ensuring that outdated or unnecessary data is effectively 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 |
Attach Work Orders To Premises¶
HTTP Request
POST /api/premises/{id}/workOrders/{workOrderId}
📋 Description: Creates a new work order for the specified premises, enabling efficient management of maintenance and service requests.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Work Order To Premises¶
HTTP Request
DELETE /api/premises/{id}/workOrders/{workOrderId}
📋 Description: Deletes a specific work order associated with a designated premise, facilitating the management and maintenance of operational tasks within the premises.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Assign Vendor To Premise¶
HTTP Request
POST /api/premises/{id}/vendors/{vendorId}
📋 Description: Adds a new vendor to the specified premises, enabling enhanced management of vendor relationships and services associated with that location.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
vendorId |
path |
integer(int64) |
true |
Unique identifier for the vendor |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Vendor From Premise¶
HTTP Request
DELETE /api/premises/{id}/vendors/{vendorId}
📋 Description: Deletes a specified vendor from a designated premises, ensuring that vendor-related data is removed from the system to maintain accurate records and streamline operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
vendorId |
path |
integer(int64) |
true |
Unique identifier for the vendor |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search Repremises¶
HTTP Request
POST /api/premises/searchREPremises
📋 Description: Submits a search request for real estate premises, enabling users to find and evaluate available properties based on specified criteria.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results for real estate premises should be returned in a paginated format, enhancing the user experience by allowing for manageable data retrieval. |
|
body |
body |
true |
Request body containing search criteria and filters for retrieving real estate premises information relevant to business operations. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "premiseAvailable": true,
10 "premiseNameLike": "string",
11 "premiseAddressLike": "string",
12 "premiseManagerLike": "string",
13 "attachToVendorIdIn": [
14 0
15 ],
16 "attachToVendorIdNotIn": [
17 0
18 ],
19 "internalTeamIdsIn": [
20 0
21 ]
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "premiseName": "string",
27 "description": "string",
28 "address": "string",
29 "internalTeamNames": [
30 "string"
31 ],
32 "internalTeamIds": [
33 0
34 ],
35 "premiseAvailable": true,
36 "premiseFromNrm": true,
37 "nlmId": 0,
38 "nlmDisplayId": "string",
39 "nlmUsed": true,
40 "manager": 0,
41 "managerName": "string",
42 "imageId": 0,
43 "area": "string",
44 "modifiedAt": "2019-08-24T14:15:22Z"
45 }
46 ],
47 "number": 0,
48 "sort": {
49 "unsorted": true,
50 "sorted": true,
51 "empty": true
52 },
53 "empty": true
54}
Search Premises With Filter¶
HTTP Request
POST /api/premises/searchFilter
📋 Description: Submits a search request to filter premises based on specified criteria, enabling users to efficiently locate and manage relevant properties within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results should be returned in a paginated format, facilitating efficient data retrieval for large datasets. |
|
body |
body |
true |
Request body containing search filter criteria for premises, including parameters such as location, size, and type to refine search results effectively. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "premiseAvailable": true,
10 "premiseNameLike": "string",
11 "premiseAddressLike": "string",
12 "premiseManagerLike": "string",
13 "attachToVendorIdIn": [
14 0
15 ],
16 "attachToVendorIdNotIn": [
17 0
18 ],
19 "internalTeamIdsIn": [
20 0
21 ]
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "premiseName": "string",
27 "description": "string",
28 "address": "string",
29 "internalTeamNames": [
30 "string"
31 ],
32 "internalTeamIds": [
33 0
34 ],
35 "premiseAvailable": true,
36 "premiseFromNrm": true,
37 "nlmId": 0,
38 "nlmDisplayId": "string",
39 "nlmUsed": true,
40 "manager": 0,
41 "managerName": "string",
42 "imageId": 0,
43 "area": "string",
44 "modifiedAt": "2019-08-24T14:15:22Z"
45 }
46 ],
47 "number": 0,
48 "sort": {
49 "unsorted": true,
50 "sorted": true,
51 "empty": true
52 },
53 "empty": true
54}
Get All My Premises¶
HTTP Request
GET /api/premises/myPremises
📋 Description: Retrieves a list of premises associated with the authenticated user, providing essential information for effective management and oversight of their properties.
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 "premiseName": "string",
8 "description": "string",
9 "address": "string",
10 "internalTeamNames": [
11 "string"
12 ],
13 "internalTeamIds": [
14 0
15 ],
16 "premiseAvailable": true,
17 "premiseFromNrm": true,
18 "nlmId": 0,
19 "nlmDisplayId": "string",
20 "nlmUsed": true,
21 "manager": 0,
22 "managerName": "string",
23 "imageId": 0,
24 "area": "string",
25 "modifiedAt": "2019-08-24T14:15:22Z"
26 }
27]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning.] |
|
» 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 |
» premiseName |
string |
false |
none |
Name of the premise |
» description |
string |
false |
none |
Description of the resource |
» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
» managerName |
string |
false |
none |
Name of the manager |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |