Asset Part Order Resource

Get Asset Part Order

HTTP Request

GET /api/assetPartOrders/{id}

📋 Description: Retrieves detailed information about a specific asset part order identified by the provided ID, enabling users to access order status and related data for effective inventory management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssetPartOrderDTO

Update Asset Part Order

HTTP Request

PUT /api/assetPartOrders/{id}

📋 Description: Updates the details of a specific asset part order identified by the provided ID, allowing for modifications to order information as necessary to reflect current business requirements.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

AssetPartOrderDTO

true

Request body containing the updated details of the asset part order, including quantity, status, and any relevant metadata for processing.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Delete Asset Part Order

HTTP Request

DELETE /api/assetPartOrders/{id}

📋 Description: Deletes a specified asset part order from the system, ensuring that inventory and order management remain accurate and up-to-date.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Get All Asset Part Orders

HTTP Request

GET /api/assetPartOrders

📋 Description: Retrieves a list of asset part orders, allowing users to access detailed information about each order for effective inventory and supply chain management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[AssetPartOrderDTO]

false

none

[Data transfer object representing the details of an asset part order, including relevant specifications and quantities, to facilitate efficient 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

» orderDate

string(date)

false

none

Date of the order

» quantity

integer(int64)

false

none

Quantity value

» unitPrice

string

false

none

Represents the price per unit of the asset part being ordered, facilitating accurate cost estimation and budgeting in procurement processes.

» assetPart

AssetPartDTO

false

none

Data transfer object representing a component of an asset, detailing its specifications and associated metadata for effective asset management and tracking within the enterprise.

»» 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

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

AssetPartManufacturerDTO

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

[AssetPartDTO]

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

UserDTO

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

»»» email

string

false

none

Email address of the user, used for communication and account verification purposes within the system.

»»» roleIds

[Role]

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

» supplier

SupplierDTO

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

[AssetCategoryDTO]

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

[SupplierContactDTO]

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.

»»» email

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

[DocumentDTO]

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

[AssetPartDTO]

false

none

Array of SupplierDTO objects representing the individual components or parts associated with an asset, facilitating comprehensive asset management and supplier collaboration.

»» mainAssets

[MainAssetDTO]

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

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

MainAssetDTO

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

[InternalTeamDTO]

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

»»»» email

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

[UserDTO]

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.

» purchaseOrder

PurchaseOrderDTO

false

none

Data transfer object representing a purchase order, encapsulating essential details such as order items, quantities, pricing, and vendor information to facilitate efficient 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

»» 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

»» estimatedCost

string

false

none

Estimated cost of the purchase order, providing a projected financial commitment for budgeting and approval processes.

»» purchaseOrderNumber

string

false

none

Unique identifier for the purchase order, facilitating tracking and management of procurement transactions within the system.

»» initiatedAt

string(date-time)

false

none

Timestamp indicating when the purchase order was initiated, providing essential context for tracking order timelines.

»» initiatedBy

string

false

none

Identifier of the user or system that initiated the purchase order, providing context for accountability and traceability in procurement processes.

»» approvedAt

string(date-time)

false

none

Timestamp indicating when the purchase order was approved, providing a record for auditing and compliance purposes.

»» approvedBy

string

false

none

Identifier of the individual or entity that has authorized the purchase order, ensuring compliance with approval processes.

»» orderDate

string(date)

false

none

Date of the order

»» dueDate

string(date)

false

none

Due date of the resource

»» supplierId

integer(int64)

false

none

Unique identifier for the supplier

»» supplier

string

false

none

Name of the supplier associated with the purchase order, facilitating the identification and management of vendor relationships.

»» assetPartOrders

[integer]

false

none

An array of purchase orders associated with asset parts, facilitating the management and tracking of procurement activities within the asset lifecycle.

»» purchaseOrderItems

[integer]

false

none

An array of items included in the purchase order, detailing each product or service requested for procurement.

»» purchaseOrderStatusId

integer(int64)

false

none

Unique identifier for the purchase order status

»» purchaseOrderStatus

string

false

none

Status of the purchase order

»» workOrderPriorityId

integer(int64)

false

none

Unique identifier for the work order priority

»» workOrderPriority

string

false

none

Priority of the work order

»» assignedUserIds

[integer]

false

none

Array of unique identifiers for users assigned to manage or oversee the purchase order, facilitating accountability and tracking within the procurement process.

Enumerated Values

Attribute

Value

status

ACTIVE, INACTIVE

Create Asset Part Order

HTTP Request

POST /api/assetPartOrders

📋 Description: Creates a new asset part order, allowing businesses to efficiently manage inventory and streamline procurement processes.

Parameters

Name

In

Type

Required

Description

body

body

AssetPartOrderDTO

true

Request body containing the details of asset part orders, including item specifications, quantities, and associated metadata for inventory management.

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer