Asset Part Manufacturer Resource

Get Asset Part Manufacturer

HTTP Request

GET /api/assetPartManufacturers/{id}

📋 Description: Retrieves detailed information about a specific asset part manufacturer identified by the provided ID, enabling users to access essential data for inventory management and supplier evaluation.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssetPartManufacturerDTO

Example Responses

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "name": "string",
  6  "assetParts": [
  7    {
  8      "id": 0,
  9      "createdBy": "string",
 10      "createdAt": "2019-08-24T14:15:22Z",
 11      "displayId": "string",
 12      "name": "string",
 13      "description": "string",
 14      "imageId": 0,
 15      "premiseId": 0,
 16      "premiseDisplayId": "string",
 17      "premiseDto": {
 18        "id": 0,
 19        "createdBy": "string",
 20        "createdAt": "2019-08-24T14:15:22Z",
 21        "displayId": "string",
 22        "premiseName": "string",
 23        "description": "string",
 24        "address": "string",
 25        "internalTeamNames": [
 26          "string"
 27        ],
 28        "internalTeamIds": [
 29          0
 30        ],
 31        "premiseAvailable": true,
 32        "premiseFromNrm": true,
 33        "nlmId": 0,
 34        "nlmDisplayId": "string",
 35        "nlmUsed": true,
 36        "manager": 0,
 37        "managerName": "string",
 38        "imageId": 0,
 39        "area": "string",
 40        "modifiedAt": "2019-08-24T14:15:22Z"
 41      },
 42      "premiseFromNrm": true,
 43      "model": "string",
 44      "unitCost": "67.08",
 45      "serialNumber": "string",
 46      "qrCode": "string",
 47      "quantityOnHand": 0,
 48      "reOrderPoint": 0,
 49      "size": "string",
 50      "color": "string",
 51      "weight": "24.08",
 52      "length": "11.5",
 53      "width": "16.9",
 54      "height": "12.3",
 55      "materialType": "string",
 56      "assetPartType": "string",
 57      "assetPartTypeId": 0,
 58      "assetPartManufacturer": {
 59        "id": 0,
 60        "createdBy": "string",
 61        "createdAt": "2019-08-24T14:15:22Z",
 62        "name": "string",
 63        "assetParts": []
 64      },
 65      "variableQuantity": 0,
 66      "assetPartAvailable": true,
 67      "owner": 0,
 68      "ownerDto": {
 69        "id": 0,
 70        "createdBy": "string",
 71        "createdAt": "2019-08-24T14:15:22Z",
 72        "userName": "string",
 73        "firstName": "string",
 74        "lastName": "string",
 75        "email": "string",
 76        "roleIds": [
 77          {
 78            "id": 0,
 79            "createdBy": "string",
 80            "createdAt": "2019-08-24T14:15:22Z",
 81            "modifiedBy": "string",
 82            "modifiedAt": "2019-08-24T14:15:22Z",
 83            "roleName": "string",
 84            "entity": "string",
 85            "new": true
 86          }
 87        ],
 88        "internalTeamNames": [
 89          "string"
 90        ],
 91        "internalTeamIds": [
 92          0
 93        ],
 94        "internalTeamDisplayIds": [
 95          "string"
 96        ],
 97        "premiseIds": [
 98          0
 99        ],
100        "premiseNames": [
101          "string"
102        ],
103        "userAvailable": true,
104        "temporaryWorkload": 0,
105        "preferredCultureCode": "string"
106      },
107      "ownerUserName": "string",
108      "modifiedAt": "2019-08-24T14:15:22Z",
109      "isPartsSufficient": true
110    }
111  ]
112}

Update Asset Part Manufacturer

HTTP Request

PUT /api/assetPartManufacturers/{id}

📋 Description: Updates the details of a specific asset part manufacturer identified by the provided ID, allowing for modifications to essential information to ensure accurate records and compliance.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

AssetPartManufacturerDTO

true

Request body containing the updated details of the asset part manufacturer, including name, contact information, and relevant metadata for effective asset management.

