{
  "opencollection": "1.0.0",
  "info": {
    "name": "Limble API V2 Assets API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Assets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add Asset Main Image",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/image",
            "params": [
              {
                "name": "assetID",
                "value": "{{assetID}}",
                "type": "path",
                "description": "assetID of the asset you are removing the main image from."
              }
            ]
          },
          "docs": "Each asset can have one main image associated with it.  This request allows you to set that image."
        },
        {
          "info": {
            "name": "Delete Asset Main Image",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/image",
            "params": [
              {
                "name": "assetID",
                "value": "{{assetID}}",
                "type": "path",
                "description": "assetID of the asset you are removing the main image from."
              }
            ]
          },
          "docs": "This request removes the main image from the asset."
        },
        {
          "info": {
            "name": "Asset Fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.limblecmms.com/v2/assets/fields",
            "params": [
              {
                "name": "name",
                "value": "Model",
                "type": "query",
                "description": "This parameter is used to only get specific field by name. This parameter expects a string full name of a field or partial name with the wildcard %."
              },
              {
                "name": "fields",
                "value": "107",
                "type": "query",
                "description": "This parameter can be used to get a single Asset Fields or a list of Asset Fields in a comma-separated list."
              },
              {
                "name": "start",
                "value": "1555105636",
                "type": "query",
                "description": "This parameter is used to only get Asset Fields for Assets that were last edited after the unix timestamp passed into the start parameter. For example, all Assets that were last edited after April 18th, 2018."
              },
              {
                "name": "end",
                "value": "1555105636",
                "type": "query",
                "description": "This parameter is used to only get Asset Fields for Assets that were last edited *before* the unix timestamp passed into the end parameter."
              },
              {
                "name": "cursor",
                "value": "0",
                "type": "query",
                "description": "This parameter is a cursor that selects what id you want to start receiving results at. e.g. passing 137 here will only get you asset fields with an id greater than 137."
              },
              {
                "name": "limit",
                "value": "1",
                "type": "query",
                "description": "This parameter is a result limiter. The default is set to return no more than 100 results at one time."
              },
              {
                "name": "locations",
                "value": "163",
                "type": "query",
                "description": "This parameter can be used to get a group of asset fields in a location in a comma-separated list."
              },
              {
                "name": "value",
                "value": "F250",
                "type": "query",
                "description": "This parameter is used to only get specific field by value. This parameter expects a string full name of a field or partial name with the wildcard %."
              },
              {
                "name": "assetName",
                "value": "%fork%",
                "type": "query",
                "description": "This parameter is used to only get specific fields by asset name. This parameter expects a string full name of a field or partial name with the wildcard %."
              },
              {
                "name": "fieldType[0]",
                "value": "Text",
                "type": "query",
                "description": "This parameter is used to only get specific fields by type. This parameter expects an array of strings \"Text, Date, Pictures, Documents, Number, Currency, Dropdown\""
              },
              {
                "name": "fieldType[1]",
                "value": "Documents",
                "type": "query",
                "description": "This parameter is used to only get specific fields by type. This parameter expects an array of strings \"Text, Date, Pictures, Documents, Number, Currency, Dropdown\""
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "This parameter is used to paginate results based on the limit. Refer to Pagination section for more information."
              },
              {
                "name": "values",
                "value": "",
                "type": "query",
                "description": "This parameter is used to get asset fields by their valueID. This parameter expects a comma delimited list of Value IDs."
              },
              {
                "name": "assets",
                "value": "171",
                "type": "query",
                "description": "This parameter can be used to get a group of asset fields for a specific set of asset ids in a comma-separated list."
              }
            ]
          },
          "docs": "This request gets detailed information about asset fields such as Make, Model and any other custom field.\n\nThis call also returns \"files\" which is an array of objects that have a file name and a link you can use to download that file. All links are only valid for 15 minutes, a new call will generate a new link.\n\n**Note:** this endpoint supports pagination. Please refer to the [**Pagination**](#pagination) section for more information."
        },
        {
          "info": {
            "name": "New Asset Suggested Field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.limblecmms.com/v2/assets/fields"
          },
          "docs": "This request creates a new Suggested Field.\n\nSuggested Fields are the full list of possible Fields that can be added to Assets at that Location.\n\nParameter: locationID, Type: Int, Required?: Required, Description: The location ID of the Asset to add the new Field to.\nParameter: name, Type: String, Required?: Required, Description: The name of the new Field. Some custom field names such as \"Asset\" are not allowed and reserved for internal use. This will result in a 409 error.\nParameter: fieldType"
        },
        {
          "info": {
            "name": "Asset Suggested Fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.limblecmms.com/v2/assets/fields/suggested",
            "params": [
              {
                "name": "fields",
                "value": "16",
                "type": "query",
                "description": "This parameter can be used to get a single Asset Fields or a list of Asset Fields in a comma-separated list."
              },
              {
                "name": "name",
                "value": "%S%",
                "type": "query",
                "description": "This parameter is used to only get specific field by name. This parameter expects a string full name of a field or partial name with the wildcard %."
              },
              {
                "name": "cursor",
                "value": "0",
                "type": "query",
                "description": "This parameter is a cursor that selects what id you want to start receiving results at. e.g. passing 137 here will only get you asset fields with an id greater than 137."
              },
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "This parameter is a result limiter. The default is set to return no more than 100 results at one time."
              },
              {
                "name": "locations",
                "value": "163",
                "type": "query",
                "description": "This parameter is used to only get fields at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs."
              }
            ]
          },
          "docs": "This request gets all possible fields an Asset can pick from when deciding which fields it should have.  \n\nTo understand this concept, let's pretend you have the following assets:  \n\nYour first Asset (a Truck) has the fields Make, Model, and VIN.  \n\nYour second Asset (a HVAC) has the fields Make, Model, and Serial Number.  \n\nThis would mean there are 4 suggested fields that exist:  Make, Model, VIN and Serial Number.  If I added a third new asset I could pick from any of the 4 suggested fields.\n"
        },
        {
          "info": {
            "name": "Asset Field History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.limblecmms.com/v2/assets/fields/history",
            "params": [
              {
                "name": "assets",
                "value": "4864, 4865",
                "type": "query",
                "description": "This parameter can be used to get a single Asset or a list of Assets in a comma-separated list."
              },
              {
                "name": "fields",
                "value": "321, 202",
                "type": "query",
                "description": "This parameter can be used to get a single Asset Fields or a list of Asset Fields in a comma-separated list."
              },
              {
                "name": "start",
                "value": "1555105636",
                "type": "query",
                "description": "This parameter is used to only get Asset Fields for Assets that were last edited after the unix timestamp passed into the start parameter. For example, all Assets that were last edited after April 18th, 2018."
              },
              {
                "name": "end",
                "value": "1555105636",
                "type": "query",
                "description": "This parameter is used to only get Asset Fields for Assets that were last edited *before* the unix timestamp passed into the end parameter."
              },
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "This parameter is a cursor that selects what id you want to start receiving results at. e.g. passing 137 here will only get you asset fields with an id greater than 137."
              },
              {
                "name": "cursor",
                "value": "0",
                "type": "query",
                "description": "This parameter is a result limiter. The default is set to return no more than 100 results at one time."
              }
            ]
          },
          "docs": "Any time an Asset's field is changed an entry is inserted into a history.  \n\nThis request allows you to pull that information so you can see trends over time."
        },
        {
          "info": {
            "name": "Attach Field to Asset",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/fields",
            "params": [
              {
                "name": "assetID",
                "value": "{{assetID}}",
                "type": "path"
              }
            ]
          },
          "docs": "This request attaches a Suggested Field to an Asset. The field and asset must belong to the same location.\n\nFor example, let's say I have an Asset called Truck - 001. This Truck doesn't have any Fields attached to it, but I want to track its Make so I can set that this Truck is a Dodge. This is the request I would use to attach the Make Field to the Truck and then I would use the Update Asset Field Value request to set it to Dodge.\n\nParameter: locationID, Type: Int, Required?: Required, Descript"
        },
        {
          "info": {
            "name": "Update Asset Field Value",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.limblecmms.com/v2/assets/fields/:valueID",
            "params": [
              {
                "name": "valueID",
                "value": "45612",
                "type": "path",
                "description": "valueID of the field you are removing."
              }
            ]
          },
          "docs": "This request updates the value of a Field that is attached to an Asset. \n\nParameter: value, Type: Varies depending on the Field's type, Required?: Required, Description: The value that will be written to the field, overwriting the previous value and creating an entry in the field history. \"value\" must correspond to the fieldType of the field. For example, if the field is a \"number\" fieldType, then \"value\" must be a number."
        },
        {
          "info": {
            "name": "Delete Asset Field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.limblecmms.com/v2/assets/fields/:valueID",
            "params": [
              {
                "name": "valueID",
                "value": "45612",
                "type": "path",
                "description": "valueID of the field you are removing."
              }
            ]
          },
          "docs": "This request deletes a field attached to an Asset."
        },
        {
          "info": {
            "name": "Delete Asset Log File",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.limblecmms.com/v2/assets/logs/file/:fileID",
            "params": [
              {
                "name": "fileID",
                "value": "58",
                "type": "path",
                "description": "The ID of the file to be deleted."
              }
            ]
          },
          "docs": "This requests deletes a file attached to a log."
        },
        {
          "info": {
            "name": "Add Asset Log File",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/logs/:logID/file",
            "params": [
              {
                "name": "assetID",
                "value": "1",
                "type": "path",
                "description": "The ID of the asset the log belongs to."
              },
              {
                "name": "logID",
                "value": "7257",
                "type": "path",
                "description": "The ID of the log to attach the file to."
              }
            ]
          },
          "docs": "This request adds files to a log.\n\nReturn data description\n\nfileID | The ID of the file attached to the log."
        },
        {
          "info": {
            "name": "Asset Logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/logs",
            "params": [
              {
                "name": "assetID",
                "value": "1",
                "type": "path",
                "description": "The ID of the asset the log will be created for."
              },
              {
                "name": "logs",
                "value": "16",
                "type": "query",
                "description": "This parameter is used to only get specific logs. This parameter accepts a comma delimited list of logIDs."
              },
              {
                "name": "users",
                "value": "341",
                "type": "query",
                "description": "This parameter is used to only get logs created by specific users. This parameter accepts a comma delimited list of userIDs."
              },
              {
                "name": "logEntry",
                "value": "%bro%",
                "type": "query",
                "description": "This is a parameter used to string search for manual log entry. This parameter expects a string with the wildcard %."
              },
              {
                "name": "start",
                "value": "1506274400",
                "type": "query",
                "description": "This parameter is used to only get logs that were last edited after the unix timestamp passed into the start parameter. "
              },
              {
                "name": "end",
                "value": "1506274900",
                "type": "query",
                "description": "This parameter is used to only get logs that were last edited before the unix timestamp passed into the end parameter."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "This parameter is used to paginate results based on the limit. Refer to Pagination section for more information."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "This parameter is a result limiter. The default is set to return no more than 100 results at one time."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "This parameter is a cursor that selects what ID you want to start receiving results at. "
              }
            ]
          },
          "docs": "This request returns logs created manually by users and automatically created (where userID=0) by certain actions taken on the asset. Logs related to tasks completed on an Asset will not be returned.\n\n**Note:** this endpoint supports pagination. Please refer to the [**Pagination**](#pagination) section for more information.\n\nReturn data description\n\nlogID | The unique logID of the log.\ndateCreated | The date the log was created as a UNIX timestamp.\nassetD | The ID of the asset the log belongs to"
        },
        {
          "info": {
            "name": "New Asset Log",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/logs",
            "params": [
              {
                "name": "assetID",
                "value": "1",
                "type": "path",
                "description": "The ID of the asset the log will be created for."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This requests creates a manual log entry for an asset.\n\nuserID | Int | Optional | The ID of the user creating the log. If userID is not given a log entry with userID=0 will be created.\nlogEntry | String | Required | Details of the log."
        },
        {
          "info": {
            "name": "Update Asset Log",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.limblecmms.com/v2/assets/logs/:logID",
            "params": [
              {
                "name": "logID",
                "value": "7257",
                "type": "path",
                "description": "The ID of the log to be deleted."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This requests updates a manual log entry for an asset."
        },
        {
          "info": {
            "name": "Delete Asset Log",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.limblecmms.com/v2/assets/logs/:logID",
            "params": [
              {
                "name": "logID",
                "value": "7257",
                "type": "path",
                "description": "The ID of the log to be deleted."
              }
            ]
          },
          "docs": "This requests deletes a manual log entry for an asset."
        },
        {
          "info": {
            "name": "Batch Update Asset Fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.limblecmms.com/v2/assets/fields/batch/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This request will update multiple asset fields values at a time. The request expects an array of asset fields values. The array needs to have atleast two asset field values and atmost 100 asset field values. The request expects an array made up of asset field values that need to be updated. Only asset fields values of type Text (1), Date (2), Number (5) and Currency (6) can be updated using this request.\n\nThe response returns `{ sucess:true }` if all field values are updated successfully. The re"
        },
        {
          "info": {
            "name": "Asset Parts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.limblecmms.com/v2/assets/parts",
            "params": [
              {
                "name": "assets",
                "value": "172,253",
                "type": "query",
                "description": "This parameter is used to only get specific Assets. This parameter expects a comma delimited list of Asset IDs."
              },
              {
                "name": "limit",
                "value": "3",
                "type": "query",
                "description": "This parameter is a result limiter. The default is set to return no more than 100 results at one time."
              },
              {
                "name": "page",
                "value": "3",
                "type": "query",
                "description": "This parameter is used to paginate results based on the limit. Refer to Pagination section for more information."
              },
              {
                "name": "cursor",
                "value": "49",
                "type": "query",
                "description": "This parameter is a cursor that selects what ID you want to start receiving results at. Without ordering, this will return results with an ID greater than the value of cursor. With ordering, this will return results starting at the next item in the order, regardless of whether its ID is greater than or lesser than the value of cursor."
              },
              {
                "name": "parts",
                "value": "46,172",
                "type": "query",
                "description": "This parameter is used to only get specific Parts. This parameter accepts a comma delimited list of part IDs."
              },
              {
                "name": "relations",
                "value": "1,10",
                "type": "query",
                "description": "This parameter is used to only get specific relations. This parameter expects a comma delimited list of relation IDs."
              },
              {
                "name": "start",
                "value": "1334570141",
                "type": "query",
                "description": "This parameter is used to only get relations that were last edited after the unix timestamp passed into the start parameter. For example, all relations that were last edited after April 18th, 2018."
              },
              {
                "name": "end",
                "value": "1784570141",
                "type": "query",
                "description": "This parameter is used to only get relations that were last edited *before* the unix timestamp passed into the end parameter."
              }
            ]
          },
          "docs": "This request returns a list of Part Asset Relations with top level information such as part, asset, qty, last edited, etc.\n\n**Note:** this endpoint supports pagination. Please refer to the [Pagination](#pagination) section for more information.\n\nReturn data description\n\nrelationID | The Relations ID. e.g. 1\npartID | The ID of the Part in this Relation\nassetID | The ID of the Asset in this Relation\nqty | The qty of the Part related to this Asset\ncreatedAt | The unix timestamp at which this Relati"
        },
        {
          "info": {
            "name": "Assets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.limblecmms.com/v2/assets",
            "params": [
              {
                "name": "assets",
                "value": "1",
                "type": "query",
                "description": "This parameter is used to only get specific Assets. This parameter expects a comma delimited list of Asset IDs."
              },
              {
                "name": "name",
                "value": "%test%",
                "type": "query",
                "description": "This is a parameter used to string search for a name or partial name of an asset this parameter expects a string with the wildcard %."
              },
              {
                "name": "locations",
                "value": "73",
                "type": "query",
                "description": "This parameter is used to only get Assets at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs."
              },
              {
                "name": "start",
                "value": "1541796014",
                "type": "query",
                "description": "This parameter is used to only get Assets that were last edited after the unix timestamp passed into the start parameter. For example, all Assets that were last edited after April 18th, 2018."
              },
              {
                "name": "end",
                "value": "1541796014",
                "type": "query",
                "description": "This parameter is used to only get Assets that were last edited *before* the unix timestamp passed into the end parameter."
              },
              {
                "name": "cursor",
                "value": "0",
                "type": "query",
                "description": "This parameter is a cursor that selects what ID you want to start receiving results at. Without ordering, this will return results with an ID greater than the value of cursor. With ordering, this will return results starting at the next item in the order, regardless of whether its ID is greater than or lesser than the value of cursor."
              },
              {
                "name": "limit",
                "value": "1",
                "type": "query",
                "description": "This parameter is a result limiter. The default is set to return no more than 100 results at one time."
              },
              {
                "name": "parentAssetID",
                "value": "2317",
                "type": "query",
                "description": "This parameter can be used to get asset(s) children using the Parent's ID. This parameter accepts a comma delimited list of Asset IDs."
              },
              {
                "name": "orderBy",
                "value": "-lastEdited",
                "type": "query",
                "description": "This parameter is used to order results by their lastEdited property instead of the default ordering by ascending assetID. CANNOT be provided alongside the cursor parameter. to paginate in this ordering, use the start or end parameters."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "This parameter is used to paginate results based on the limit. Refer to Pagination section for more information."
              },
              {
                "name": "geoLocation",
                "value": "true",
                "type": "query",
                "description": "This parameter is used to filter results that contain a geoLocation property. By default it is false and will return **all** assets with and without geoLocation property. If true, it will only return assets with a geoLocation property."
              }
            ]
          },
          "docs": "This request returns a list of Assets with top level information such as name, last edited, etc.\n\n**Note:** this endpoint supports pagination. Please refer to the [Pagination](#pagination) section for more information.\n\nReturn data description\n\nmeta | Requests to gather more information on an Asset such as Fields for the Asset or what Tasks are assigned to the Asset\nstartedOn | The date when this Asset was started on. This property is used to help determine runtime which is used in MTBF.\nlastEdi"
        },
        {
          "info": {
            "name": "New Asset",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.limblecmms.com/v2/assets"
          },
          "docs": "This request creates a new blank Asset.\n\nParameter: name, Type: String, Required?: Required, Description: The new name of the Asset.\nParameter: hoursPerWeek, Type: Integer, Required?: Optional, Description: The new hours of operation per week for this Asset. Use -1 to disable this feature.\nParameter: parentAssetID, Type: Int, Required?: Optional, Description: The asset's parent. This makes it so assets can be nested in the web application.\nParameter: locationID, Type: Int, Required?: Required, D"
        },
        {
          "info": {
            "name": "Patch Asset",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.limblecmms.com/v2/assets/:assetID",
            "params": [
              {
                "name": "assetID",
                "value": "10728",
                "type": "path",
                "description": "The value of the asset that needs to be updated"
              }
            ]
          },
          "docs": "This request updates an Asset's top level information. See Update Asset Field Value to update an Asset Field's value.\n\nname | String | Optional | The new name of the Asset.\nhoursPerWeek | Integer | Optional | The new hours of operation per week for this Asset. Use -1 to disable this feature and have it default to the Locations hours of operation.\nparentAssetID | Int | Optional | The asset's parent. This must be another asset ID and is used to display an Asset hierarchy. You can not have assets b"
        },
        {
          "info": {
            "name": "Delete Asset",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.limblecmms.com/v2/assets/:assetID",
            "params": [
              {
                "name": "assetID",
                "value": "10728",
                "type": "path",
                "description": "The value of the asset that needs to be updated"
              }
            ]
          },
          "docs": "This request removes an Asset from your Limble account."
        },
        {
          "info": {
            "name": "Move Asset to another Location",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.limblecmms.com/v2/assets/:assetID/move",
            "params": [
              {
                "name": "assetID",
                "value": "14113",
                "type": "path",
                "description": "The value of the asset that needs to be moved"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This request moves an existing asset from it's current location to another location. An parent asset that has one or more children assets cannot be moved.\n\nA child asset can be moved and will be created as a top level asset in the other location.\n\nlocationID | Int | Required | The locationID of the location the asset needs to be moved to.\ntransferParts | boolean | Optional | A boolean representing whether parts associated with the asset should be moved to the location as well., Defaults to true."
        }
      ]
    }
  ],
  "bundled": true
}