Supplier Resource¶
Get All Supplier¶
HTTP Request
GET /api/suppliers
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches a list of suppliers, providing essential details to support procurement and supplier management processes.
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 "name": "string",
7 "address": "string",
8 "status": "ACTIVE",
9 "assetCategories": [
10 {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "objectAvailable": true
17 }
18 ],
19 "supplierContacts": [
20 {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "name": "string",
25 "designation": "string",
26 "phone": "string",
27 "email": "string",
28 "supplierId": 0,
29 "supplierContactAvailable": true
30 }
31 ],
32 "documents": [
33 {
34 "id": 0,
35 "createdBy": "string",
36 "createdAt": "2019-08-24T14:15:22Z",
37 "name": "string",
38 "contentType": "string",
39 "documentTypeName": "string",
40 "documentTypeId": 0,
41 "description": "string",
42 "data": "string",
43 "startDate": "2019-08-24",
44 "endDate": "2019-08-24",
45 "documentStatusId": 0,
46 "documentStatus": "string",
47 "documentStatusType": "string",
48 "parentEntityId": 0,
49 "link": "string",
50 "parentEntityName": "string"
51 }
52 ],
53 "assetParts": [
54 {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "imageId": 0,
62 "premiseId": 0,
63 "premiseDisplayId": "string",
64 "premiseDto": {
65 "id": 0,
66 "createdBy": "string",
67 "createdAt": "2019-08-24T14:15:22Z",
68 "displayId": "string",
69 "premiseName": "string",
70 "description": "string",
71 "address": "string",
72 "internalTeamNames": [
73 "string"
74 ],
75 "internalTeamIds": [
76 0
77 ],
78 "premiseAvailable": true,
79 "premiseFromNrm": true,
80 "nlmId": 0,
81 "nlmDisplayId": "string",
82 "nlmUsed": true,
83 "manager": 0,
84 "managerName": "string",
85 "imageId": 0,
86 "area": "string",
87 "modifiedAt": "2019-08-24T14:15:22Z"
88 },
89 "premiseFromNrm": true,
90 "model": "string",
91 "unitCost": "67.08",
92 "serialNumber": "string",
93 "qrCode": "string",
94 "quantityOnHand": 0,
95 "reOrderPoint": 0,
96 "size": "string",
97 "color": "string",
98 "weight": "24.08",
99 "length": "11.5",
100 "width": "16.9",
101 "height": "12.3",
102 "materialType": "string",
103 "assetPartType": "string",
104 "assetPartTypeId": 0,
105 "assetPartManufacturer": {
106 "id": 0,
107 "createdBy": "string",
108 "createdAt": "2019-08-24T14:15:22Z",
109 "name": "string",
110 "assetParts": [
111 {}
112 ]
113 },
114 "variableQuantity": 0,
115 "assetPartAvailable": true,
116 "owner": 0,
117 "ownerDto": {
118 "id": 0,
119 "createdBy": "string",
120 "createdAt": "2019-08-24T14:15:22Z",
121 "userName": "string",
122 "firstName": "string",
123 "lastName": "string",
124 "email": "string",
125 "roleIds": [
126 {
127 "id": 0,
128 "createdBy": "string",
129 "createdAt": "2019-08-24T14:15:22Z",
130 "modifiedBy": "string",
131 "modifiedAt": "2019-08-24T14:15:22Z",
132 "roleName": "string",
133 "entity": "string",
134 "new": true
135 }
136 ],
137 "internalTeamNames": [
138 "string"
139 ],
140 "internalTeamIds": [
141 0
142 ],
143 "internalTeamDisplayIds": [
144 "string"
145 ],
146 "premiseIds": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "userAvailable": true,
153 "temporaryWorkload": 0,
154 "preferredCultureCode": "string"
155 },
156 "ownerUserName": "string",
157 "modifiedAt": "2019-08-24T14:15:22Z",
158 "isPartsSufficient": true
159 }
160 ],
161 "mainAssets": [
162 {
163 "id": 0,
164 "createdBy": "string",
165 "createdAt": "2019-08-24T14:15:22Z",
166 "displayId": "string",
167 "name": "string",
168 "description": "string",
169 "qrCode": "string",
170 "barCode": "string",
171 "imageId": 0,
172 "model": "string",
173 "manufacturer": "string",
174 "serialNumber": "string",
175 "cost": "81.08",
176 "premiseId": 0,
177 "premiseDisplayId": "string",
178 "premiseDto": {
179 "id": 0,
180 "createdBy": "string",
181 "createdAt": "2019-08-24T14:15:22Z",
182 "displayId": "string",
183 "premiseName": "string",
184 "description": "string",
185 "address": "string",
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "premiseAvailable": true,
193 "premiseFromNrm": true,
194 "nlmId": 0,
195 "nlmDisplayId": "string",
196 "nlmUsed": true,
197 "manager": 0,
198 "managerName": "string",
199 "imageId": 0,
200 "area": "string",
201 "modifiedAt": "2019-08-24T14:15:22Z"
202 },
203 "acquisitionDate": "2019-08-24",
204 "endOfLife": "2019-08-24",
205 "assetStatusId": 0,
206 "assetStatus": "string",
207 "assetStatusType": "string",
208 "parentAssetId": 0,
209 "parentAssetDisplayId": "string",
210 "parentAsset": "string",
211 "parentAssetDto": {},
212 "upcomingMaintenanceDate": "2019-08-24",
213 "assetCategoryIds": [
214 0
215 ],
216 "assetCategories": [
217 "string"
218 ],
219 "internalTeamIds": [
220 0
221 ],
222 "internalTeamDtos": [
223 {
224 "id": 0,
225 "createdBy": "string",
226 "createdAt": "2019-08-24T14:15:22Z",
227 "displayId": "string",
228 "name": "string",
229 "email": "string",
230 "phone": "string",
231 "manager": "string",
232 "requestCategoryName": [
233 "string"
234 ],
235 "requestCategoryId": [
236 0
237 ],
238 "requestCategoryDisplayId": [
239 "string"
240 ],
241 "description": "string",
242 "internalTeamUser": [
243 0
244 ],
245 "members": 0,
246 "mainAssets": [
247 0
248 ],
249 "premiseNames": [
250 "string"
251 ],
252 "internalTeamAvailable": true,
253 "premiseIds": [
254 0
255 ]
256 }
257 ],
258 "internalTeams": [
259 "string"
260 ],
261 "assignedUserIds": [
262 0
263 ],
264 "assignedUserDtos": [
265 {
266 "id": 0,
267 "createdBy": "string",
268 "createdAt": "2019-08-24T14:15:22Z",
269 "userName": "string",
270 "firstName": "string",
271 "lastName": "string",
272 "email": "string",
273 "roleIds": [
274 {
275 "id": 0,
276 "createdBy": "string",
277 "createdAt": "2019-08-24T14:15:22Z",
278 "modifiedBy": "string",
279 "modifiedAt": "2019-08-24T14:15:22Z",
280 "roleName": "string",
281 "entity": "string",
282 "new": true
283 }
284 ],
285 "internalTeamNames": [
286 "string"
287 ],
288 "internalTeamIds": [
289 0
290 ],
291 "internalTeamDisplayIds": [
292 "string"
293 ],
294 "premiseIds": [
295 0
296 ],
297 "premiseNames": [
298 "string"
299 ],
300 "userAvailable": true,
301 "temporaryWorkload": 0,
302 "preferredCultureCode": "string"
303 }
304 ],
305 "assignedUsers": [
306 "string"
307 ],
308 "assetPriority": "string",
309 "assetPriorityId": 0,
310 "assetPriorityDisplayId": "string",
311 "assetPriorityType": "string",
312 "assetAvailable": true,
313 "exactPlacement": "string",
314 "fosId": 0,
315 "downtimeStatus": "string",
316 "premiseFromNrm": true,
317 "modifiedAt": "2019-08-24T14:15:22Z"
318 }
319 ],
320 "supplierAvailable": true
321 }
322]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a supplier’s essential information, including contact details, business classification, and compliance status, to facilitate efficient vendor management and procurement 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 |
» name |
string |
false |
none |
Name of the resource |
» address |
string |
false |
none |
Represents the physical location of the supplier, essential for logistics and communication purposes. |
» status |
string |
false |
none |
Status of the resource |
» assetCategories |
false |
none |
Array of asset categories associated with the supplier, facilitating the classification and management of supplier-related assets. |
|
»» 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 |
»» objectAvailable |
boolean |
false |
none |
Indicates whether the asset category is currently available for allocation within the system. |
» supplierContacts |
false |
none |
An array of contact details for suppliers, facilitating effective communication and relationship management within the supply chain. |
|
»» 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 |
»» name |
string |
false |
none |
Name of the resource |
»» designation |
string |
false |
none |
Represents the job title or role of the contact person associated with the supplier, facilitating effective communication and relationship management. |
»» phone |
string |
false |
none |
Contact phone number for the supplier, used to facilitate communication and coordination. |
string |
false |
none |
Email address of the supplier contact, used for communication and correspondence related to supplier management. |
|
»» supplierId |
integer(int64) |
false |
none |
Unique identifier for the supplier |
»» supplierContactAvailable |
boolean |
false |
none |
Indicates whether a contact person for the supplier is available, facilitating effective communication and relationship management. |
» documents |
false |
none |
An array of SupplierDTO objects representing the documents associated with the supplier, essential for managing supplier-related information 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 |
»» name |
string |
false |
none |
Name of the resource |
»» contentType |
string |
false |
none |
Type of the content |
»» documentTypeName |
string |
false |
none |
Name of the document type |
»» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
»» description |
string |
false |
none |
Description of the resource |
»» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
»» documentStatus |
string |
false |
none |
Status of the document |
»» documentStatusType |
string |
false |
none |
Type of the document status |
»» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
»» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
»» parentEntityName |
string |
true |
none |
Name of the parent entity |
» assetParts |
false |
none |
Array of SupplierDTO objects representing the individual components or parts associated with an asset, facilitating comprehensive asset management and supplier collaboration. |
|
»» 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 |
»» description |
string |
false |
none |
Description of the resource |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» 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 |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset part originates from the National Resource Management (NRM) framework, facilitating compliance and reporting requirements. |
»» model |
string |
false |
none |
Represents the specific model associated with the asset part, facilitating accurate identification and management within the system. |
»» unitCost |
string |
false |
none |
Represents the cost per unit of the asset part, essential for accurate budgeting and financial analysis within asset management. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset part, facilitating efficient tracking and management within the asset management system. |
»» qrCode |
string |
false |
none |
Code for the qr |
»» quantityOnHand |
integer(int64) |
false |
none |
Represents the current inventory level of the asset part, indicating the quantity available for use or sale. |
»» reOrderPoint |
integer(int64) |
false |
none |
Reorder point indicates the inventory level at which new stock should be ordered to prevent stockouts and ensure continuous availability of asset parts. |
»» size |
string |
false |
none |
Number of items per page |
»» color |
string |
false |
none |
Represents the color attribute associated with the asset part, providing essential visual differentiation for inventory management and asset tracking. |
»» weight |
string |
false |
none |
Represents the weight of the asset part, providing essential information for inventory management and logistics optimization. |
»» length |
string |
false |
none |
Specifies the length of the asset part, providing essential information for inventory management and resource allocation. |
»» width |
string |
false |
none |
Specifies the width dimension of the asset part, facilitating accurate representation and management of asset specifications. |
»» height |
string |
false |
none |
Specifies the height of the asset part, providing essential dimensional information for inventory and asset management. |
»» materialType |
string |
false |
none |
Type of the material |
»» assetPartType |
string |
false |
none |
Type of the asset part |
»» assetPartTypeId |
integer(int64) |
false |
none |
Unique identifier for the asset part type |
»» assetPartManufacturer |
false |
none |
Data transfer object representing the manufacturer details of an asset part, including essential identification and classification information to facilitate inventory management and procurement 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 |
»»» name |
string |
false |
none |
Name of the resource |
»»» assetParts |
false |
none |
An array of asset parts, represented by AssetPartManufacturerDTO, that details the components associated with each asset for effective inventory and resource management. |
|
»» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
»» assetPartAvailable |
boolean |
false |
none |
Indicates whether the specific asset part is currently available for allocation or use within the system. |
»» owner |
integer(int64) |
false |
none |
Unique identifier for the owner of the asset part, facilitating asset management and accountability within the system. |
»» ownerDto |
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 |
»» ownerUserName |
string |
false |
none |
Name of the owner user |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» isPartsSufficient |
boolean |
false |
none |
Whether the resource is parts sufficient |
» mainAssets |
false |
none |
Collection of primary assets associated with the supplier, facilitating effective management and evaluation of supplier capabilities. |
|
»» 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. |
|
»» 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. |
|
»» 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 |
» supplierAvailable |
boolean |
false |
none |
Indicates whether the supplier is currently available for new engagements. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, INACTIVE |
Create Supplier¶
HTTP Request
POST /api/suppliers
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Creates a new supplier entry in the system, enabling businesses to manage their supplier relationships effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the supplier information, including name, contact details, and business classification, essential for onboarding new suppliers into the system. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "address": "string",
7 "status": "ACTIVE",
8 "assetCategories": [
9 {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "name": "string",
15 "objectAvailable": true
16 }
17 ],
18 "supplierContacts": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "name": "string",
24 "designation": "string",
25 "phone": "string",
26 "email": "string",
27 "supplierId": 0,
28 "supplierContactAvailable": true
29 }
30 ],
31 "documents": [
32 {
33 "id": 0,
34 "createdBy": "string",
35 "createdAt": "2019-08-24T14:15:22Z",
36 "name": "string",
37 "contentType": "string",
38 "documentTypeName": "string",
39 "documentTypeId": 0,
40 "description": "string",
41 "data": "string",
42 "startDate": "2019-08-24",
43 "endDate": "2019-08-24",
44 "documentStatusId": 0,
45 "documentStatus": "string",
46 "documentStatusType": "string",
47 "parentEntityId": 0,
48 "link": "string",
49 "parentEntityName": "string"
50 }
51 ],
52 "assetParts": [
53 {
54 "id": 0,
55 "createdBy": "string",
56 "createdAt": "2019-08-24T14:15:22Z",
57 "displayId": "string",
58 "name": "string",
59 "description": "string",
60 "imageId": 0,
61 "premiseId": 0,
62 "premiseDisplayId": "string",
63 "premiseDto": {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "premiseName": "string",
69 "description": "string",
70 "address": "string",
71 "internalTeamNames": [
72 "string"
73 ],
74 "internalTeamIds": [
75 0
76 ],
77 "premiseAvailable": true,
78 "premiseFromNrm": true,
79 "nlmId": 0,
80 "nlmDisplayId": "string",
81 "nlmUsed": true,
82 "manager": 0,
83 "managerName": "string",
84 "imageId": 0,
85 "area": "string",
86 "modifiedAt": "2019-08-24T14:15:22Z"
87 },
88 "premiseFromNrm": true,
89 "model": "string",
90 "unitCost": "67.08",
91 "serialNumber": "string",
92 "qrCode": "string",
93 "quantityOnHand": 0,
94 "reOrderPoint": 0,
95 "size": "string",
96 "color": "string",
97 "weight": "24.08",
98 "length": "11.5",
99 "width": "16.9",
100 "height": "12.3",
101 "materialType": "string",
102 "assetPartType": "string",
103 "assetPartTypeId": 0,
104 "assetPartManufacturer": {
105 "id": 0,
106 "createdBy": "string",
107 "createdAt": "2019-08-24T14:15:22Z",
108 "name": "string",
109 "assetParts": [
110 {}
111 ]
112 },
113 "variableQuantity": 0,
114 "assetPartAvailable": true,
115 "owner": 0,
116 "ownerDto": {
117 "id": 0,
118 "createdBy": "string",
119 "createdAt": "2019-08-24T14:15:22Z",
120 "userName": "string",
121 "firstName": "string",
122 "lastName": "string",
123 "email": "string",
124 "roleIds": [
125 {
126 "id": 0,
127 "createdBy": "string",
128 "createdAt": "2019-08-24T14:15:22Z",
129 "modifiedBy": "string",
130 "modifiedAt": "2019-08-24T14:15:22Z",
131 "roleName": "string",
132 "entity": "string",
133 "new": true
134 }
135 ],
136 "internalTeamNames": [
137 "string"
138 ],
139 "internalTeamIds": [
140 0
141 ],
142 "internalTeamDisplayIds": [
143 "string"
144 ],
145 "premiseIds": [
146 0
147 ],
148 "premiseNames": [
149 "string"
150 ],
151 "userAvailable": true,
152 "temporaryWorkload": 0,
153 "preferredCultureCode": "string"
154 },
155 "ownerUserName": "string",
156 "modifiedAt": "2019-08-24T14:15:22Z",
157 "isPartsSufficient": true
158 }
159 ],
160 "mainAssets": [
161 {
162 "id": 0,
163 "createdBy": "string",
164 "createdAt": "2019-08-24T14:15:22Z",
165 "displayId": "string",
166 "name": "string",
167 "description": "string",
168 "qrCode": "string",
169 "barCode": "string",
170 "imageId": 0,
171 "model": "string",
172 "manufacturer": "string",
173 "serialNumber": "string",
174 "cost": "81.08",
175 "premiseId": 0,
176 "premiseDisplayId": "string",
177 "premiseDto": {
178 "id": 0,
179 "createdBy": "string",
180 "createdAt": "2019-08-24T14:15:22Z",
181 "displayId": "string",
182 "premiseName": "string",
183 "description": "string",
184 "address": "string",
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "premiseAvailable": true,
192 "premiseFromNrm": true,
193 "nlmId": 0,
194 "nlmDisplayId": "string",
195 "nlmUsed": true,
196 "manager": 0,
197 "managerName": "string",
198 "imageId": 0,
199 "area": "string",
200 "modifiedAt": "2019-08-24T14:15:22Z"
201 },
202 "acquisitionDate": "2019-08-24",
203 "endOfLife": "2019-08-24",
204 "assetStatusId": 0,
205 "assetStatus": "string",
206 "assetStatusType": "string",
207 "parentAssetId": 0,
208 "parentAssetDisplayId": "string",
209 "parentAsset": "string",
210 "parentAssetDto": {},
211 "upcomingMaintenanceDate": "2019-08-24",
212 "assetCategoryIds": [
213 0
214 ],
215 "assetCategories": [
216 "string"
217 ],
218 "internalTeamIds": [
219 0
220 ],
221 "internalTeamDtos": [
222 {
223 "id": 0,
224 "createdBy": "string",
225 "createdAt": "2019-08-24T14:15:22Z",
226 "displayId": "string",
227 "name": "string",
228 "email": "string",
229 "phone": "string",
230 "manager": "string",
231 "requestCategoryName": [
232 "string"
233 ],
234 "requestCategoryId": [
235 0
236 ],
237 "requestCategoryDisplayId": [
238 "string"
239 ],
240 "description": "string",
241 "internalTeamUser": [
242 0
243 ],
244 "members": 0,
245 "mainAssets": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "internalTeamAvailable": true,
252 "premiseIds": [
253 0
254 ]
255 }
256 ],
257 "internalTeams": [
258 "string"
259 ],
260 "assignedUserIds": [
261 0
262 ],
263 "assignedUserDtos": [
264 {
265 "id": 0,
266 "createdBy": "string",
267 "createdAt": "2019-08-24T14:15:22Z",
268 "userName": "string",
269 "firstName": "string",
270 "lastName": "string",
271 "email": "string",
272 "roleIds": [
273 {
274 "id": 0,
275 "createdBy": "string",
276 "createdAt": "2019-08-24T14:15:22Z",
277 "modifiedBy": "string",
278 "modifiedAt": "2019-08-24T14:15:22Z",
279 "roleName": "string",
280 "entity": "string",
281 "new": true
282 }
283 ],
284 "internalTeamNames": [
285 "string"
286 ],
287 "internalTeamIds": [
288 0
289 ],
290 "internalTeamDisplayIds": [
291 "string"
292 ],
293 "premiseIds": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "userAvailable": true,
300 "temporaryWorkload": 0,
301 "preferredCultureCode": "string"
302 }
303 ],
304 "assignedUsers": [
305 "string"
306 ],
307 "assetPriority": "string",
308 "assetPriorityId": 0,
309 "assetPriorityDisplayId": "string",
310 "assetPriorityType": "string",
311 "assetAvailable": true,
312 "exactPlacement": "string",
313 "fosId": 0,
314 "downtimeStatus": "string",
315 "premiseFromNrm": true,
316 "modifiedAt": "2019-08-24T14:15:22Z"
317 }
318 ],
319 "supplierAvailable": true
320}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Get Supplier¶
HTTP Request
GET /api/suppliers/{id}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Retrieves detailed information about a specific supplier identified by the provided ID, facilitating informed decision-making in supplier management.
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 "name": "string",
7 "address": "string",
8 "status": "ACTIVE",
9 "assetCategories": [
10 {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "objectAvailable": true
17 }
18 ],
19 "supplierContacts": [
20 {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "name": "string",
25 "designation": "string",
26 "phone": "string",
27 "email": "string",
28 "supplierId": 0,
29 "supplierContactAvailable": true
30 }
31 ],
32 "documents": [
33 {
34 "id": 0,
35 "createdBy": "string",
36 "createdAt": "2019-08-24T14:15:22Z",
37 "name": "string",
38 "contentType": "string",
39 "documentTypeName": "string",
40 "documentTypeId": 0,
41 "description": "string",
42 "data": "string",
43 "startDate": "2019-08-24",
44 "endDate": "2019-08-24",
45 "documentStatusId": 0,
46 "documentStatus": "string",
47 "documentStatusType": "string",
48 "parentEntityId": 0,
49 "link": "string",
50 "parentEntityName": "string"
51 }
52 ],
53 "assetParts": [
54 {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "imageId": 0,
62 "premiseId": 0,
63 "premiseDisplayId": "string",
64 "premiseDto": {
65 "id": 0,
66 "createdBy": "string",
67 "createdAt": "2019-08-24T14:15:22Z",
68 "displayId": "string",
69 "premiseName": "string",
70 "description": "string",
71 "address": "string",
72 "internalTeamNames": [
73 "string"
74 ],
75 "internalTeamIds": [
76 0
77 ],
78 "premiseAvailable": true,
79 "premiseFromNrm": true,
80 "nlmId": 0,
81 "nlmDisplayId": "string",
82 "nlmUsed": true,
83 "manager": 0,
84 "managerName": "string",
85 "imageId": 0,
86 "area": "string",
87 "modifiedAt": "2019-08-24T14:15:22Z"
88 },
89 "premiseFromNrm": true,
90 "model": "string",
91 "unitCost": "67.08",
92 "serialNumber": "string",
93 "qrCode": "string",
94 "quantityOnHand": 0,
95 "reOrderPoint": 0,
96 "size": "string",
97 "color": "string",
98 "weight": "24.08",
99 "length": "11.5",
100 "width": "16.9",
101 "height": "12.3",
102 "materialType": "string",
103 "assetPartType": "string",
104 "assetPartTypeId": 0,
105 "assetPartManufacturer": {
106 "id": 0,
107 "createdBy": "string",
108 "createdAt": "2019-08-24T14:15:22Z",
109 "name": "string",
110 "assetParts": [
111 {}
112 ]
113 },
114 "variableQuantity": 0,
115 "assetPartAvailable": true,
116 "owner": 0,
117 "ownerDto": {
118 "id": 0,
119 "createdBy": "string",
120 "createdAt": "2019-08-24T14:15:22Z",
121 "userName": "string",
122 "firstName": "string",
123 "lastName": "string",
124 "email": "string",
125 "roleIds": [
126 {
127 "id": 0,
128 "createdBy": "string",
129 "createdAt": "2019-08-24T14:15:22Z",
130 "modifiedBy": "string",
131 "modifiedAt": "2019-08-24T14:15:22Z",
132 "roleName": "string",
133 "entity": "string",
134 "new": true
135 }
136 ],
137 "internalTeamNames": [
138 "string"
139 ],
140 "internalTeamIds": [
141 0
142 ],
143 "internalTeamDisplayIds": [
144 "string"
145 ],
146 "premiseIds": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "userAvailable": true,
153 "temporaryWorkload": 0,
154 "preferredCultureCode": "string"
155 },
156 "ownerUserName": "string",
157 "modifiedAt": "2019-08-24T14:15:22Z",
158 "isPartsSufficient": true
159 }
160 ],
161 "mainAssets": [
162 {
163 "id": 0,
164 "createdBy": "string",
165 "createdAt": "2019-08-24T14:15:22Z",
166 "displayId": "string",
167 "name": "string",
168 "description": "string",
169 "qrCode": "string",
170 "barCode": "string",
171 "imageId": 0,
172 "model": "string",
173 "manufacturer": "string",
174 "serialNumber": "string",
175 "cost": "81.08",
176 "premiseId": 0,
177 "premiseDisplayId": "string",
178 "premiseDto": {
179 "id": 0,
180 "createdBy": "string",
181 "createdAt": "2019-08-24T14:15:22Z",
182 "displayId": "string",
183 "premiseName": "string",
184 "description": "string",
185 "address": "string",
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "premiseAvailable": true,
193 "premiseFromNrm": true,
194 "nlmId": 0,
195 "nlmDisplayId": "string",
196 "nlmUsed": true,
197 "manager": 0,
198 "managerName": "string",
199 "imageId": 0,
200 "area": "string",
201 "modifiedAt": "2019-08-24T14:15:22Z"
202 },
203 "acquisitionDate": "2019-08-24",
204 "endOfLife": "2019-08-24",
205 "assetStatusId": 0,
206 "assetStatus": "string",
207 "assetStatusType": "string",
208 "parentAssetId": 0,
209 "parentAssetDisplayId": "string",
210 "parentAsset": "string",
211 "parentAssetDto": {},
212 "upcomingMaintenanceDate": "2019-08-24",
213 "assetCategoryIds": [
214 0
215 ],
216 "assetCategories": [
217 "string"
218 ],
219 "internalTeamIds": [
220 0
221 ],
222 "internalTeamDtos": [
223 {
224 "id": 0,
225 "createdBy": "string",
226 "createdAt": "2019-08-24T14:15:22Z",
227 "displayId": "string",
228 "name": "string",
229 "email": "string",
230 "phone": "string",
231 "manager": "string",
232 "requestCategoryName": [
233 "string"
234 ],
235 "requestCategoryId": [
236 0
237 ],
238 "requestCategoryDisplayId": [
239 "string"
240 ],
241 "description": "string",
242 "internalTeamUser": [
243 0
244 ],
245 "members": 0,
246 "mainAssets": [
247 0
248 ],
249 "premiseNames": [
250 "string"
251 ],
252 "internalTeamAvailable": true,
253 "premiseIds": [
254 0
255 ]
256 }
257 ],
258 "internalTeams": [
259 "string"
260 ],
261 "assignedUserIds": [
262 0
263 ],
264 "assignedUserDtos": [
265 {
266 "id": 0,
267 "createdBy": "string",
268 "createdAt": "2019-08-24T14:15:22Z",
269 "userName": "string",
270 "firstName": "string",
271 "lastName": "string",
272 "email": "string",
273 "roleIds": [
274 {
275 "id": 0,
276 "createdBy": "string",
277 "createdAt": "2019-08-24T14:15:22Z",
278 "modifiedBy": "string",
279 "modifiedAt": "2019-08-24T14:15:22Z",
280 "roleName": "string",
281 "entity": "string",
282 "new": true
283 }
284 ],
285 "internalTeamNames": [
286 "string"
287 ],
288 "internalTeamIds": [
289 0
290 ],
291 "internalTeamDisplayIds": [
292 "string"
293 ],
294 "premiseIds": [
295 0
296 ],
297 "premiseNames": [
298 "string"
299 ],
300 "userAvailable": true,
301 "temporaryWorkload": 0,
302 "preferredCultureCode": "string"
303 }
304 ],
305 "assignedUsers": [
306 "string"
307 ],
308 "assetPriority": "string",
309 "assetPriorityId": 0,
310 "assetPriorityDisplayId": "string",
311 "assetPriorityType": "string",
312 "assetAvailable": true,
313 "exactPlacement": "string",
314 "fosId": 0,
315 "downtimeStatus": "string",
316 "premiseFromNrm": true,
317 "modifiedAt": "2019-08-24T14:15:22Z"
318 }
319 ],
320 "supplierAvailable": true
321 }
322]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a supplier’s essential information, including contact details, business classification, and compliance status, to facilitate efficient vendor management and procurement 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 |
» name |
string |
false |
none |
Name of the resource |
» address |
string |
false |
none |
Represents the physical location of the supplier, essential for logistics and communication purposes. |
» status |
string |
false |
none |
Status of the resource |
» assetCategories |
false |
none |
Array of asset categories associated with the supplier, facilitating the classification and management of supplier-related assets. |
|
»» 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 |
»» objectAvailable |
boolean |
false |
none |
Indicates whether the asset category is currently available for allocation within the system. |
» supplierContacts |
false |
none |
An array of contact details for suppliers, facilitating effective communication and relationship management within the supply chain. |
|
»» 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 |
»» name |
string |
false |
none |
Name of the resource |
»» designation |
string |
false |
none |
Represents the job title or role of the contact person associated with the supplier, facilitating effective communication and relationship management. |
»» phone |
string |
false |
none |
Contact phone number for the supplier, used to facilitate communication and coordination. |
string |
false |
none |
Email address of the supplier contact, used for communication and correspondence related to supplier management. |
|
»» supplierId |
integer(int64) |
false |
none |
Unique identifier for the supplier |
»» supplierContactAvailable |
boolean |
false |
none |
Indicates whether a contact person for the supplier is available, facilitating effective communication and relationship management. |
» documents |
false |
none |
An array of SupplierDTO objects representing the documents associated with the supplier, essential for managing supplier-related information 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 |
»» name |
string |
false |
none |
Name of the resource |
»» contentType |
string |
false |
none |
Type of the content |
»» documentTypeName |
string |
false |
none |
Name of the document type |
»» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
»» description |
string |
false |
none |
Description of the resource |
»» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
»» documentStatus |
string |
false |
none |
Status of the document |
»» documentStatusType |
string |
false |
none |
Type of the document status |
»» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
»» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
»» parentEntityName |
string |
true |
none |
Name of the parent entity |
» assetParts |
false |
none |
Array of SupplierDTO objects representing the individual components or parts associated with an asset, facilitating comprehensive asset management and supplier collaboration. |
|
»» 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 |
»» description |
string |
false |
none |
Description of the resource |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» 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 |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset part originates from the National Resource Management (NRM) framework, facilitating compliance and reporting requirements. |
»» model |
string |
false |
none |
Represents the specific model associated with the asset part, facilitating accurate identification and management within the system. |
»» unitCost |
string |
false |
none |
Represents the cost per unit of the asset part, essential for accurate budgeting and financial analysis within asset management. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset part, facilitating efficient tracking and management within the asset management system. |
»» qrCode |
string |
false |
none |
Code for the qr |
»» quantityOnHand |
integer(int64) |
false |
none |
Represents the current inventory level of the asset part, indicating the quantity available for use or sale. |
»» reOrderPoint |
integer(int64) |
false |
none |
Reorder point indicates the inventory level at which new stock should be ordered to prevent stockouts and ensure continuous availability of asset parts. |
»» size |
string |
false |
none |
Number of items per page |
»» color |
string |
false |
none |
Represents the color attribute associated with the asset part, providing essential visual differentiation for inventory management and asset tracking. |
»» weight |
string |
false |
none |
Represents the weight of the asset part, providing essential information for inventory management and logistics optimization. |
»» length |
string |
false |
none |
Specifies the length of the asset part, providing essential information for inventory management and resource allocation. |
»» width |
string |
false |
none |
Specifies the width dimension of the asset part, facilitating accurate representation and management of asset specifications. |
»» height |
string |
false |
none |
Specifies the height of the asset part, providing essential dimensional information for inventory and asset management. |
»» materialType |
string |
false |
none |
Type of the material |
»» assetPartType |
string |
false |
none |
Type of the asset part |
»» assetPartTypeId |
integer(int64) |
false |
none |
Unique identifier for the asset part type |
»» assetPartManufacturer |
false |
none |
Data transfer object representing the manufacturer details of an asset part, including essential identification and classification information to facilitate inventory management and procurement 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 |
»»» name |
string |
false |
none |
Name of the resource |
»»» assetParts |
false |
none |
An array of asset parts, represented by AssetPartManufacturerDTO, that details the components associated with each asset for effective inventory and resource management. |
|
»» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
»» assetPartAvailable |
boolean |
false |
none |
Indicates whether the specific asset part is currently available for allocation or use within the system. |
»» owner |
integer(int64) |
false |
none |
Unique identifier for the owner of the asset part, facilitating asset management and accountability within the system. |
»» ownerDto |
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 |
»» ownerUserName |
string |
false |
none |
Name of the owner user |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» isPartsSufficient |
boolean |
false |
none |
Whether the resource is parts sufficient |
» mainAssets |
false |
none |
Collection of primary assets associated with the supplier, facilitating effective management and evaluation of supplier capabilities. |
|
»» 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. |
|
»» 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. |
|
»» 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 |
» supplierAvailable |
boolean |
false |
none |
Indicates whether the supplier is currently available for new engagements. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, INACTIVE |
Update Supplier¶
HTTP Request
POST /api/suppliers/{id}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Updates the details of a specific supplier identified by the provided ID, ensuring that supplier information is current and accurate 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 supplier update information, including contact details, address, and relevant business attributes. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "address": "string",
7 "status": "ACTIVE",
8 "assetCategories": [
9 {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "name": "string",
15 "objectAvailable": true
16 }
17 ],
18 "supplierContacts": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "name": "string",
24 "designation": "string",
25 "phone": "string",
26 "email": "string",
27 "supplierId": 0,
28 "supplierContactAvailable": true
29 }
30 ],
31 "documents": [
32 {
33 "id": 0,
34 "createdBy": "string",
35 "createdAt": "2019-08-24T14:15:22Z",
36 "name": "string",
37 "contentType": "string",
38 "documentTypeName": "string",
39 "documentTypeId": 0,
40 "description": "string",
41 "data": "string",
42 "startDate": "2019-08-24",
43 "endDate": "2019-08-24",
44 "documentStatusId": 0,
45 "documentStatus": "string",
46 "documentStatusType": "string",
47 "parentEntityId": 0,
48 "link": "string",
49 "parentEntityName": "string"
50 }
51 ],
52 "assetParts": [
53 {
54 "id": 0,
55 "createdBy": "string",
56 "createdAt": "2019-08-24T14:15:22Z",
57 "displayId": "string",
58 "name": "string",
59 "description": "string",
60 "imageId": 0,
61 "premiseId": 0,
62 "premiseDisplayId": "string",
63 "premiseDto": {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "premiseName": "string",
69 "description": "string",
70 "address": "string",
71 "internalTeamNames": [
72 "string"
73 ],
74 "internalTeamIds": [
75 0
76 ],
77 "premiseAvailable": true,
78 "premiseFromNrm": true,
79 "nlmId": 0,
80 "nlmDisplayId": "string",
81 "nlmUsed": true,
82 "manager": 0,
83 "managerName": "string",
84 "imageId": 0,
85 "area": "string",
86 "modifiedAt": "2019-08-24T14:15:22Z"
87 },
88 "premiseFromNrm": true,
89 "model": "string",
90 "unitCost": "67.08",
91 "serialNumber": "string",
92 "qrCode": "string",
93 "quantityOnHand": 0,
94 "reOrderPoint": 0,
95 "size": "string",
96 "color": "string",
97 "weight": "24.08",
98 "length": "11.5",
99 "width": "16.9",
100 "height": "12.3",
101 "materialType": "string",
102 "assetPartType": "string",
103 "assetPartTypeId": 0,
104 "assetPartManufacturer": {
105 "id": 0,
106 "createdBy": "string",
107 "createdAt": "2019-08-24T14:15:22Z",
108 "name": "string",
109 "assetParts": [
110 {}
111 ]
112 },
113 "variableQuantity": 0,
114 "assetPartAvailable": true,
115 "owner": 0,
116 "ownerDto": {
117 "id": 0,
118 "createdBy": "string",
119 "createdAt": "2019-08-24T14:15:22Z",
120 "userName": "string",
121 "firstName": "string",
122 "lastName": "string",
123 "email": "string",
124 "roleIds": [
125 {
126 "id": 0,
127 "createdBy": "string",
128 "createdAt": "2019-08-24T14:15:22Z",
129 "modifiedBy": "string",
130 "modifiedAt": "2019-08-24T14:15:22Z",
131 "roleName": "string",
132 "entity": "string",
133 "new": true
134 }
135 ],
136 "internalTeamNames": [
137 "string"
138 ],
139 "internalTeamIds": [
140 0
141 ],
142 "internalTeamDisplayIds": [
143 "string"
144 ],
145 "premiseIds": [
146 0
147 ],
148 "premiseNames": [
149 "string"
150 ],
151 "userAvailable": true,
152 "temporaryWorkload": 0,
153 "preferredCultureCode": "string"
154 },
155 "ownerUserName": "string",
156 "modifiedAt": "2019-08-24T14:15:22Z",
157 "isPartsSufficient": true
158 }
159 ],
160 "mainAssets": [
161 {
162 "id": 0,
163 "createdBy": "string",
164 "createdAt": "2019-08-24T14:15:22Z",
165 "displayId": "string",
166 "name": "string",
167 "description": "string",
168 "qrCode": "string",
169 "barCode": "string",
170 "imageId": 0,
171 "model": "string",
172 "manufacturer": "string",
173 "serialNumber": "string",
174 "cost": "81.08",
175 "premiseId": 0,
176 "premiseDisplayId": "string",
177 "premiseDto": {
178 "id": 0,
179 "createdBy": "string",
180 "createdAt": "2019-08-24T14:15:22Z",
181 "displayId": "string",
182 "premiseName": "string",
183 "description": "string",
184 "address": "string",
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "premiseAvailable": true,
192 "premiseFromNrm": true,
193 "nlmId": 0,
194 "nlmDisplayId": "string",
195 "nlmUsed": true,
196 "manager": 0,
197 "managerName": "string",
198 "imageId": 0,
199 "area": "string",
200 "modifiedAt": "2019-08-24T14:15:22Z"
201 },
202 "acquisitionDate": "2019-08-24",
203 "endOfLife": "2019-08-24",
204 "assetStatusId": 0,
205 "assetStatus": "string",
206 "assetStatusType": "string",
207 "parentAssetId": 0,
208 "parentAssetDisplayId": "string",
209 "parentAsset": "string",
210 "parentAssetDto": {},
211 "upcomingMaintenanceDate": "2019-08-24",
212 "assetCategoryIds": [
213 0
214 ],
215 "assetCategories": [
216 "string"
217 ],
218 "internalTeamIds": [
219 0
220 ],
221 "internalTeamDtos": [
222 {
223 "id": 0,
224 "createdBy": "string",
225 "createdAt": "2019-08-24T14:15:22Z",
226 "displayId": "string",
227 "name": "string",
228 "email": "string",
229 "phone": "string",
230 "manager": "string",
231 "requestCategoryName": [
232 "string"
233 ],
234 "requestCategoryId": [
235 0
236 ],
237 "requestCategoryDisplayId": [
238 "string"
239 ],
240 "description": "string",
241 "internalTeamUser": [
242 0
243 ],
244 "members": 0,
245 "mainAssets": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "internalTeamAvailable": true,
252 "premiseIds": [
253 0
254 ]
255 }
256 ],
257 "internalTeams": [
258 "string"
259 ],
260 "assignedUserIds": [
261 0
262 ],
263 "assignedUserDtos": [
264 {
265 "id": 0,
266 "createdBy": "string",
267 "createdAt": "2019-08-24T14:15:22Z",
268 "userName": "string",
269 "firstName": "string",
270 "lastName": "string",
271 "email": "string",
272 "roleIds": [
273 {
274 "id": 0,
275 "createdBy": "string",
276 "createdAt": "2019-08-24T14:15:22Z",
277 "modifiedBy": "string",
278 "modifiedAt": "2019-08-24T14:15:22Z",
279 "roleName": "string",
280 "entity": "string",
281 "new": true
282 }
283 ],
284 "internalTeamNames": [
285 "string"
286 ],
287 "internalTeamIds": [
288 0
289 ],
290 "internalTeamDisplayIds": [
291 "string"
292 ],
293 "premiseIds": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "userAvailable": true,
300 "temporaryWorkload": 0,
301 "preferredCultureCode": "string"
302 }
303 ],
304 "assignedUsers": [
305 "string"
306 ],
307 "assetPriority": "string",
308 "assetPriorityId": 0,
309 "assetPriorityDisplayId": "string",
310 "assetPriorityType": "string",
311 "assetAvailable": true,
312 "exactPlacement": "string",
313 "fosId": 0,
314 "downtimeStatus": "string",
315 "premiseFromNrm": true,
316 "modifiedAt": "2019-08-24T14:15:22Z"
317 }
318 ],
319 "supplierAvailable": true
320}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Supplier¶
HTTP Request
DELETE /api/suppliers/{id}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Deletes a specified supplier from the system, ensuring that all associated data is removed and maintaining the integrity of supplier records.
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 |
Update Supplier Availability With Children¶
HTTP Request
POST /api/suppliers/{id}/updateChildrenAvailability
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Updates the availability status of child entities associated with a specified supplier, enabling efficient management of supplier resources and ensuring accurate availability information for operational planning.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated availability status for the supplier’s child entities, ensuring accurate inventory management and operational efficiency. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "address": "string",
7 "status": "ACTIVE",
8 "assetCategories": [
9 {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "name": "string",
15 "objectAvailable": true
16 }
17 ],
18 "supplierContacts": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "name": "string",
24 "designation": "string",
25 "phone": "string",
26 "email": "string",
27 "supplierId": 0,
28 "supplierContactAvailable": true
29 }
30 ],
31 "documents": [
32 {
33 "id": 0,
34 "createdBy": "string",
35 "createdAt": "2019-08-24T14:15:22Z",
36 "name": "string",
37 "contentType": "string",
38 "documentTypeName": "string",
39 "documentTypeId": 0,
40 "description": "string",
41 "data": "string",
42 "startDate": "2019-08-24",
43 "endDate": "2019-08-24",
44 "documentStatusId": 0,
45 "documentStatus": "string",
46 "documentStatusType": "string",
47 "parentEntityId": 0,
48 "link": "string",
49 "parentEntityName": "string"
50 }
51 ],
52 "assetParts": [
53 {
54 "id": 0,
55 "createdBy": "string",
56 "createdAt": "2019-08-24T14:15:22Z",
57 "displayId": "string",
58 "name": "string",
59 "description": "string",
60 "imageId": 0,
61 "premiseId": 0,
62 "premiseDisplayId": "string",
63 "premiseDto": {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "premiseName": "string",
69 "description": "string",
70 "address": "string",
71 "internalTeamNames": [
72 "string"
73 ],
74 "internalTeamIds": [
75 0
76 ],
77 "premiseAvailable": true,
78 "premiseFromNrm": true,
79 "nlmId": 0,
80 "nlmDisplayId": "string",
81 "nlmUsed": true,
82 "manager": 0,
83 "managerName": "string",
84 "imageId": 0,
85 "area": "string",
86 "modifiedAt": "2019-08-24T14:15:22Z"
87 },
88 "premiseFromNrm": true,
89 "model": "string",
90 "unitCost": "67.08",
91 "serialNumber": "string",
92 "qrCode": "string",
93 "quantityOnHand": 0,
94 "reOrderPoint": 0,
95 "size": "string",
96 "color": "string",
97 "weight": "24.08",
98 "length": "11.5",
99 "width": "16.9",
100 "height": "12.3",
101 "materialType": "string",
102 "assetPartType": "string",
103 "assetPartTypeId": 0,
104 "assetPartManufacturer": {
105 "id": 0,
106 "createdBy": "string",
107 "createdAt": "2019-08-24T14:15:22Z",
108 "name": "string",
109 "assetParts": [
110 {}
111 ]
112 },
113 "variableQuantity": 0,
114 "assetPartAvailable": true,
115 "owner": 0,
116 "ownerDto": {
117 "id": 0,
118 "createdBy": "string",
119 "createdAt": "2019-08-24T14:15:22Z",
120 "userName": "string",
121 "firstName": "string",
122 "lastName": "string",
123 "email": "string",
124 "roleIds": [
125 {
126 "id": 0,
127 "createdBy": "string",
128 "createdAt": "2019-08-24T14:15:22Z",
129 "modifiedBy": "string",
130 "modifiedAt": "2019-08-24T14:15:22Z",
131 "roleName": "string",
132 "entity": "string",
133 "new": true
134 }
135 ],
136 "internalTeamNames": [
137 "string"
138 ],
139 "internalTeamIds": [
140 0
141 ],
142 "internalTeamDisplayIds": [
143 "string"
144 ],
145 "premiseIds": [
146 0
147 ],
148 "premiseNames": [
149 "string"
150 ],
151 "userAvailable": true,
152 "temporaryWorkload": 0,
153 "preferredCultureCode": "string"
154 },
155 "ownerUserName": "string",
156 "modifiedAt": "2019-08-24T14:15:22Z",
157 "isPartsSufficient": true
158 }
159 ],
160 "mainAssets": [
161 {
162 "id": 0,
163 "createdBy": "string",
164 "createdAt": "2019-08-24T14:15:22Z",
165 "displayId": "string",
166 "name": "string",
167 "description": "string",
168 "qrCode": "string",
169 "barCode": "string",
170 "imageId": 0,
171 "model": "string",
172 "manufacturer": "string",
173 "serialNumber": "string",
174 "cost": "81.08",
175 "premiseId": 0,
176 "premiseDisplayId": "string",
177 "premiseDto": {
178 "id": 0,
179 "createdBy": "string",
180 "createdAt": "2019-08-24T14:15:22Z",
181 "displayId": "string",
182 "premiseName": "string",
183 "description": "string",
184 "address": "string",
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "premiseAvailable": true,
192 "premiseFromNrm": true,
193 "nlmId": 0,
194 "nlmDisplayId": "string",
195 "nlmUsed": true,
196 "manager": 0,
197 "managerName": "string",
198 "imageId": 0,
199 "area": "string",
200 "modifiedAt": "2019-08-24T14:15:22Z"
201 },
202 "acquisitionDate": "2019-08-24",
203 "endOfLife": "2019-08-24",
204 "assetStatusId": 0,
205 "assetStatus": "string",
206 "assetStatusType": "string",
207 "parentAssetId": 0,
208 "parentAssetDisplayId": "string",
209 "parentAsset": "string",
210 "parentAssetDto": {},
211 "upcomingMaintenanceDate": "2019-08-24",
212 "assetCategoryIds": [
213 0
214 ],
215 "assetCategories": [
216 "string"
217 ],
218 "internalTeamIds": [
219 0
220 ],
221 "internalTeamDtos": [
222 {
223 "id": 0,
224 "createdBy": "string",
225 "createdAt": "2019-08-24T14:15:22Z",
226 "displayId": "string",
227 "name": "string",
228 "email": "string",
229 "phone": "string",
230 "manager": "string",
231 "requestCategoryName": [
232 "string"
233 ],
234 "requestCategoryId": [
235 0
236 ],
237 "requestCategoryDisplayId": [
238 "string"
239 ],
240 "description": "string",
241 "internalTeamUser": [
242 0
243 ],
244 "members": 0,
245 "mainAssets": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "internalTeamAvailable": true,
252 "premiseIds": [
253 0
254 ]
255 }
256 ],
257 "internalTeams": [
258 "string"
259 ],
260 "assignedUserIds": [
261 0
262 ],
263 "assignedUserDtos": [
264 {
265 "id": 0,
266 "createdBy": "string",
267 "createdAt": "2019-08-24T14:15:22Z",
268 "userName": "string",
269 "firstName": "string",
270 "lastName": "string",
271 "email": "string",
272 "roleIds": [
273 {
274 "id": 0,
275 "createdBy": "string",
276 "createdAt": "2019-08-24T14:15:22Z",
277 "modifiedBy": "string",
278 "modifiedAt": "2019-08-24T14:15:22Z",
279 "roleName": "string",
280 "entity": "string",
281 "new": true
282 }
283 ],
284 "internalTeamNames": [
285 "string"
286 ],
287 "internalTeamIds": [
288 0
289 ],
290 "internalTeamDisplayIds": [
291 "string"
292 ],
293 "premiseIds": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "userAvailable": true,
300 "temporaryWorkload": 0,
301 "preferredCultureCode": "string"
302 }
303 ],
304 "assignedUsers": [
305 "string"
306 ],
307 "assetPriority": "string",
308 "assetPriorityId": 0,
309 "assetPriorityDisplayId": "string",
310 "assetPriorityType": "string",
311 "assetAvailable": true,
312 "exactPlacement": "string",
313 "fosId": 0,
314 "downtimeStatus": "string",
315 "premiseFromNrm": true,
316 "modifiedAt": "2019-08-24T14:15:22Z"
317 }
318 ],
319 "supplierAvailable": true
320}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get All Supplier Contacts By Supplier ID¶
HTTP Request
GET /api/suppliers/{id}/supplierContacts
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Retrieves a list of supplier contacts associated with the specified supplier ID, enabling efficient management of supplier relationships and communication.
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 "name": "string",
7 "designation": "string",
8 "phone": "string",
9 "email": "string",
10 "supplierId": 0,
11 "supplierContactAvailable": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the contact information of a supplier, including essential details for effective communication and relationship management within the supply chain.] |
|
» 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 |
» name |
string |
false |
none |
Name of the resource |
» designation |
string |
false |
none |
Represents the job title or role of the contact person associated with the supplier, facilitating effective communication and relationship management. |
» phone |
string |
false |
none |
Contact phone number for the supplier, used to facilitate communication and coordination. |
string |
false |
none |
Email address of the supplier contact, used for communication and correspondence related to supplier management. |
|
» supplierId |
integer(int64) |
false |
none |
Unique identifier for the supplier |
» supplierContactAvailable |
boolean |
false |
none |
Indicates whether a contact person for the supplier is available, facilitating effective communication and relationship management. |
Create Supplier Contacts By Supplier¶
HTTP Request
POST /api/suppliers/{id}/supplierContacts
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Creates a new supplier contact for the specified supplier, enabling enhanced communication and relationship management within the supplier ecosystem.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the supplier contact details, including name, email, phone number, and role, necessary for establishing effective communication with the specified supplier. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "designation": "string",
7 "phone": "string",
8 "email": "string",
9 "supplierId": 0,
10 "supplierContactAvailable": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Get Supplier Contact By ID¶
HTTP Request
GET /api/suppliers/{id}/supplierContacts/{contactId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Retrieves detailed information about a specific supplier contact associated with a given supplier, enabling users to access essential contact details for effective supplier management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
contactId |
path |
integer(int64) |
true |
Unique identifier for the contact |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "designation": "string",
7 "phone": "string",
8 "email": "string",
9 "supplierId": 0,
10 "supplierContactAvailable": true
11}
Update Supplier Contact¶
HTTP Request
POST /api/suppliers/{id}/supplierContacts/{contactId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Creates or updates a supplier contact for the specified supplier, enabling effective management of supplier relationships and contact information.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
contactId |
path |
integer(int64) |
true |
Unique identifier for the contact |
body |
body |
true |
Request body containing the supplier contact details, including name, email, phone number, and role, necessary for updating the specified supplier’s contact information. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "designation": "string",
7 "phone": "string",
8 "email": "string",
9 "supplierId": 0,
10 "supplierContactAvailable": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Supplier Contact¶
HTTP Request
DELETE /api/suppliers/{id}/supplierContacts/{contactId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Deletes a specific supplier contact associated with the given supplier ID, ensuring the removal of outdated or unnecessary contact information from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
contactId |
path |
integer(int64) |
true |
Unique identifier for the contact |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Documents By Supplier ID¶
HTTP Request
GET /api/suppliers/{id}/documents/{documentId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Retrieves the specified document associated with a supplier, providing essential details for effective supplier management and documentation oversight.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "contentType": "string",
7 "documentTypeName": "string",
8 "documentTypeId": 0,
9 "description": "string",
10 "data": "string",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "documentStatusId": 0,
14 "documentStatus": "string",
15 "documentStatusType": "string",
16 "parentEntityId": 0,
17 "link": "string",
18 "parentEntityName": "string"
19}
Assign Document To Supplier¶
HTTP Request
POST /api/suppliers/{id}/documents/{documentId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Uploads a specified document for the supplier identified by the given ID, facilitating efficient document management within the supplier relationship framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Document From Supplier¶
HTTP Request
DELETE /api/suppliers/{id}/documents/{documentId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Deletes a specified document associated with a supplier, ensuring the removal of outdated or irrelevant information from the supplier’s records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Asset Category By ID¶
HTTP Request
GET /api/suppliers/{id}/assetCategories/{assetCategoryId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches detailed information about a specific asset category associated with a supplier, enabling users to manage and analyze supplier-related asset classifications effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetCategoryId |
path |
integer(int64) |
true |
Unique identifier for the asset category |
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 "objectAvailable": true
8}
Assign Asset Category To Supplier¶
HTTP Request
POST /api/suppliers/{id}/assetCategories/{assetCategoryId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Creates a new asset category for the specified supplier, enabling the organization to effectively manage and categorize assets associated with that supplier.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetCategoryId |
path |
integer(int64) |
true |
Unique identifier for the asset category |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Asset Category From Supplier¶
HTTP Request
DELETE /api/suppliers/{id}/assetCategories/{assetCategoryId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Deletes a specific asset category associated with a supplier, ensuring that the asset management system remains organized and up-to-date.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetCategoryId |
path |
integer(int64) |
true |
Unique identifier for the asset category |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Find Supplier¶
HTTP Request
POST /api/suppliers/search
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Submits a search request to retrieve supplier information based on specified criteria, enabling efficient supplier management and selection.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results for suppliers should be returned in a paginated format, enhancing the efficiency of data retrieval and user experience. |
|
body |
body |
true |
Request body containing search criteria and filters for retrieving supplier information based on specified parameters. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "nameLike": "string",
9 "addressLike": "string",
10 "supplierAvailable": true,
11 "statusIn": [
12 "ACTIVE"
13 ],
14 "attachToAssetIdIn": [
15 0
16 ],
17 "attachToAssetIdNotIn": [
18 0
19 ],
20 "attachToAssetPartIdIn": [
21 0
22 ],
23 "attachToAssetPartIdNotIn": [
24 0
25 ]
26}
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 "name": "string",
26 "address": "string",
27 "status": "ACTIVE",
28 "assetCategories": [
29 {
30 "id": 0,
31 "createdBy": "string",
32 "createdAt": "2019-08-24T14:15:22Z",
33 "displayId": "string",
34 "name": "string",
35 "objectAvailable": true
36 }
37 ],
38 "supplierContacts": [
39 {
40 "id": 0,
41 "createdBy": "string",
42 "createdAt": "2019-08-24T14:15:22Z",
43 "name": "string",
44 "designation": "string",
45 "phone": "string",
46 "email": "string",
47 "supplierId": 0,
48 "supplierContactAvailable": true
49 }
50 ],
51 "documents": [
52 {
53 "id": 0,
54 "createdBy": "string",
55 "createdAt": "2019-08-24T14:15:22Z",
56 "name": "string",
57 "contentType": "string",
58 "documentTypeName": "string",
59 "documentTypeId": 0,
60 "description": "string",
61 "data": "string",
62 "startDate": "2019-08-24",
63 "endDate": "2019-08-24",
64 "documentStatusId": 0,
65 "documentStatus": "string",
66 "documentStatusType": "string",
67 "parentEntityId": 0,
68 "link": "string",
69 "parentEntityName": "string"
70 }
71 ],
72 "assetParts": [
73 {
74 "id": 0,
75 "createdBy": "string",
76 "createdAt": "2019-08-24T14:15:22Z",
77 "displayId": "string",
78 "name": "string",
79 "description": "string",
80 "imageId": 0,
81 "premiseId": 0,
82 "premiseDisplayId": "string",
83 "premiseDto": {
84 "id": 0,
85 "createdBy": "string",
86 "createdAt": "2019-08-24T14:15:22Z",
87 "displayId": "string",
88 "premiseName": "string",
89 "description": "string",
90 "address": "string",
91 "internalTeamNames": [
92 "string"
93 ],
94 "internalTeamIds": [
95 0
96 ],
97 "premiseAvailable": true,
98 "premiseFromNrm": true,
99 "nlmId": 0,
100 "nlmDisplayId": "string",
101 "nlmUsed": true,
102 "manager": 0,
103 "managerName": "string",
104 "imageId": 0,
105 "area": "string",
106 "modifiedAt": "2019-08-24T14:15:22Z"
107 },
108 "premiseFromNrm": true,
109 "model": "string",
110 "unitCost": "67.08",
111 "serialNumber": "string",
112 "qrCode": "string",
113 "quantityOnHand": 0,
114 "reOrderPoint": 0,
115 "size": "string",
116 "color": "string",
117 "weight": "24.08",
118 "length": "11.5",
119 "width": "16.9",
120 "height": "12.3",
121 "materialType": "string",
122 "assetPartType": "string",
123 "assetPartTypeId": 0,
124 "assetPartManufacturer": {
125 "id": 0,
126 "createdBy": "string",
127 "createdAt": "2019-08-24T14:15:22Z",
128 "name": "string",
129 "assetParts": [
130 {}
131 ]
132 },
133 "variableQuantity": 0,
134 "assetPartAvailable": true,
135 "owner": 0,
136 "ownerDto": {
137 "id": 0,
138 "createdBy": "string",
139 "createdAt": "2019-08-24T14:15:22Z",
140 "userName": "string",
141 "firstName": "string",
142 "lastName": "string",
143 "email": "string",
144 "roleIds": [
145 {
146 "id": 0,
147 "createdBy": "string",
148 "createdAt": "2019-08-24T14:15:22Z",
149 "modifiedBy": "string",
150 "modifiedAt": "2019-08-24T14:15:22Z",
151 "roleName": "string",
152 "entity": "string",
153 "new": true
154 }
155 ],
156 "internalTeamNames": [
157 "string"
158 ],
159 "internalTeamIds": [
160 0
161 ],
162 "internalTeamDisplayIds": [
163 "string"
164 ],
165 "premiseIds": [
166 0
167 ],
168 "premiseNames": [
169 "string"
170 ],
171 "userAvailable": true,
172 "temporaryWorkload": 0,
173 "preferredCultureCode": "string"
174 },
175 "ownerUserName": "string",
176 "modifiedAt": "2019-08-24T14:15:22Z",
177 "isPartsSufficient": true
178 }
179 ],
180 "mainAssets": [
181 {
182 "id": 0,
183 "createdBy": "string",
184 "createdAt": "2019-08-24T14:15:22Z",
185 "displayId": "string",
186 "name": "string",
187 "description": "string",
188 "qrCode": "string",
189 "barCode": "string",
190 "imageId": 0,
191 "model": "string",
192 "manufacturer": "string",
193 "serialNumber": "string",
194 "cost": "81.08",
195 "premiseId": 0,
196 "premiseDisplayId": "string",
197 "premiseDto": {
198 "id": 0,
199 "createdBy": "string",
200 "createdAt": "2019-08-24T14:15:22Z",
201 "displayId": "string",
202 "premiseName": "string",
203 "description": "string",
204 "address": "string",
205 "internalTeamNames": [
206 "string"
207 ],
208 "internalTeamIds": [
209 0
210 ],
211 "premiseAvailable": true,
212 "premiseFromNrm": true,
213 "nlmId": 0,
214 "nlmDisplayId": "string",
215 "nlmUsed": true,
216 "manager": 0,
217 "managerName": "string",
218 "imageId": 0,
219 "area": "string",
220 "modifiedAt": "2019-08-24T14:15:22Z"
221 },
222 "acquisitionDate": "2019-08-24",
223 "endOfLife": "2019-08-24",
224 "assetStatusId": 0,
225 "assetStatus": "string",
226 "assetStatusType": "string",
227 "parentAssetId": 0,
228 "parentAssetDisplayId": "string",
229 "parentAsset": "string",
230 "parentAssetDto": {},
231 "upcomingMaintenanceDate": "2019-08-24",
232 "assetCategoryIds": [
233 0
234 ],
235 "assetCategories": [
236 "string"
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "assignedUserIds": [
281 0
282 ],
283 "assignedUserDtos": [
284 {
285 "id": 0,
286 "createdBy": "string",
287 "createdAt": "2019-08-24T14:15:22Z",
288 "userName": "string",
289 "firstName": "string",
290 "lastName": "string",
291 "email": "string",
292 "roleIds": [
293 {
294 "id": 0,
295 "createdBy": "string",
296 "createdAt": "2019-08-24T14:15:22Z",
297 "modifiedBy": "string",
298 "modifiedAt": "2019-08-24T14:15:22Z",
299 "roleName": "string",
300 "entity": "string",
301 "new": true
302 }
303 ],
304 "internalTeamNames": [
305 "string"
306 ],
307 "internalTeamIds": [
308 0
309 ],
310 "internalTeamDisplayIds": [
311 "string"
312 ],
313 "premiseIds": [
314 0
315 ],
316 "premiseNames": [
317 "string"
318 ],
319 "userAvailable": true,
320 "temporaryWorkload": 0,
321 "preferredCultureCode": "string"
322 }
323 ],
324 "assignedUsers": [
325 "string"
326 ],
327 "assetPriority": "string",
328 "assetPriorityId": 0,
329 "assetPriorityDisplayId": "string",
330 "assetPriorityType": "string",
331 "assetAvailable": true,
332 "exactPlacement": "string",
333 "fosId": 0,
334 "downtimeStatus": "string",
335 "premiseFromNrm": true,
336 "modifiedAt": "2019-08-24T14:15:22Z"
337 }
338 ],
339 "supplierAvailable": true
340 }
341 ],
342 "number": 0,
343 "sort": {
344 "unsorted": true,
345 "sorted": true,
346 "empty": true
347 },
348 "empty": true
349}
Get All Documents By Supplier¶
HTTP Request
GET /api/suppliers/{id}/documents
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Retrieves all documents associated with a specific supplier, identified by their unique ID, to facilitate efficient management and review of supplier-related documentation.
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 "name": "string",
7 "contentType": "string",
8 "documentTypeName": "string",
9 "documentTypeId": 0,
10 "description": "string",
11 "data": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "documentStatusId": 0,
15 "documentStatus": "string",
16 "documentStatusType": "string",
17 "parentEntityId": 0,
18 "link": "string",
19 "parentEntityName": "string"
20 }
21]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.] |
|
» 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 |
» name |
string |
false |
none |
Name of the resource |
» contentType |
string |
false |
none |
Type of the content |
» documentTypeName |
string |
false |
none |
Name of the document type |
» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
» description |
string |
false |
none |
Description of the resource |
» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
» documentStatus |
string |
false |
none |
Status of the document |
» documentStatusType |
string |
false |
none |
Type of the document status |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
» parentEntityName |
string |
true |
none |
Name of the parent entity |
Get Asset Part By ID¶
HTTP Request
GET /api/suppliers/{id}/assetParts/{assetPartId}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches detailed information about a specific asset part associated with a given supplier, enabling users to effectively manage and assess supplier-related assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetPartId |
path |
integer(int64) |
true |
Unique identifier for the asset part |
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 "imageId": 0,
9 "premiseId": 0,
10 "premiseDisplayId": "string",
11 "premiseDto": {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "premiseName": "string",
17 "description": "string",
18 "address": "string",
19 "internalTeamNames": [
20 "string"
21 ],
22 "internalTeamIds": [
23 0
24 ],
25 "premiseAvailable": true,
26 "premiseFromNrm": true,
27 "nlmId": 0,
28 "nlmDisplayId": "string",
29 "nlmUsed": true,
30 "manager": 0,
31 "managerName": "string",
32 "imageId": 0,
33 "area": "string",
34 "modifiedAt": "2019-08-24T14:15:22Z"
35 },
36 "premiseFromNrm": true,
37 "model": "string",
38 "unitCost": "67.08",
39 "serialNumber": "string",
40 "qrCode": "string",
41 "quantityOnHand": 0,
42 "reOrderPoint": 0,
43 "size": "string",
44 "color": "string",
45 "weight": "24.08",
46 "length": "11.5",
47 "width": "16.9",
48 "height": "12.3",
49 "materialType": "string",
50 "assetPartType": "string",
51 "assetPartTypeId": 0,
52 "assetPartManufacturer": {
53 "id": 0,
54 "createdBy": "string",
55 "createdAt": "2019-08-24T14:15:22Z",
56 "name": "string",
57 "assetParts": [
58 {
59 "id": 0,
60 "createdBy": "string",
61 "createdAt": "2019-08-24T14:15:22Z",
62 "displayId": "string",
63 "name": "string",
64 "description": "string",
65 "imageId": 0,
66 "premiseId": 0,
67 "premiseDisplayId": "string",
68 "premiseDto": {
69 "id": 0,
70 "createdBy": "string",
71 "createdAt": "2019-08-24T14:15:22Z",
72 "displayId": "string",
73 "premiseName": "string",
74 "description": "string",
75 "address": "string",
76 "internalTeamNames": [
77 "string"
78 ],
79 "internalTeamIds": [
80 0
81 ],
82 "premiseAvailable": true,
83 "premiseFromNrm": true,
84 "nlmId": 0,
85 "nlmDisplayId": "string",
86 "nlmUsed": true,
87 "manager": 0,
88 "managerName": "string",
89 "imageId": 0,
90 "area": "string",
91 "modifiedAt": "2019-08-24T14:15:22Z"
92 },
93 "premiseFromNrm": true,
94 "model": "string",
95 "unitCost": "67.08",
96 "serialNumber": "string",
97 "qrCode": "string",
98 "quantityOnHand": 0,
99 "reOrderPoint": 0,
100 "size": "string",
101 "color": "string",
102 "weight": "24.08",
103 "length": "11.5",
104 "width": "16.9",
105 "height": "12.3",
106 "materialType": "string",
107 "assetPartType": "string",
108 "assetPartTypeId": 0,
109 "assetPartManufacturer": {},
110 "variableQuantity": 0,
111 "assetPartAvailable": true,
112 "owner": 0,
113 "ownerDto": {
114 "id": 0,
115 "createdBy": "string",
116 "createdAt": "2019-08-24T14:15:22Z",
117 "userName": "string",
118 "firstName": "string",
119 "lastName": "string",
120 "email": "string",
121 "roleIds": [
122 {
123 "id": 0,
124 "createdBy": "string",
125 "createdAt": "2019-08-24T14:15:22Z",
126 "modifiedBy": "string",
127 "modifiedAt": "2019-08-24T14:15:22Z",
128 "roleName": "string",
129 "entity": "string",
130 "new": true
131 }
132 ],
133 "internalTeamNames": [
134 "string"
135 ],
136 "internalTeamIds": [
137 0
138 ],
139 "internalTeamDisplayIds": [
140 "string"
141 ],
142 "premiseIds": [
143 0
144 ],
145 "premiseNames": [
146 "string"
147 ],
148 "userAvailable": true,
149 "temporaryWorkload": 0,
150 "preferredCultureCode": "string"
151 },
152 "ownerUserName": "string",
153 "modifiedAt": "2019-08-24T14:15:22Z",
154 "isPartsSufficient": true
155 }
156 ]
157 },
158 "variableQuantity": 0,
159 "assetPartAvailable": true,
160 "owner": 0,
161 "ownerDto": {
162 "id": 0,
163 "createdBy": "string",
164 "createdAt": "2019-08-24T14:15:22Z",
165 "userName": "string",
166 "firstName": "string",
167 "lastName": "string",
168 "email": "string",
169 "roleIds": [
170 {
171 "id": 0,
172 "createdBy": "string",
173 "createdAt": "2019-08-24T14:15:22Z",
174 "modifiedBy": "string",
175 "modifiedAt": "2019-08-24T14:15:22Z",
176 "roleName": "string",
177 "entity": "string",
178 "new": true
179 }
180 ],
181 "internalTeamNames": [
182 "string"
183 ],
184 "internalTeamIds": [
185 0
186 ],
187 "internalTeamDisplayIds": [
188 "string"
189 ],
190 "premiseIds": [
191 0
192 ],
193 "premiseNames": [
194 "string"
195 ],
196 "userAvailable": true,
197 "temporaryWorkload": 0,
198 "preferredCultureCode": "string"
199 },
200 "ownerUserName": "string",
201 "modifiedAt": "2019-08-24T14:15:22Z",
202 "isPartsSufficient": true
203}
Get All Asset Categories By Supplier ID¶
HTTP Request
GET /api/suppliers/{id}/assetCategories
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches the asset categories associated with a specific supplier, enabling users to efficiently manage and categorize supplier-related assets.
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 "objectAvailable": true
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a classification of assets within the organization, facilitating effective asset management and reporting by categorizing assets based on their characteristics and usage.] |
|
» 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 |
» objectAvailable |
boolean |
false |
none |
Indicates whether the asset category is currently available for allocation within the system. |
Get All Supplier Status¶
HTTP Request
GET /api/suppliers/status
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches the current status of suppliers, providing insights into their operational performance and availability to support informed decision-making.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "ACTIVE"
3]
Response Schema
Get All Suppliers By Status¶
HTTP Request
GET /api/suppliers/status/{status}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches a list of suppliers based on their current status, enabling efficient management and oversight of supplier relationships.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
status |
path |
string |
true |
Status of 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 "name": "string",
7 "address": "string",
8 "status": "ACTIVE",
9 "assetCategories": [
10 {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "objectAvailable": true
17 }
18 ],
19 "supplierContacts": [
20 {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "name": "string",
25 "designation": "string",
26 "phone": "string",
27 "email": "string",
28 "supplierId": 0,
29 "supplierContactAvailable": true
30 }
31 ],
32 "documents": [
33 {
34 "id": 0,
35 "createdBy": "string",
36 "createdAt": "2019-08-24T14:15:22Z",
37 "name": "string",
38 "contentType": "string",
39 "documentTypeName": "string",
40 "documentTypeId": 0,
41 "description": "string",
42 "data": "string",
43 "startDate": "2019-08-24",
44 "endDate": "2019-08-24",
45 "documentStatusId": 0,
46 "documentStatus": "string",
47 "documentStatusType": "string",
48 "parentEntityId": 0,
49 "link": "string",
50 "parentEntityName": "string"
51 }
52 ],
53 "assetParts": [
54 {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "imageId": 0,
62 "premiseId": 0,
63 "premiseDisplayId": "string",
64 "premiseDto": {
65 "id": 0,
66 "createdBy": "string",
67 "createdAt": "2019-08-24T14:15:22Z",
68 "displayId": "string",
69 "premiseName": "string",
70 "description": "string",
71 "address": "string",
72 "internalTeamNames": [
73 "string"
74 ],
75 "internalTeamIds": [
76 0
77 ],
78 "premiseAvailable": true,
79 "premiseFromNrm": true,
80 "nlmId": 0,
81 "nlmDisplayId": "string",
82 "nlmUsed": true,
83 "manager": 0,
84 "managerName": "string",
85 "imageId": 0,
86 "area": "string",
87 "modifiedAt": "2019-08-24T14:15:22Z"
88 },
89 "premiseFromNrm": true,
90 "model": "string",
91 "unitCost": "67.08",
92 "serialNumber": "string",
93 "qrCode": "string",
94 "quantityOnHand": 0,
95 "reOrderPoint": 0,
96 "size": "string",
97 "color": "string",
98 "weight": "24.08",
99 "length": "11.5",
100 "width": "16.9",
101 "height": "12.3",
102 "materialType": "string",
103 "assetPartType": "string",
104 "assetPartTypeId": 0,
105 "assetPartManufacturer": {
106 "id": 0,
107 "createdBy": "string",
108 "createdAt": "2019-08-24T14:15:22Z",
109 "name": "string",
110 "assetParts": [
111 {}
112 ]
113 },
114 "variableQuantity": 0,
115 "assetPartAvailable": true,
116 "owner": 0,
117 "ownerDto": {
118 "id": 0,
119 "createdBy": "string",
120 "createdAt": "2019-08-24T14:15:22Z",
121 "userName": "string",
122 "firstName": "string",
123 "lastName": "string",
124 "email": "string",
125 "roleIds": [
126 {
127 "id": 0,
128 "createdBy": "string",
129 "createdAt": "2019-08-24T14:15:22Z",
130 "modifiedBy": "string",
131 "modifiedAt": "2019-08-24T14:15:22Z",
132 "roleName": "string",
133 "entity": "string",
134 "new": true
135 }
136 ],
137 "internalTeamNames": [
138 "string"
139 ],
140 "internalTeamIds": [
141 0
142 ],
143 "internalTeamDisplayIds": [
144 "string"
145 ],
146 "premiseIds": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "userAvailable": true,
153 "temporaryWorkload": 0,
154 "preferredCultureCode": "string"
155 },
156 "ownerUserName": "string",
157 "modifiedAt": "2019-08-24T14:15:22Z",
158 "isPartsSufficient": true
159 }
160 ],
161 "mainAssets": [
162 {
163 "id": 0,
164 "createdBy": "string",
165 "createdAt": "2019-08-24T14:15:22Z",
166 "displayId": "string",
167 "name": "string",
168 "description": "string",
169 "qrCode": "string",
170 "barCode": "string",
171 "imageId": 0,
172 "model": "string",
173 "manufacturer": "string",
174 "serialNumber": "string",
175 "cost": "81.08",
176 "premiseId": 0,
177 "premiseDisplayId": "string",
178 "premiseDto": {
179 "id": 0,
180 "createdBy": "string",
181 "createdAt": "2019-08-24T14:15:22Z",
182 "displayId": "string",
183 "premiseName": "string",
184 "description": "string",
185 "address": "string",
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "premiseAvailable": true,
193 "premiseFromNrm": true,
194 "nlmId": 0,
195 "nlmDisplayId": "string",
196 "nlmUsed": true,
197 "manager": 0,
198 "managerName": "string",
199 "imageId": 0,
200 "area": "string",
201 "modifiedAt": "2019-08-24T14:15:22Z"
202 },
203 "acquisitionDate": "2019-08-24",
204 "endOfLife": "2019-08-24",
205 "assetStatusId": 0,
206 "assetStatus": "string",
207 "assetStatusType": "string",
208 "parentAssetId": 0,
209 "parentAssetDisplayId": "string",
210 "parentAsset": "string",
211 "parentAssetDto": {},
212 "upcomingMaintenanceDate": "2019-08-24",
213 "assetCategoryIds": [
214 0
215 ],
216 "assetCategories": [
217 "string"
218 ],
219 "internalTeamIds": [
220 0
221 ],
222 "internalTeamDtos": [
223 {
224 "id": 0,
225 "createdBy": "string",
226 "createdAt": "2019-08-24T14:15:22Z",
227 "displayId": "string",
228 "name": "string",
229 "email": "string",
230 "phone": "string",
231 "manager": "string",
232 "requestCategoryName": [
233 "string"
234 ],
235 "requestCategoryId": [
236 0
237 ],
238 "requestCategoryDisplayId": [
239 "string"
240 ],
241 "description": "string",
242 "internalTeamUser": [
243 0
244 ],
245 "members": 0,
246 "mainAssets": [
247 0
248 ],
249 "premiseNames": [
250 "string"
251 ],
252 "internalTeamAvailable": true,
253 "premiseIds": [
254 0
255 ]
256 }
257 ],
258 "internalTeams": [
259 "string"
260 ],
261 "assignedUserIds": [
262 0
263 ],
264 "assignedUserDtos": [
265 {
266 "id": 0,
267 "createdBy": "string",
268 "createdAt": "2019-08-24T14:15:22Z",
269 "userName": "string",
270 "firstName": "string",
271 "lastName": "string",
272 "email": "string",
273 "roleIds": [
274 {
275 "id": 0,
276 "createdBy": "string",
277 "createdAt": "2019-08-24T14:15:22Z",
278 "modifiedBy": "string",
279 "modifiedAt": "2019-08-24T14:15:22Z",
280 "roleName": "string",
281 "entity": "string",
282 "new": true
283 }
284 ],
285 "internalTeamNames": [
286 "string"
287 ],
288 "internalTeamIds": [
289 0
290 ],
291 "internalTeamDisplayIds": [
292 "string"
293 ],
294 "premiseIds": [
295 0
296 ],
297 "premiseNames": [
298 "string"
299 ],
300 "userAvailable": true,
301 "temporaryWorkload": 0,
302 "preferredCultureCode": "string"
303 }
304 ],
305 "assignedUsers": [
306 "string"
307 ],
308 "assetPriority": "string",
309 "assetPriorityId": 0,
310 "assetPriorityDisplayId": "string",
311 "assetPriorityType": "string",
312 "assetAvailable": true,
313 "exactPlacement": "string",
314 "fosId": 0,
315 "downtimeStatus": "string",
316 "premiseFromNrm": true,
317 "modifiedAt": "2019-08-24T14:15:22Z"
318 }
319 ],
320 "supplierAvailable": true
321 }
322]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a supplier’s essential information, including contact details, business classification, and compliance status, to facilitate efficient vendor management and procurement 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 |
» name |
string |
false |
none |
Name of the resource |
» address |
string |
false |
none |
Represents the physical location of the supplier, essential for logistics and communication purposes. |
» status |
string |
false |
none |
Status of the resource |
» assetCategories |
false |
none |
Array of asset categories associated with the supplier, facilitating the classification and management of supplier-related assets. |
|
»» 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 |
»» objectAvailable |
boolean |
false |
none |
Indicates whether the asset category is currently available for allocation within the system. |
» supplierContacts |
false |
none |
An array of contact details for suppliers, facilitating effective communication and relationship management within the supply chain. |
|
»» 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 |
»» name |
string |
false |
none |
Name of the resource |
»» designation |
string |
false |
none |
Represents the job title or role of the contact person associated with the supplier, facilitating effective communication and relationship management. |
»» phone |
string |
false |
none |
Contact phone number for the supplier, used to facilitate communication and coordination. |
string |
false |
none |
Email address of the supplier contact, used for communication and correspondence related to supplier management. |
|
»» supplierId |
integer(int64) |
false |
none |
Unique identifier for the supplier |
»» supplierContactAvailable |
boolean |
false |
none |
Indicates whether a contact person for the supplier is available, facilitating effective communication and relationship management. |
» documents |
false |
none |
An array of SupplierDTO objects representing the documents associated with the supplier, essential for managing supplier-related information 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 |
»» name |
string |
false |
none |
Name of the resource |
»» contentType |
string |
false |
none |
Type of the content |
»» documentTypeName |
string |
false |
none |
Name of the document type |
»» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
»» description |
string |
false |
none |
Description of the resource |
»» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
»» documentStatus |
string |
false |
none |
Status of the document |
»» documentStatusType |
string |
false |
none |
Type of the document status |
»» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
»» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
»» parentEntityName |
string |
true |
none |
Name of the parent entity |
» assetParts |
false |
none |
Array of SupplierDTO objects representing the individual components or parts associated with an asset, facilitating comprehensive asset management and supplier collaboration. |
|
»» 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 |
»» description |
string |
false |
none |
Description of the resource |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» 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 |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset part originates from the National Resource Management (NRM) framework, facilitating compliance and reporting requirements. |
»» model |
string |
false |
none |
Represents the specific model associated with the asset part, facilitating accurate identification and management within the system. |
»» unitCost |
string |
false |
none |
Represents the cost per unit of the asset part, essential for accurate budgeting and financial analysis within asset management. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset part, facilitating efficient tracking and management within the asset management system. |
»» qrCode |
string |
false |
none |
Code for the qr |
»» quantityOnHand |
integer(int64) |
false |
none |
Represents the current inventory level of the asset part, indicating the quantity available for use or sale. |
»» reOrderPoint |
integer(int64) |
false |
none |
Reorder point indicates the inventory level at which new stock should be ordered to prevent stockouts and ensure continuous availability of asset parts. |
»» size |
string |
false |
none |
Number of items per page |
»» color |
string |
false |
none |
Represents the color attribute associated with the asset part, providing essential visual differentiation for inventory management and asset tracking. |
»» weight |
string |
false |
none |
Represents the weight of the asset part, providing essential information for inventory management and logistics optimization. |
»» length |
string |
false |
none |
Specifies the length of the asset part, providing essential information for inventory management and resource allocation. |
»» width |
string |
false |
none |
Specifies the width dimension of the asset part, facilitating accurate representation and management of asset specifications. |
»» height |
string |
false |
none |
Specifies the height of the asset part, providing essential dimensional information for inventory and asset management. |
»» materialType |
string |
false |
none |
Type of the material |
»» assetPartType |
string |
false |
none |
Type of the asset part |
»» assetPartTypeId |
integer(int64) |
false |
none |
Unique identifier for the asset part type |
»» assetPartManufacturer |
false |
none |
Data transfer object representing the manufacturer details of an asset part, including essential identification and classification information to facilitate inventory management and procurement 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 |
»»» name |
string |
false |
none |
Name of the resource |
»»» assetParts |
false |
none |
An array of asset parts, represented by AssetPartManufacturerDTO, that details the components associated with each asset for effective inventory and resource management. |
|
»» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
»» assetPartAvailable |
boolean |
false |
none |
Indicates whether the specific asset part is currently available for allocation or use within the system. |
»» owner |
integer(int64) |
false |
none |
Unique identifier for the owner of the asset part, facilitating asset management and accountability within the system. |
»» ownerDto |
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 |
»» ownerUserName |
string |
false |
none |
Name of the owner user |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» isPartsSufficient |
boolean |
false |
none |
Whether the resource is parts sufficient |
» mainAssets |
false |
none |
Collection of primary assets associated with the supplier, facilitating effective management and evaluation of supplier capabilities. |
|
»» 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. |
|
»» 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. |
|
»» 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 |
» supplierAvailable |
boolean |
false |
none |
Indicates whether the supplier is currently available for new engagements. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, INACTIVE |