Body Parameters

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "name": "string",
  6  "assetParts": [
  7    {
  8      "id": 0,
  9      "createdBy": "string",
 10      "createdAt": "2019-08-24T14:15:22Z",
 11      "displayId": "string",
 12      "name": "string",
 13      "description": "string",
 14      "imageId": 0,
 15      "premiseId": 0,
 16      "premiseDisplayId": "string",
 17      "premiseDto": {
 18        "id": 0,
 19        "createdBy": "string",
 20        "createdAt": "2019-08-24T14:15:22Z",
 21        "displayId": "string",
 22        "premiseName": "string",
 23        "description": "string",
 24        "address": "string",
 25        "internalTeamNames": [
 26          "string"
 27        ],
 28        "internalTeamIds": [
 29          0
 30        ],
 31        "premiseAvailable": true,
 32        "premiseFromNrm": true,
 33        "nlmId": 0,
 34        "nlmDisplayId": "string",
 35        "nlmUsed": true,
 36        "manager": 0,
 37        "managerName": "string",
 38        "imageId": 0,
 39        "area": "string",
 40        "modifiedAt": "2019-08-24T14:15:22Z"
 41      },
 42      "premiseFromNrm": true,
 43      "model": "string",
 44      "unitCost": "67.08",
 45      "serialNumber": "string",
 46      "qrCode": "string",
 47      "quantityOnHand": 0,
 48      "reOrderPoint": 0,
 49      "size": "string",
 50      "color": "string",
 51      "weight": "24.08",
 52      "length": "11.5",
 53      "width": "16.9",
 54      "height": "12.3",
 55      "materialType": "string",
 56      "assetPartType": "string",
 57      "assetPartTypeId": 0,
 58      "assetPartManufacturer": {
 59        "id": 0,
 60        "createdBy": "string",
 61        "createdAt": "2019-08-24T14:15:22Z",
 62        "name": "string",
 63        "assetParts": []
 64      },
 65      "variableQuantity": 0,
 66      "assetPartAvailable": true,
 67      "owner": 0,
 68      "ownerDto": {
 69        "id": 0,
 70        "createdBy": "string",
 71        "createdAt": "2019-08-24T14:15:22Z",
 72        "userName": "string",
 73        "firstName": "string",
 74        "lastName": "string",
 75        "email": "string",
 76        "roleIds": [
 77          {
 78            "id": 0,
 79            "createdBy": "string",
 80            "createdAt": "2019-08-24T14:15:22Z",
 81            "modifiedBy": "string",
 82            "modifiedAt": "2019-08-24T14:15:22Z",
 83            "roleName": "string",
 84            "entity": "string",
 85            "new": true
 86          }
 87        ],
 88        "internalTeamNames": [
 89          "string"
 90        ],
 91        "internalTeamIds": [
 92          0
 93        ],
 94        "internalTeamDisplayIds": [
 95          "string"
 96        ],
 97        "premiseIds": [
 98          0
 99        ],
100        "premiseNames": [
101          "string"
102        ],
103        "userAvailable": true,
104        "temporaryWorkload": 0,
105        "preferredCultureCode": "string"
106      },
107      "ownerUserName": "string",
108      "modifiedAt": "2019-08-24T14:15:22Z",
109      "isPartsSufficient": true
110    }
111  ]
112}

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Delete Asset Part Manufacturer

HTTP Request

DELETE /api/assetPartManufacturers/{id}

📋 Description: Deletes a specified asset part manufacturer from the system, ensuring that all associated data is removed and maintaining data integrity within the asset management framework.

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 Manufacturers

HTTP Request

GET /api/assetPartManufacturers

