> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # maintainx-assets > MaintainX Assets — manage assets, statuses, criticalities, and custom statuses **Server path:** `/maintainx-assets` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------- | ----------------------------------- | | [`maintainx_assets_create_assetcustomstatuses`](#maintainx_assets_create_assetcustomstatuses) | Create new asset custom status type | | [`maintainx_assets_create_assets`](#maintainx_assets_create_assets) | Create new asset | | [`maintainx_assets_delete_assetcustomstatuses`](#maintainx_assets_delete_assetcustomstatuses) | Delete asset custom status | | [`maintainx_assets_delete_assets`](#maintainx_assets_delete_assets) | Delete asset | | [`maintainx_assets_delete_attachments`](#maintainx_assets_delete_attachments) | Remove asset attachment | | [`maintainx_assets_get_assetcriticalities`](#maintainx_assets_get_assetcriticalities) | Get asset criticality | | [`maintainx_assets_get_assetcustomstatuses`](#maintainx_assets_get_assetcustomstatuses) | Get asset custom status | | [`maintainx_assets_get_assets`](#maintainx_assets_get_assets) | Get asset | | [`maintainx_assets_list_assetcriticalities`](#maintainx_assets_list_assetcriticalities) | List asset criticalities | | [`maintainx_assets_list_assetcustomstatuses`](#maintainx_assets_list_assetcustomstatuses) | List asset custom statuses | | [`maintainx_assets_list_assets`](#maintainx_assets_list_assets) | List assets | | [`maintainx_assets_list_assetstatuses`](#maintainx_assets_list_assetstatuses) | List asset statuses | | [`maintainx_assets_update_assetcustomstatuses`](#maintainx_assets_update_assetcustomstatuses) | Update asset custom status | | [`maintainx_assets_update_assets`](#maintainx_assets_update_assets) | Update asset | | [`maintainx_assets_update_assets_status`](#maintainx_assets_update_assets_status) | Create a new asset status | | [`maintainx_assets_update_assetstatuses`](#maintainx_assets_update_assetstatuses) | Update asset status | | [`maintainx_assets_upload_assets_attachments`](#maintainx_assets_upload_assets_attachments) | Update asset attachment | | [`maintainx_assets_upload_assets_thumbnail`](#maintainx_assets_upload_assets_thumbnail) | Update asset's thumbnail | *** ## maintainx\_assets\_create\_assetcustomstatuses Create new asset custom status type **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `baseAssetStatus` | string | Yes | — | Base Asset Status | | `label` | string | Yes | — | The label value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "baseAssetStatus": { "type": "string", "description": "Base Asset Status", "enum": [ "IGNORE", "OFFLINE", "ONLINE" ] }, "label": { "type": "string", "description": "The label value" } }, "required": [ "PCID", "baseAssetStatus", "label" ] } ``` *** ## maintainx\_assets\_create\_assets Create new asset **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | | `assetTypes` | string\[] | No | — | List of asset types | | | `barcode` | string | null | No | — | String encoded barcode | | `criticalityId` | integer | null | No | — | ID of the criticality of the asset | | `depreciation` | object | No | — | Depreciation information of the asset | | | `description` | string | null | No | — | The description value | | `extraFields` | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "My Custom Field") | | | `locationId` | integer | null | No | — | ID of the location where the asset is located | | `manufacturer` | object | No | — | Manufacturer information for the asset. Set to null to clear manufacturer and model. | | | `model` | object | No | — | Model information for the asset. Set to null to clear model. | | | `name` | string | Yes | — | The name value | | | `parentId` | integer | null | No | — | ID of the parent asset | | `serialNumber` | string | null | No | — | Serial number of the asset | | `teamIds` | integer\[] | No | — | List of teams responsible for the asset | | | `vendorIds` | number\[] | No | — | Vendor IDs | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "assetTypes": { "type": "array", "items": { "type": "string" }, "description": "List of asset types" }, "barcode": { "type": [ "string", "null" ], "description": "String encoded barcode" }, "criticalityId": { "type": [ "integer", "null" ], "description": "ID of the criticality of the asset" }, "depreciation": { "type": "object", "description": "Depreciation information of the asset", "properties": { "id": { "type": "number", "description": "Global ID of the asset depreciation." }, "accumulatedDepreciation": { "type": "number", "description": "Accumulated depreciation of the asset." }, "annualDepreciation": { "type": "number", "description": "Annual depreciation of the asset." }, "depreciationStartDate": { "type": "string", "description": "Date at which the asset depreciation started." }, "currentBookValue": { "type": "number", "description": "Current book value of the asset." }, "purchasePrice": { "type": "number", "description": "Purchase price of the asset." }, "purchaseDate": { "type": "string", "description": "Date & time at which the asset was purchased." }, "salvageValue": { "type": "number", "description": "Salvage value of the asset." }, "usefulLifeYears": { "type": "number", "description": "Useful life of the asset in years." }, "yearsDepreciated": { "type": "number", "description": "Years depreciated of the asset." }, "createdAt": { "type": "string", "description": "Date & time at which the asset depreciation was created." }, "archivedAt": { "type": "string", "description": "Date & time at which the asset depreciation was archived." } } }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "extraFields": { "type": "object", "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"My Custom Field\")" }, "locationId": { "type": [ "integer", "null" ], "description": "ID of the location where the asset is located" }, "manufacturer": { "type": "object", "description": "Manufacturer information for the asset. Set to null to clear manufacturer and model.", "properties": { "id": { "type": "integer", "description": "ID of an existing manufacturer. If provided, the manufacturer must be either global or belong to your organization. If not provided, the manufacturer will be looked up by name." }, "name": { "type": "string", "description": "Name of the manufacturer. Required if id is not provided. When searching by name, the manufacturer must be either global or belong to your organization." } } }, "model": { "type": "object", "description": "Model information for the asset. Set to null to clear model.", "properties": { "id": { "type": "integer", "description": "ID of an existing model. If provided, the model must be linked to the specified manufacturer and be either global or belong to your organization. If not provided, the model will be looked up by name." }, "name": { "type": "string", "description": "Name of the model. Required if id is not provided. When searching by name, the model must be linked to the specified manufacturer and be either global or belong to your organization." } } }, "name": { "type": "string", "description": "The name value" }, "parentId": { "type": [ "integer", "null" ], "description": "ID of the parent asset" }, "serialNumber": { "type": [ "string", "null" ], "description": "Serial number of the asset" }, "teamIds": { "type": "array", "items": { "type": "integer" }, "description": "List of teams responsible for the asset" }, "vendorIds": { "type": "array", "items": { "type": "number" }, "description": "Vendor IDs" } }, "required": [ "PCID", "name" ] } ``` *** ## maintainx\_assets\_delete\_assetcustomstatuses Delete asset custom status **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the assetCustomStatus | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the assetCustomStatus" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_delete\_assets Delete asset **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the asset | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_delete\_attachments Remove asset attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the asset. | | `filename` | string | Yes | — | Name of the attachment, including the extension. | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset." }, "filename": { "type": "string", "description": "Name of the attachment, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id", "filename" ] } ``` *** ## maintainx\_assets\_get\_assetcriticalities Get asset criticality **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------- | | `id` | integer | Yes | — | ID of the assetCriticality | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the assetCriticality" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_get\_assetcustomstatuses Get asset custom status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------- | | `id` | integer | Yes | — | ID of the assetCustomStatus | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the assetCustomStatus" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_get\_assets Get asset **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------- | | `id` | integer | Yes | — | ID of the asset | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_list\_assetcriticalities List asset criticalities **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Asset Criticalities returned | | `label` | string | No | — | Will only show asset importances that match the label | | `level` | integer | No | — | Will only show asset importances that match the level | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Asset Criticalities returned" }, "label": { "type": "string", "description": "Will only show asset importances that match the label" }, "level": { "type": "integer", "description": "Will only show asset importances that match the level" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_assets\_list\_assetcustomstatuses List asset custom statuses **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Asset Custom Statuses returned | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Asset Custom Statuses returned" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_assets\_list\_assets List assets **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Assets returned | | `locationId` | integer | No | — | Will only show assets that are related to the location | | `manufacturer` | string\[] | No | — | Filter assets by their manufacturer name | | `model` | string\[] | No | — | Filter assets by their manufacturer model name | | `customFieldName` | string\[] | No | — | Filter assets by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/assets?Industry=Construction"). \
\
Adding multiple instance of the same custom field act as an \OR\ and adding a different custom field act as an \AND\. (ie: To filter by a custom field named \Industry\ with the value \Construction\ OR \Transportation\ AND the custom field \Manufacturer\ with the value \ACME\, you would do this \/assets?Industry=Construction\&Industry=Transportation\&Manufacturer=ACME\). \
\
If your custom field label is the same as a reserved query parameter such as \limit\, \sort\, \expand\, etc, you can add \\_\_c\ to your custom field filtering (ie: To filter by a custom field named \limit\ with the value \ten\, you would do this \/assets?limit\_\_c=ten\). \
\
Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported. | | `expand` | string\[] | No | — | To expand multiple fields: `expand=barcode&expand=team_ids` | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `x-organization-ids` | string | No | — | Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Assets returned" }, "locationId": { "type": "integer", "description": "Will only show assets that are related to the location" }, "manufacturer": { "type": "array", "items": { "type": "string" }, "description": "Filter assets by their manufacturer name" }, "model": { "type": "array", "items": { "type": "string" }, "description": "Filter assets by their manufacturer model name" }, "customFieldName": { "type": "array", "items": { "type": "string" }, "description": "Filter assets by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named \"Industry\" with the value \"Construction\", you would do this \"/assets?Industry=Construction\").

