Internal Team Resource¶
Get All Internal Teams¶
HTTP Request
GET /api/internalTeams
📋 Description: Retrieves a list of internal teams within the organization, providing insights into team structures and facilitating resource allocation and collaboration.
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 "email": "string",
9 "phone": "string",
10 "manager": "string",
11 "requestCategoryName": [
12 "string"
13 ],
14 "requestCategoryId": [
15 0
16 ],
17 "requestCategoryDisplayId": [
18 "string"
19 ],
20 "description": "string",
21 "internalTeamUser": [
22 0
23 ],
24 "members": 0,
25 "mainAssets": [
26 0
27 ],
28 "premiseNames": [
29 "string"
30 ],
31 "internalTeamAvailable": true,
32 "premiseIds": [
33 0
34 ]
35 }
36]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an internal team within the organization, encapsulating essential details such as team members, roles, and operational objectives to facilitate effective collaboration and resource allocation.] |
|
» 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 |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
» requestCategoryName |
[string] |
false |
none |
Name of the request category |
» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
» description |
string |
false |
none |
Description of the resource |
» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
Create Internal Team¶
HTTP Request
POST /api/internalTeams
📋 Description: Creates a new internal team within the organization, enabling streamlined collaboration and resource allocation across departments.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the internal team, including team name, members, roles, and relevant metadata for organizational alignment. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "email": "string",
8 "phone": "string",
9 "manager": "string",
10 "requestCategoryName": [
11 "string"
12 ],
13 "requestCategoryId": [
14 0
15 ],
16 "requestCategoryDisplayId": [
17 "string"
18 ],
19 "description": "string",
20 "internalTeamUser": [
21 0
22 ],
23 "members": 0,
24 "mainAssets": [
25 0
26 ],
27 "premiseNames": [
28 "string"
29 ],
30 "internalTeamAvailable": true,
31 "premiseIds": [
32 0
33 ]
34}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get Internal Team¶
HTTP Request
GET /api/internalTeams/{id}
📋 Description: Retrieves detailed information about a specific internal team identified by the provided ID, facilitating insights into team structure and resource allocation.
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 "email": "string",
8 "phone": "string",
9 "manager": "string",
10 "requestCategoryName": [
11 "string"
12 ],
13 "requestCategoryId": [
14 0
15 ],
16 "requestCategoryDisplayId": [
17 "string"
18 ],
19 "description": "string",
20 "internalTeamUser": [
21 0
22 ],
23 "members": 0,
24 "mainAssets": [
25 0
26 ],
27 "premiseNames": [
28 "string"
29 ],
30 "internalTeamAvailable": true,
31 "premiseIds": [
32 0
33 ]
34}
Update Internal Team¶
HTTP Request
POST /api/internalTeams/{id}
📋 Description: Updates the details of an internal team identified by the specified ID, enabling organizations to maintain accurate and current team information.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the internal team details, including name, description, and member roles, necessary for updating team information. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "email": "string",
8 "phone": "string",
9 "manager": "string",
10 "requestCategoryName": [
11 "string"
12 ],
13 "requestCategoryId": [
14 0
15 ],
16 "requestCategoryDisplayId": [
17 "string"
18 ],
19 "description": "string",
20 "internalTeamUser": [
21 0
22 ],
23 "members": 0,
24 "mainAssets": [
25 0
26 ],
27 "premiseNames": [
28 "string"
29 ],
30 "internalTeamAvailable": true,
31 "premiseIds": [
32 0
33 ]
34}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Internal Team¶
HTTP Request
DELETE /api/internalTeams/{id}
📋 Description: Deletes the specified internal team from the system, ensuring that all associated resources are appropriately managed and removed.
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 |
Attch User To Internal Team¶
HTTP Request
POST /api/internalTeams/{id}/user/{userId}
📋 Description: Adds a specified user to the internal team identified by the given team ID, facilitating team collaboration and resource management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach User To Internal Team¶
HTTP Request
DELETE /api/internalTeams/{id}/user/{userId}
📋 Description: Removes a specified user from an internal team, ensuring streamlined team management and resource allocation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Internal Teams¶
HTTP Request
POST /api/internalTeams/search
📋 Description: Submits a search request for internal teams, enabling users to efficiently locate and retrieve relevant team information based on specified criteria.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results should be returned in a paginated format, enhancing the efficiency of data retrieval for internal team searches. |
|
body |
body |
true |
Request body containing search criteria and filters for internal teams, enabling efficient retrieval of relevant team information. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "nameLike": "string",
9 "internalTeamAvailable": true,
10 "premiseIdEqualOrNull": 0
11}
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 "name": "string",
27 "email": "string",
28 "phone": "string",
29 "manager": "string",
30 "requestCategoryName": [
31 "string"
32 ],
33 "requestCategoryId": [
34 0
35 ],
36 "requestCategoryDisplayId": [
37 "string"
38 ],
39 "description": "string",
40 "internalTeamUser": [
41 0
42 ],
43 "members": 0,
44 "mainAssets": [
45 0
46 ],
47 "premiseNames": [
48 "string"
49 ],
50 "internalTeamAvailable": true,
51 "premiseIds": [
52 0
53 ]
54 }
55 ],
56 "number": 0,
57 "sort": {
58 "unsorted": true,
59 "sorted": true,
60 "empty": true
61 },
62 "empty": true
63}
Get All Users¶
HTTP Request
GET /api/internalTeams/{id}/users
📋 Description: Retrieves a list of users associated with a specific internal team, identified by the provided team ID, to facilitate team management and collaboration.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
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 "userName": "string",
7 "firstName": "string",
8 "lastName": "string",
9 "email": "string",
10 "roleIds": [
11 {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "modifiedBy": "string",
16 "modifiedAt": "2019-08-24T14:15:22Z",
17 "roleName": "string",
18 "entity": "string",
19 "new": true
20 }
21 ],
22 "internalTeamNames": [
23 "string"
24 ],
25 "internalTeamIds": [
26 0
27 ],
28 "internalTeamDisplayIds": [
29 "string"
30 ],
31 "premiseIds": [
32 0
33 ],
34 "premiseNames": [
35 "string"
36 ],
37 "userAvailable": true,
38 "temporaryWorkload": 0,
39 "preferredCultureCode": "string"
40 }
41]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications.] |
|
» 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 |
» userName |
string |
false |
none |
Name of the user |
» firstName |
string |
false |
none |
Name of the first |
» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»» 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 |
»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» roleName |
string |
false |
none |
Name of the role |
»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
Get Internal Team Premises¶
HTTP Request
GET /api/internalTeams/{id}/premises
📋 Description: Fetches the premises associated with a specified internal team, providing essential location details for operational management and resource allocation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
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 |
Get All Main Assets By Internal Team¶
HTTP Request
GET /api/internalTeams/{id}/mainAssets
📋 Description: Retrieves the main assets associated with a specific internal team, identified by the provided team ID, to facilitate effective resource management and allocation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
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 "barCode": "string",
11 "imageId": 0,
12 "model": "string",
13 "manufacturer": "string",
14 "serialNumber": "string",
15 "cost": "81.08",
16 "premiseId": 0,
17 "premiseDisplayId": "string",
18 "premiseDto": {
19 "id": 0,
20 "createdBy": "string",
21 "createdAt": "2019-08-24T14:15:22Z",
22 "displayId": "string",
23 "premiseName": "string",
24 "description": "string",
25 "address": "string",
26 "internalTeamNames": [
27 "string"
28 ],
29 "internalTeamIds": [
30 0
31 ],
32 "premiseAvailable": true,
33 "premiseFromNrm": true,
34 "nlmId": 0,
35 "nlmDisplayId": "string",
36 "nlmUsed": true,
37 "manager": 0,
38 "managerName": "string",
39 "imageId": 0,
40 "area": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z"
42 },
43 "acquisitionDate": "2019-08-24",
44 "endOfLife": "2019-08-24",
45 "assetStatusId": 0,
46 "assetStatus": "string",
47 "assetStatusType": "string",
48 "parentAssetId": 0,
49 "parentAssetDisplayId": "string",
50 "parentAsset": "string",
51 "parentAssetDto": {},
52 "upcomingMaintenanceDate": "2019-08-24",
53 "assetCategoryIds": [
54 0
55 ],
56 "assetCategories": [
57 "string"
58 ],
59 "internalTeamIds": [
60 0
61 ],
62 "internalTeamDtos": [
63 {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "name": "string",
69 "email": "string",
70 "phone": "string",
71 "manager": "string",
72 "requestCategoryName": [
73 "string"
74 ],
75 "requestCategoryId": [
76 0
77 ],
78 "requestCategoryDisplayId": [
79 "string"
80 ],
81 "description": "string",
82 "internalTeamUser": [
83 0
84 ],
85 "members": 0,
86 "mainAssets": [
87 0
88 ],
89 "premiseNames": [
90 "string"
91 ],
92 "internalTeamAvailable": true,
93 "premiseIds": [
94 0
95 ]
96 }
97 ],
98 "internalTeams": [
99 "string"
100 ],
101 "assignedUserIds": [
102 0
103 ],
104 "assignedUserDtos": [
105 {
106 "id": 0,
107 "createdBy": "string",
108 "createdAt": "2019-08-24T14:15:22Z",
109 "userName": "string",
110 "firstName": "string",
111 "lastName": "string",
112 "email": "string",
113 "roleIds": [
114 {
115 "id": 0,
116 "createdBy": "string",
117 "createdAt": "2019-08-24T14:15:22Z",
118 "modifiedBy": "string",
119 "modifiedAt": "2019-08-24T14:15:22Z",
120 "roleName": "string",
121 "entity": "string",
122 "new": true
123 }
124 ],
125 "internalTeamNames": [
126 "string"
127 ],
128 "internalTeamIds": [
129 0
130 ],
131 "internalTeamDisplayIds": [
132 "string"
133 ],
134 "premiseIds": [
135 0
136 ],
137 "premiseNames": [
138 "string"
139 ],
140 "userAvailable": true,
141 "temporaryWorkload": 0,
142 "preferredCultureCode": "string"
143 }
144 ],
145 "assignedUsers": [
146 "string"
147 ],
148 "assetPriority": "string",
149 "assetPriorityId": 0,
150 "assetPriorityDisplayId": "string",
151 "assetPriorityType": "string",
152 "assetAvailable": true,
153 "exactPlacement": "string",
154 "fosId": 0,
155 "downtimeStatus": "string",
156 "premiseFromNrm": true,
157 "modifiedAt": "2019-08-24T14:15:22Z"
158 }
159]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making.] |
|
» 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 |
» barCode |
string |
false |
none |
Code for the bar |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» premiseDto |
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 |
» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
» assetStatus |
string |
false |
none |
Status of the asset |
» assetStatusType |
string |
false |
none |
Type of the asset status |
» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»» 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 |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»» description |
string |
false |
none |
Description of the resource |
»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»» 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 |
»» userName |
string |
false |
none |
Name of the user |
»» firstName |
string |
false |
none |
Name of the first |
»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»» 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 |
»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»» roleName |
string |
false |
none |
Name of the role |
»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
» assetPriority |
string |
false |
none |
Priority of the asset |
» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
» assetPriorityType |
string |
false |
none |
Type of the asset priority |
» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
» downtimeStatus |
string |
false |
none |
Status of the downtime |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Get Main Assets By ID¶
HTTP Request
GET /api/internalTeams/{id}/mainAssets/{mainAssetId}
📋 Description: Fetches the main asset details associated with a specific internal team, identified by the provided team ID and main asset ID, to facilitate effective asset management and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
mainAssetId |
path |
integer(int64) |
true |
Unique identifier for the main asset |
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 "barCode": "string",
10 "imageId": 0,
11 "model": "string",
12 "manufacturer": "string",
13 "serialNumber": "string",
14 "cost": "81.08",
15 "premiseId": 0,
16 "premiseDisplayId": "string",
17 "premiseDto": {
18 "id": 0,
19 "createdBy": "string",
20 "createdAt": "2019-08-24T14:15:22Z",
21 "displayId": "string",
22 "premiseName": "string",
23 "description": "string",
24 "address": "string",
25 "internalTeamNames": [
26 "string"
27 ],
28 "internalTeamIds": [
29 0
30 ],
31 "premiseAvailable": true,
32 "premiseFromNrm": true,
33 "nlmId": 0,
34 "nlmDisplayId": "string",
35 "nlmUsed": true,
36 "manager": 0,
37 "managerName": "string",
38 "imageId": 0,
39 "area": "string",
40 "modifiedAt": "2019-08-24T14:15:22Z"
41 },
42 "acquisitionDate": "2019-08-24",
43 "endOfLife": "2019-08-24",
44 "assetStatusId": 0,
45 "assetStatus": "string",
46 "assetStatusType": "string",
47 "parentAssetId": 0,
48 "parentAssetDisplayId": "string",
49 "parentAsset": "string",
50 "parentAssetDto": {
51 "id": 0,
52 "createdBy": "string",
53 "createdAt": "2019-08-24T14:15:22Z",
54 "displayId": "string",
55 "name": "string",
56 "description": "string",
57 "qrCode": "string",
58 "barCode": "string",
59 "imageId": 0,
60 "model": "string",
61 "manufacturer": "string",
62 "serialNumber": "string",
63 "cost": "81.08",
64 "premiseId": 0,
65 "premiseDisplayId": "string",
66 "premiseDto": {
67 "id": 0,
68 "createdBy": "string",
69 "createdAt": "2019-08-24T14:15:22Z",
70 "displayId": "string",
71 "premiseName": "string",
72 "description": "string",
73 "address": "string",
74 "internalTeamNames": [
75 "string"
76 ],
77 "internalTeamIds": [
78 0
79 ],
80 "premiseAvailable": true,
81 "premiseFromNrm": true,
82 "nlmId": 0,
83 "nlmDisplayId": "string",
84 "nlmUsed": true,
85 "manager": 0,
86 "managerName": "string",
87 "imageId": 0,
88 "area": "string",
89 "modifiedAt": "2019-08-24T14:15:22Z"
90 },
91 "acquisitionDate": "2019-08-24",
92 "endOfLife": "2019-08-24",
93 "assetStatusId": 0,
94 "assetStatus": "string",
95 "assetStatusType": "string",
96 "parentAssetId": 0,
97 "parentAssetDisplayId": "string",
98 "parentAsset": "string",
99 "parentAssetDto": {},
100 "upcomingMaintenanceDate": "2019-08-24",
101 "assetCategoryIds": [
102 0
103 ],
104 "assetCategories": [
105 "string"
106 ],
107 "internalTeamIds": [
108 0
109 ],
110 "internalTeamDtos": [
111 {
112 "id": 0,
113 "createdBy": "string",
114 "createdAt": "2019-08-24T14:15:22Z",
115 "displayId": "string",
116 "name": "string",
117 "email": "string",
118 "phone": "string",
119 "manager": "string",
120 "requestCategoryName": [
121 "string"
122 ],
123 "requestCategoryId": [
124 0
125 ],
126 "requestCategoryDisplayId": [
127 "string"
128 ],
129 "description": "string",
130 "internalTeamUser": [
131 0
132 ],
133 "members": 0,
134 "mainAssets": [
135 0
136 ],
137 "premiseNames": [
138 "string"
139 ],
140 "internalTeamAvailable": true,
141 "premiseIds": [
142 0
143 ]
144 }
145 ],
146 "internalTeams": [
147 "string"
148 ],
149 "assignedUserIds": [
150 0
151 ],
152 "assignedUserDtos": [
153 {
154 "id": 0,
155 "createdBy": "string",
156 "createdAt": "2019-08-24T14:15:22Z",
157 "userName": "string",
158 "firstName": "string",
159 "lastName": "string",
160 "email": "string",
161 "roleIds": [
162 {
163 "id": 0,
164 "createdBy": "string",
165 "createdAt": "2019-08-24T14:15:22Z",
166 "modifiedBy": "string",
167 "modifiedAt": "2019-08-24T14:15:22Z",
168 "roleName": "string",
169 "entity": "string",
170 "new": true
171 }
172 ],
173 "internalTeamNames": [
174 "string"
175 ],
176 "internalTeamIds": [
177 0
178 ],
179 "internalTeamDisplayIds": [
180 "string"
181 ],
182 "premiseIds": [
183 0
184 ],
185 "premiseNames": [
186 "string"
187 ],
188 "userAvailable": true,
189 "temporaryWorkload": 0,
190 "preferredCultureCode": "string"
191 }
192 ],
193 "assignedUsers": [
194 "string"
195 ],
196 "assetPriority": "string",
197 "assetPriorityId": 0,
198 "assetPriorityDisplayId": "string",
199 "assetPriorityType": "string",
200 "assetAvailable": true,
201 "exactPlacement": "string",
202 "fosId": 0,
203 "downtimeStatus": "string",
204 "premiseFromNrm": true,
205 "modifiedAt": "2019-08-24T14:15:22Z"
206 },
207 "upcomingMaintenanceDate": "2019-08-24",
208 "assetCategoryIds": [
209 0
210 ],
211 "assetCategories": [
212 "string"
213 ],
214 "internalTeamIds": [
215 0
216 ],
217 "internalTeamDtos": [
218 {
219 "id": 0,
220 "createdBy": "string",
221 "createdAt": "2019-08-24T14:15:22Z",
222 "displayId": "string",
223 "name": "string",
224 "email": "string",
225 "phone": "string",
226 "manager": "string",
227 "requestCategoryName": [
228 "string"
229 ],
230 "requestCategoryId": [
231 0
232 ],
233 "requestCategoryDisplayId": [
234 "string"
235 ],
236 "description": "string",
237 "internalTeamUser": [
238 0
239 ],
240 "members": 0,
241 "mainAssets": [
242 0
243 ],
244 "premiseNames": [
245 "string"
246 ],
247 "internalTeamAvailable": true,
248 "premiseIds": [
249 0
250 ]
251 }
252 ],
253 "internalTeams": [
254 "string"
255 ],
256 "assignedUserIds": [
257 0
258 ],
259 "assignedUserDtos": [
260 {
261 "id": 0,
262 "createdBy": "string",
263 "createdAt": "2019-08-24T14:15:22Z",
264 "userName": "string",
265 "firstName": "string",
266 "lastName": "string",
267 "email": "string",
268 "roleIds": [
269 {
270 "id": 0,
271 "createdBy": "string",
272 "createdAt": "2019-08-24T14:15:22Z",
273 "modifiedBy": "string",
274 "modifiedAt": "2019-08-24T14:15:22Z",
275 "roleName": "string",
276 "entity": "string",
277 "new": true
278 }
279 ],
280 "internalTeamNames": [
281 "string"
282 ],
283 "internalTeamIds": [
284 0
285 ],
286 "internalTeamDisplayIds": [
287 "string"
288 ],
289 "premiseIds": [
290 0
291 ],
292 "premiseNames": [
293 "string"
294 ],
295 "userAvailable": true,
296 "temporaryWorkload": 0,
297 "preferredCultureCode": "string"
298 }
299 ],
300 "assignedUsers": [
301 "string"
302 ],
303 "assetPriority": "string",
304 "assetPriorityId": 0,
305 "assetPriorityDisplayId": "string",
306 "assetPriorityType": "string",
307 "assetAvailable": true,
308 "exactPlacement": "string",
309 "fosId": 0,
310 "downtimeStatus": "string",
311 "premiseFromNrm": true,
312 "modifiedAt": "2019-08-24T14:15:22Z"
313}