📋 Description: Retrieves a list of asset part manufacturers, providing essential information for procurement and supply chain management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1[
  2  {
  3    "id": 0,
  4    "createdBy": "string",
  5    "createdAt": "2019-08-24T14:15:22Z",
  6    "name": "string",
  7    "assetParts": [
  8      {
  9        "id": 0,
 10        "createdBy": "string",
 11        "createdAt": "2019-08-24T14:15:22Z",
 12        "displayId": "string",
 13        "name": "string",
 14        "description": "string",
 15        "imageId": 0,
 16        "premiseId": 0,
 17        "premiseDisplayId": "string",
 18        "premiseDto": {
 19          "id": 0,
 20          "createdBy": "string",
 21          "createdAt": "2019-08-24T14:15:22Z",
 22          "displayId": "string",
 23          "premiseName": "string",
 24          "description": "string",
 25          "address": "string",
 26          "internalTeamNames": [
 27            "string"
 28          ],
 29          "internalTeamIds": [
 30            0
 31          ],
 32          "premiseAvailable": true,
 33          "premiseFromNrm": true,
 34          "nlmId": 0,
 35          "nlmDisplayId": "string",
 36          "nlmUsed": true,
 37          "manager": 0,
 38          "managerName": "string",
 39          "imageId": 0,
 40          "area": "string",
 41          "modifiedAt": "2019-08-24T14:15:22Z"
 42        },
 43        "premiseFromNrm": true,
 44        "model": "string",
 45        "unitCost": "67.08",
 46        "serialNumber": "string",
 47        "qrCode": "string",
 48        "quantityOnHand": 0,
 49        "reOrderPoint": 0,
 50        "size": "string",
 51        "color": "string",
 52        "weight": "24.08",
 53        "length": "11.5",
 54        "width": "16.9",
 55        "height": "12.3",
 56        "materialType": "string",
 57        "assetPartType": "string",
 58        "assetPartTypeId": 0,
 59        "assetPartManufacturer": {},
 60        "variableQuantity": 0,
 61        "assetPartAvailable": true,
 62        "owner": 0,
 63        "ownerDto": {
 64          "id": 0,
 65          "createdBy": "string",
 66          "createdAt": "2019-08-24T14:15:22Z",
 67          "userName": "string",
 68          "firstName": "string",
 69          "lastName": "string",
 70          "email": "string",
 71          "roleIds": [
 72            {
 73              "id": 0,
 74              "createdBy": "string",
 75              "createdAt": "2019-08-24T14:15:22Z",
 76              "modifiedBy": "string",
 77              "modifiedAt": "2019-08-24T14:15:22Z",
 78              "roleName": "string",
 79              "entity": "string",
 80              "new": true
 81            }
 82          ],
 83          "internalTeamNames": [
 84            "string"
 85          ],
 86          "internalTeamIds": [
 87            0
 88          ],
 89          "internalTeamDisplayIds": [
 90            "string"
 91          ],
 92          "premiseIds": [
 93            0
 94          ],
 95          "premiseNames": [
 96            "string"
 97          ],
 98          "userAvailable": true,
 99          "temporaryWorkload": 0,
100          "preferredCultureCode": "string"
101        },
102        "ownerUserName": "string",
103        "modifiedAt": "2019-08-24T14:15:22Z",
104        "isPartsSufficient": true
105      }
106    ]
107  }
108]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[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.

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

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

Create Asset Part Manufacturer

HTTP Request

POST /api/assetPartManufacturers

📋 Description: Creates a new asset part manufacturer entry in the system, allowing businesses to manage and track their manufacturing partners effectively.

Parameters

Name

In

Type

Required

Description

body

body

AssetPartManufacturerDTO

true

Request body containing the asset part manufacturer details, including identification, specifications, and relevant business attributes for effective asset management.

Body Parameters

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "name": "string",
  6  "assetParts": [
  7    {
  8      "id": 0,
  9      "createdBy": "string",
 10      "createdAt": "2019-08-24T14:15:22Z",
 11      "displayId": "string",
 12      "name": "string",
 13      "description": "string",
 14      "imageId": 0,
 15      "premiseId": 0,
 16      "premiseDisplayId": "string",
 17      "premiseDto": {
 18        "id": 0,
 19        "createdBy": "string",
 20        "createdAt": "2019-08-24T14:15:22Z",
 21        "displayId": "string",
 22        "premiseName": "string",
 23        "description": "string",
 24        "address": "string",
 25        "internalTeamNames": [
 26          "string"
 27        ],
 28        "internalTeamIds": [
 29          0
 30        ],
 31        "premiseAvailable": true,
 32        "premiseFromNrm": true,
 33        "nlmId": 0,
 34        "nlmDisplayId": "string",
 35        "nlmUsed": true,
 36        "manager": 0,
 37        "managerName": "string",
 38        "imageId": 0,
 39        "area": "string",
 40        "modifiedAt": "2019-08-24T14:15:22Z"
 41      },
 42      "premiseFromNrm": true,
 43      "model": "string",
 44      "unitCost": "67.08",
 45      "serialNumber": "string",
 46      "qrCode": "string",
 47      "quantityOnHand": 0,
 48      "reOrderPoint": 0,
 49      "size": "string",
 50      "color": "string",
 51      "weight": "24.08",
 52      "length": "11.5",
 53      "width": "16.9",
 54      "height": "12.3",
 55      "materialType": "string",
 56      "assetPartType": "string",
 57      "assetPartTypeId": 0,
 58      "assetPartManufacturer": {
 59        "id": 0,
 60        "createdBy": "string",
 61        "createdAt": "2019-08-24T14:15:22Z",
 62        "name": "string",
 63        "assetParts": []
 64      },
 65      "variableQuantity": 0,
 66      "assetPartAvailable": true,
 67      "owner": 0,
 68      "ownerDto": {
 69        "id": 0,
 70        "createdBy": "string",
 71        "createdAt": "2019-08-24T14:15:22Z",
 72        "userName": "string",
 73        "firstName": "string",
 74        "lastName": "string",
 75        "email": "string",
 76        "roleIds": [
 77          {
 78            "id": 0,
 79            "createdBy": "string",
 80            "createdAt": "2019-08-24T14:15:22Z",
 81            "modifiedBy": "string",
 82            "modifiedAt": "2019-08-24T14:15:22Z",
 83            "roleName": "string",
 84            "entity": "string",
 85            "new": true
 86          }
 87        ],
 88        "internalTeamNames": [
 89          "string"
 90        ],
 91        "internalTeamIds": [
 92          0
 93        ],
 94        "internalTeamDisplayIds": [
 95          "string"
 96        ],
 97        "premiseIds": [
 98          0
 99        ],
100        "premiseNames": [
101          "string"
102        ],
103        "userAvailable": true,
104        "temporaryWorkload": 0,
105        "preferredCultureCode": "string"
106      },
107      "ownerUserName": "string",
108      "modifiedAt": "2019-08-24T14:15:22Z",
109      "isPartsSufficient": true
110    }
111  ]
112}

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer

Example Responses

10