Adding multiple instance of the same custom field act as an OR and adding a different custom field act as an AND. (ie: To filter by a custom field named Industry with the value Construction OR Transportation AND the custom field Manufacturer with the value ACME, you would do this /assets?Industry=Construction&Industry=Transportation&Manufacturer=ACME).

If your custom field label is the same as a reserved query parameter such as limit, sort, expand, etc, you can add __c to your custom field filtering (ie: To filter by a custom field named limit with the value ten, you would do this /assets?limit__c=ten).

Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "barcode", "team_ids", "asset_types", "extra_fields", "vendor_ids", "depreciation", "status", "manufacturer", "model" ] }, "description": "To expand multiple fields: `expand=barcode&expand=team_ids`" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "x-organization-ids": { "type": "string", "description": "Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other)." } }, "required": [ "PCID" ] } ``` *** ## maintainx\_assets\_list\_assetstatuses List asset statuses **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Asset Statuses returned | | `assetId` | integer\[] | No | — | To filter by multiple assetId IDs: `assetIds=630` | | `sort` | string | No | — | Attribute on which to sort the list. (for descending order, prefix attribute with '-'). The default sorting key is : created\_at and direction descending | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Asset Statuses returned" }, "assetId": { "type": "array", "items": { "type": "integer" }, "description": "To filter by multiple assetId IDs: `assetIds=630`" }, "sort": { "type": "string", "description": "Attribute on which to sort the list. (for descending order, prefix attribute with '-'). The default sorting key is : created_at and direction descending", "enum": [ "createdAt", "updatedAt", "startedAt", "endedAt", "-createdAt", "-updatedAt", "-startedAt", "-endedAt" ] }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_assets\_update\_assetcustomstatuses Update asset custom status **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the assetCustomStatus | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `label` | string | No | — | The label value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the assetCustomStatus" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "label": { "type": "string", "description": "The label value" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_update\_assets Update asset **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | | `id` | integer | Yes | — | ID of the asset | | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | | `assetTypes` | string\[] | No | — | List of asset types | | | `barcode` | string | null | No | — | String encoded barcode | | `criticalityId` | integer | null | No | — | ID of the criticality of the asset | | `depreciation` | object | No | — | Depreciation information of the asset | | | `description` | string | null | No | — | The description value | | `extraFields` | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "My Custom Field") | | | `locationId` | integer | null | No | — | ID of the location where the asset is located | | `manufacturer` | object | No | — | Manufacturer information for the asset. Set to null to clear manufacturer and model. | | | `model` | object | No | — | Model information for the asset. Set to null to clear model. | | | `name` | string | No | — | The name value | | | `parentId` | integer | null | No | — | ID of the parent asset | | `serialNumber` | string | null | No | — | Serial number of the asset | | `teamIds` | integer\[] | No | — | List of teams responsible for the asset | | | `vendorIds` | number\[] | No | — | Vendor IDs | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "assetTypes": { "type": "array", "items": { "type": "string" }, "description": "List of asset types" }, "barcode": { "type": [ "string", "null" ], "description": "String encoded barcode" }, "criticalityId": { "type": [ "integer", "null" ], "description": "ID of the criticality of the asset" }, "depreciation": { "type": "object", "description": "Depreciation information of the asset", "properties": { "id": { "type": "number", "description": "Global ID of the asset depreciation." }, "accumulatedDepreciation": { "type": "number", "description": "Accumulated depreciation of the asset." }, "annualDepreciation": { "type": "number", "description": "Annual depreciation of the asset." }, "depreciationStartDate": { "type": "string", "description": "Date at which the asset depreciation started." }, "currentBookValue": { "type": "number", "description": "Current book value of the asset." }, "purchasePrice": { "type": "number", "description": "Purchase price of the asset." }, "purchaseDate": { "type": "string", "description": "Date & time at which the asset was purchased." }, "salvageValue": { "type": "number", "description": "Salvage value of the asset." }, "usefulLifeYears": { "type": "number", "description": "Useful life of the asset in years." }, "yearsDepreciated": { "type": "number", "description": "Years depreciated of the asset." }, "createdAt": { "type": "string", "description": "Date & time at which the asset depreciation was created." }, "archivedAt": { "type": "string", "description": "Date & time at which the asset depreciation was archived." } } }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "extraFields": { "type": "object", "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"My Custom Field\")" }, "locationId": { "type": [ "integer", "null" ], "description": "ID of the location where the asset is located" }, "manufacturer": { "type": "object", "description": "Manufacturer information for the asset. Set to null to clear manufacturer and model.", "properties": { "id": { "type": "integer", "description": "ID of an existing manufacturer. If provided, the manufacturer must be either global or belong to your organization. If not provided, the manufacturer will be looked up by name." }, "name": { "type": "string", "description": "Name of the manufacturer. Required if id is not provided. When searching by name, the manufacturer must be either global or belong to your organization." } } }, "model": { "type": "object", "description": "Model information for the asset. Set to null to clear model.", "properties": { "id": { "type": "integer", "description": "ID of an existing model. If provided, the model must be linked to the specified manufacturer and be either global or belong to your organization. If not provided, the model will be looked up by name." }, "name": { "type": "string", "description": "Name of the model. Required if id is not provided. When searching by name, the model must be linked to the specified manufacturer and be either global or belong to your organization." } } }, "name": { "type": "string", "description": "The name value" }, "parentId": { "type": [ "integer", "null" ], "description": "ID of the parent asset" }, "serialNumber": { "type": [ "string", "null" ], "description": "Serial number of the asset" }, "teamIds": { "type": "array", "items": { "type": "integer" }, "description": "List of teams responsible for the asset" }, "vendorIds": { "type": "array", "items": { "type": "number" }, "description": "Vendor IDs" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_update\_assets\_status Create a new asset status **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | | `assetId` | integer | Yes | — | ID of the asset | | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | | `customStatusId` | number | null | No | — | Id of the custom status assigned to asset. | | `description` | string | null | No | — | The description value | | `downtimeType` | string | null | No | — | Downtime Type | | `endedAt` | string | null | No | — | Asset status effective end date. | | `startedAt` | string | No | — | Asset status effective start date. | | | `status` | string | No | — | Asset status value. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "integer", "description": "ID of the asset" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "customStatusId": { "type": [ "number", "null" ], "description": "Id of the custom status assigned to asset." }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "downtimeType": { "type": [ "string", "null" ], "description": "Downtime Type", "enum": [ "PLANNED", "UNPLANNED" ] }, "endedAt": { "type": [ "string", "null" ], "description": "Asset status effective end date." }, "startedAt": { "type": "string", "description": "Asset status effective start date." }, "status": { "type": "string", "description": "Asset status value.", "enum": [ "IGNORE", "OFFLINE", "ONLINE" ] } }, "required": [ "PCID", "assetId" ] } ``` *** ## maintainx\_assets\_update\_assetstatuses Update asset status **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | | `id` | integer | Yes | — | ID of the asset status | | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | | `customStatusId` | number | null | No | — | Id of the custom status assigned to asset. | | `description` | string | null | No | — | The description value | | `downtimeType` | string | null | No | — | Downtime Type | | `endedAt` | string | null | No | — | Asset status effective end date. | | `startedAt` | string | No | — | Asset status effective start date. | | | `status` | string | No | — | Asset status value. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset status" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "customStatusId": { "type": [ "number", "null" ], "description": "Id of the custom status assigned to asset." }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "downtimeType": { "type": [ "string", "null" ], "description": "Downtime Type", "enum": [ "PLANNED", "UNPLANNED" ] }, "endedAt": { "type": [ "string", "null" ], "description": "Asset status effective end date." }, "startedAt": { "type": "string", "description": "Asset status effective start date." }, "status": { "type": "string", "description": "Asset status value.", "enum": [ "IGNORE", "OFFLINE", "ONLINE" ] } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_assets\_upload\_assets\_attachments Update asset attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the asset. | | `filename` | string | Yes | — | Name of the attachment, including the extension. | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `body` | object | Yes | — | Content type should be `application/octet-stream` and payload should use binary format for the attachment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset." }, "filename": { "type": "string", "description": "Name of the attachment, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "body": { "type": "object", "description": "Content type should be `application/octet-stream` and payload should use binary format for the attachment." } }, "required": [ "PCID", "id", "filename", "body" ] } ``` *** ## maintainx\_assets\_upload\_assets\_thumbnail Update asset's thumbnail **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the asset. | | `filename` | string | Yes | — | Name of the asset thumbnail, including the extension. | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `body` | object | Yes | — | Content type should be `application/octet-stream` and payload should use binary format for the thumbnail. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the asset." }, "filename": { "type": "string", "description": "Name of the asset thumbnail, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "body": { "type": "object", "description": "Content type should be `application/octet-stream` and payload should use binary format for the thumbnail." } }, "required": [ "PCID", "id", "filename", "body" ] } ```