openapi: 3.0.1 info: description: Gain greater visibility by connecting your fleets, equipment, sites, and people. title: Samsara Beta A P Is API version: '2024-11-18' servers: - url: https://api.samsara.com/ - url: https://api.eu.samsara.com/ security: - AccessTokenHeader: [] tags: - name: Beta A P Is paths: /assets: delete: description: "Delete an existing asset.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Assets** under the Assets category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: deleteAsset parameters: - description: A filter selecting a single asset by id. in: query name: id required: true schema: type: string responses: '204': content: {} description: No Content response. '401': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/AssetsDeleteAssetBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Delete an Existing Asset.' tags: - Beta A P Is get: description: "List all assets. Up to 300 assets will be returned per page.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Assets** under the Assets category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: listAssets parameters: - description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' in: query name: type schema: enum: - uncategorized - trailer - equipment - unpowered - vehicle type: string - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: ' A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: updatedAfterTime schema: type: string - description: Optional boolean indicating whether to return external IDs on supported entities in: query name: includeExternalIds schema: type: boolean - description: Optional boolean indicating whether to return tags on supported entities in: query name: includeTags schema: type: boolean - description: ' A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`' in: query name: tagIds schema: type: string - description: ' A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`' in: query name: parentTagIds schema: type: string - description: A filter on the data based on this comma-separated list of asset IDs and External IDs. explode: false in: query name: ids schema: items: type: string type: array style: form - description: 'A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`' in: query name: attributeValueIds schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/AssetsListAssetsBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] List All Assets.' tags: - Beta A P Is patch: description: "Update an existing asset.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Assets** under the Assets category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: updateAsset parameters: - description: A filter selecting a single asset by id. in: query name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/AssetsUpdateAssetBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Update an Existing Asset.' tags: - Beta A P Is x-codegen-request-body-name: UpdateAssetRequestBody post: description: "Create a new asset.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Assets** under the Assets category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: createAsset requestBody: content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/AssetsCreateAssetBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Create a New Asset.' tags: - Beta A P Is x-codegen-request-body-name: CreateAssetRequestBody /assets/inputs/stream: get: description: "This endpoint will return data collected from the inputs of your organization's assets based on the time parameters passed in. Results are paginated. If you include an endTime, the endpoint will return data up until that point. If you dont include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. The endpoint will only return data up until the endTime that has been processed by the server at the time of the original request. You will need to request the same [startTime, endTime) range again to receive data for assets processed after the original request time. This endpoint sorts data by time ascending.\n\n Rate limit: 10 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Assets** under the Assets category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getAssetsInputs parameters: - description: Comma-separated list of asset IDs. Limited to 100 ID's for each request. explode: false in: query name: ids required: true schema: items: type: string type: array style: form - description: 'Input stat type to query for. Valid values: `auxInput1`, `auxInput2`, `auxInput3`, `auxInput4`, `auxInput5`, `auxInput6`, `auxInput7`, `auxInput8`, `auxInput9`, `auxInput10`, `auxInput11`, `auxInput12`, `auxInput13`, `analogInput1Voltage`, `analogInput2Voltage`, `analogInput1Current`, `analogInput2Current`, `batteryVoltage`' in: query name: type required: true schema: enum: - auxInput1 - auxInput2 - auxInput3 - auxInput4 - auxInput5 - auxInput6 - auxInput7 - auxInput8 - auxInput9 - auxInput10 - auxInput11 - auxInput12 - auxInput13 - analogInput1Voltage - analogInput2Voltage - analogInput1Current - analogInput2Current - batteryVoltage type: string - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: 'A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: startTime required: true schema: type: string - description: ' An end time in RFC 3339 format. Defaults to never if not provided; if not provided then pagination will not cease, and a valid pagination cursor will always be returned. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: endTime schema: type: string - description: Optional boolean indicating whether to return external IDs on supported entities in: query name: includeExternalIds schema: type: boolean - description: Optional boolean indicating whether to return tags on supported entities in: query name: includeTags schema: type: boolean - description: Optional boolean indicating whether to return attributes on supported entities in: query name: includeAttributes schema: type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/AssetsInputsGetAssetsInputsBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] List Asset Inputs Data in an Organization.' tags: - Beta A P Is /beta/aemp/Fleet/{pageNumber}: get: description: "Get a list of equipment following the AEMP ISO 15143-3 standard.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read AEMP** under the Equipment category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getAempEquipmentList parameters: - description: The number corresponding to a specific page of paginated results, defaulting to the first page if not provided. The default page size is 100 records. in: path name: pageNumber required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/AempEquipmentGetAempEquipmentListBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get a List of AEMP Equipment' tags: - Beta A P Is /beta/fleet/equipment/{id}: patch: description: "Update an equipment. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard.\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource.\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: patchEquipment parameters: - description: The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/EquipmentPatchEquipmentBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Update an Equipment' tags: - Beta A P Is x-codegen-request-body-name: PatchEquipmentRequestBody /beta/fleet/trailers/stats/feed: get: description: "Follow a feed of trailer stats.\n\nThe first call to this endpoint will provide the most recent stats for each trailer and an `endCursor`.\n\nProviding the `endCursor` value to the `after` query parameter will fetch all updates since the previous API call.\n\nIf `hasNextPage` is false, no new data is immediately available. Please wait a minimum of 5 seconds before making a subsequent request.\n\n Rate limit: 25 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Trailer Statistics** under the Trailers category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getTrailerStatsFeed parameters: - description: 'The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.' in: query name: types required: true schema: type: string - description: ' A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`' in: query name: tagIds schema: type: string - description: ' A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`' in: query name: parentTagIds schema: type: string - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: ' A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`' in: query name: trailerIds schema: type: string - description: 'Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer''s location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`. You may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading. Note that decorations may significantly increase the response payload size. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.' in: query name: decorations schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsFeedBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get Trailer Stats Feed' tags: - Beta A P Is /beta/fleet/trailers/stats/history: get: description: "Returns trailer stats during the given time range for all trailers. This can be optionally filtered by tags or specific trailer IDs.\n\n Rate limit: 10 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Trailer Statistics** under the Trailers category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getTrailerStatsHistory parameters: - description: ' A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: startTime required: true schema: type: string - description: ' An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: endTime required: true schema: type: string - description: 'The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.' in: query name: types required: true schema: type: string - description: ' A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`' in: query name: tagIds schema: type: string - description: ' A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`' in: query name: parentTagIds schema: type: string - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: ' A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`' in: query name: trailerIds schema: type: string - description: 'Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer''s location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`. You may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading. Note that decorations may significantly increase the response payload size. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.' in: query name: decorations schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/TrailerStatsGetTrailerStatsHistoryBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get Trailer Stats History' tags: - Beta A P Is /beta/industrial/jobs: delete: description: "Deletes an existing job.\n\nTo use this endpoint, select **Write Jobs** under the Equipment category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: deleteJob parameters: - description: 'A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596"`, `"jobId:98765"`).' in: query name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/JobsDeleteJobBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Deletes an Existing Job' tags: - Beta A P Is get: description: "Fetches jobs based on id/uuid or provided filters.\n\nTo use this endpoint, select **Read Jobs** under the Equipment category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getJobs parameters: - description: 'A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596"`, `"jobId:98765"`).' in: query name: id schema: type: string - description: ' A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: startDate schema: type: string - description: ' An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: endDate schema: type: string - description: 'IndustrialAssetId in STRING format. (Example: `"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596"`).' explode: true in: query name: industrialAssetIds schema: items: type: string type: array style: form - description: 'FleetDeviceId in INTEGER format. (Example: `123456`).' explode: true in: query name: fleetDeviceIds schema: items: type: integer type: array style: form - description: 'A job status in STRING format. Job statuses can be one of three (ignores case): `"active", "scheduled", "completed"` Valid values: `active`, `scheduled`, `completed`' in: query name: status schema: enum: - active - scheduled - completed type: string - description: Customer name to filter by in: query name: customerName schema: type: string - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/JobsGetJobsBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Fetches All Jobs' tags: - Beta A P Is patch: description: "Patches an existing job and returns it.\n\nTo use this endpoint, select **Write Jobs** under the Equipment category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: patchJob parameters: - description: 'A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596"`, `"jobId:98765"`).' in: query name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/JobsPatchJobBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Patches a Job' tags: - Beta A P Is x-codegen-request-body-name: PatchJobRequestBody post: description: "Creates a new job and returns it.\n\nTo use this endpoint, select **Write Jobs** under the Equipment category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: createJob requestBody: content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Create a Job' tags: - Beta A P Is x-codegen-request-body-name: CreateJobRequestBody /driver-trailer-assignments: get: description: "Get currently active driver-trailer assignments for driver.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getDriverTrailerAssignments parameters: - description: ' A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`' explode: false in: query name: driverIds required: true schema: items: type: string type: array style: form - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: Optional boolean indicating whether to return external IDs on supported entities in: query name: includeExternalIds schema: type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get Currently Active Driver-trailer Assignments for Driver.' tags: - Beta A P Is patch: description: "Update an existing driver-trailer assignment.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: updateDriverTrailerAssignment parameters: - description: Samsara ID for the assignment. in: query name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Update an Existing Driver-trailer Assignment.' tags: - Beta A P Is x-codegen-request-body-name: UpdateDriverTrailerAssignmentRequestBody post: description: "Create a new driver-trailer assignment\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: createDriverTrailerAssignment requestBody: content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Create a New Driver-trailer Assignment' tags: - Beta A P Is x-codegen-request-body-name: CreateDriverTrailerAssignmentRequestBody /form-submissions/stream: get: description: "Returns all form submissions data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you dont include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getFormSubmissionsStream parameters: - description: ' A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: startTime required: true schema: type: string - description: ' An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: endTime schema: type: string - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: A comma-separated list containing up to 50 template IDs to filter data to. explode: false in: query name: formTemplateIds schema: items: type: string type: array style: form - description: A comma-separated list containing up to 50 user IDs to filter data to. explode: false in: query name: userIds schema: items: type: string type: array style: form - description: A comma-separated list containing up to 50 user IDs to filter data to. explode: false in: query name: driverIds schema: items: type: string type: array style: form - description: 'A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`' explode: false in: query name: include schema: items: type: string type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/FormSubmissionsGetFormSubmissionsStreamBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get a Stream of Filtered Form Submissions.' tags: - Beta A P Is /issues: get: description: "Returns all issues data for the specified IDs. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Issues** under the Closed Beta category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getIssues parameters: - description: A comma-separated list containing up to 100 issue IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the issue. explode: false in: query name: ids required: true schema: items: type: string type: array style: form - description: 'A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`' explode: false in: query name: include schema: items: type: string type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/IssuesGetIssuesBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get a List of Specified Issues.' tags: - Beta A P Is patch: description: "Updates an instance of an issue. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Issues** under the Closed Beta category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: patchIssue requestBody: content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/IssuesPatchIssueBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Update a Single Issue.' tags: - Beta A P Is x-codegen-request-body-name: PatchIssueRequestBody /speeding-intervals/stream: get: description: "This endpoint will return all speeding intervals associated with trips that have been collected for your organization based on the time parameters passed in. Only completed trips are included. Results are paginated.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Speeding Intervals** under the Speeding Intervals category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getSpeedingIntervals parameters: - description: Comma-separated list of asset IDs. Include up to 50 asset IDs. explode: false in: query name: assetIds required: true schema: items: type: string type: array style: form - description: RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. in: query name: startTime required: true schema: type: string - description: RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes. in: query name: endTime schema: type: string - description: 'Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`' in: query name: queryBy schema: default: updatedAtTime enum: - updatedAtTime - tripStartTime type: string - description: Indicates whether or not to return expanded asset data in: query name: includeAsset schema: default: false type: boolean - description: Indicates whether or not to return trip's driver id in: query name: includeDriverId schema: default: false type: boolean - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: 'Optional string of comma-separated severity levels to filter speeding intervals by. Valid values: light, moderate, heavy, severe.' explode: false in: query name: severityLevels schema: items: type: string type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get Speeding Intervals' tags: - Beta A P Is /training-assignments/stream: get: description: "Returns all training assignments data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don't include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Training Assignments** under the Closed Beta category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team." operationId: getTrainingAssignmentsStream parameters: - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.' in: query name: after schema: type: string - description: ' A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: startTime required: true schema: type: string - description: ' An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' in: query name: endTime schema: type: string - description: 'Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`' explode: false in: query name: learnerIds schema: items: type: string type: array style: form - description: 'Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`' explode: false in: query name: courseIds schema: items: type: string type: array style: form - description: 'Optional string of comma separated values. If status is present, training assignments for the specified status(s) will be returned. Valid values: "notStarted", "inProgress", "completed". Defaults to returning all courses.' explode: false in: query name: status schema: items: type: string type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody' description: OK response. '401': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamUnauthorizedErrorResponseBody' description: Unauthorized response. '404': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamNotFoundErrorResponseBody' description: Not Found response. '405': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamMethodNotAllowedErrorResponseBody' description: Method Not Allowed response. '429': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamTooManyRequestsErrorResponseBody' description: Too Many Requests response. '500': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamInternalServerErrorResponseBody' description: Internal Server Error response. '501': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamNotImplementedErrorResponseBody' description: Not Implemented response. '502': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamBadGatewayErrorResponseBody' description: Bad Gateway response. '503': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamServiceUnavailableErrorResponseBody' description: Service Unavailable response. '504': content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamGatewayTimeoutErrorResponseBody' description: Gateway Timeout response. default: content: application/json: schema: $ref: '#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamBadRequestErrorResponseBody' description: Bad Request response. summary: '[beta] Get a Stream of Filtered Training Assignments.' tags: - Beta A P Is components: schemas: FormsPersonValueObjectResponseBody: description: The value of a person form input field. properties: person: $ref: '#/components/schemas/FormsPersonObjectResponseBody' required: - person type: object AssetsCreateAssetRequestBody: description: Representation of a vehicle trailer or other equipment to be tracked. properties: externalIds: additionalProperties: type: string description: A map of external ids type: object licensePlate: description: The license plate of the asset. example: XHK1234 type: string make: description: The manufacturer of the asset. (If a VIN is entered and the system detects it is registered to a different manufacturer than provided an error will be returned). example: Bobcat type: string model: description: The manufacturer model of the asset. (If a VIN is entered and the system detects it is registered to a different model than provided an error will be returned). example: S630 T4 type: string name: description: The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: MyAsset-1234 type: string notes: description: These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are notes. type: string regulationMode: description: 'Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`' enum: - mixed - regulated - unregulated example: mixed type: string serialNumber: description: The serial number of the asset. example: 8V8WD530FLN016251 type: string type: default: uncategorized description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' enum: - uncategorized - trailer - equipment - unpowered - vehicle example: trailer type: string vin: description: The vehicle identification number of the asset. example: 1FUJBBCKXCLBZ1234 type: string year: description: The year of manufacture of the asset. (If a VIN is entered and the system detects it is registered to a different year than provided an error will be returned). example: 2015 format: int64 type: integer type: object TrailerStatReeferSetPointTemperatureMilliCZone2WithDecorationsTypeResponseBody: description: Set point temperature of zone 2 of the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The set point temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object JobsPatchJobNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsDeleteJobGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListResponseBody: properties: Fleet: $ref: '#/components/schemas/AempFleetListResponseBody' required: - Fleet type: object TrailerStatsGetTrailerStatsHistoryNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsListAssetsResponseBody: properties: data: description: List of assets items: $ref: '#/components/schemas/AssetResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object SpeedingIntervalsGetSpeedingIntervalsInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsNumberValueObjectResponseBody: description: The value of a number form input field. properties: value: description: Number value. example: 123.456 format: double type: number required: - value type: object TrailerStatReeferStateZone2TypeResponseBody: description: Reefer state event. properties: substateValue: description: The substate zone 2 of the reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The state zone 2 of the reefer. example: '`Off`, `On`' type: string required: - time - value type: object SpeedingIntervalsGetSpeedingIntervalsGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferFuelPercentTypeResponseBody: description: The fuel percentage of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The fuel level in percentage points (e.g. `99`, `50`, etc). example: 50 format: int64 type: integer required: - time - value type: object AssetsListAssetsTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsDeleteAssetServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferDoorStateZone2WithDecorationsTypeResponseBody: description: Door stats that have been emitted by the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: 'The door state of zone 2 of the reefer. Valid values: `open`, `closed`' enum: - open - closed example: closed type: string required: - time - value type: object LocationResponseBody: description: Equipment location. properties: Latitude: description: Location latitude. example: 12.34 format: double type: number Longitude: description: Location longitude. example: 12.34 format: double type: number datetime: description: 'Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object AssetsUpdateAssetBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsUpdateAssetNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsListAssetsUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalResponseBody: description: Speeding Interval Object properties: endTime: description: UTC time the interval ended in RFC 3339 format. example: '2023-01-27T07:06:25Z' type: string isDismissed: description: Whether the interval is dismissed. example: true type: boolean location: $ref: '#/components/schemas/SpeedingIntervalLocationResponseResponseBody' maxSpeedKilometersPerHour: description: The max speed exceeded for the speeding interval. example: 65 format: double type: number postedSpeedLimitKilometersPerHour: description: The posted speed limit associated with the speeding interval. example: 75 format: double type: number severityLevel: description: 'Specifies the severity level of the speeding interval. Valid values: `light`, `moderate`, `heavy`, `severe`' enum: - light - moderate - heavy - severe example: severe type: string startTime: description: UTC time the interval started in RFC 3339 format. example: '2023-01-27T07:06:25Z' type: string required: - endTime - isDismissed - location - maxSpeedKilometersPerHour - postedSpeedLimitKilometersPerHour - severityLevel - startTime type: object JobsGetJobsNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsDeleteAssetNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatGpsOdometerMetersTypeResponseBody: description: Trailer GPS odometer event. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: Number of meters the trailer has traveled according to the GPS calculations and the manually specified odometer reading. example: 50 format: int64 type: integer required: - time - value type: object IssuesPatchIssueBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSetPointTemperatureMilliCZone3WithDecorationsTypeResponseBody: description: Set point temperature of zone 3 of the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The set point temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object SpeedingIntervalsGetSpeedingIntervalsBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferStateZone3WithDecorationsTypeResponseBody: description: Reefer state event. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' substateValue: description: The substate zone 3 of the reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The state zone 3 of the reefer. example: '`Off`, `On`' type: string required: - time - value type: object EquipmentPatchEquipmentUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsCreateJobNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object GoaAttributeTiny: description: Attribute properties. properties: id: description: Id of the attribute example: '494123' type: string name: description: Name of the attribute example: Compliance/ELD type: string numberValues: description: List of number values associated with the attribute example: - 867 - 5309 items: example: 0.3016961140338651 format: double type: number type: array stringValues: description: List of string values associated with the attribute. example: - HQ - Leased items: example: Nobis dolores nam est et praesentium. type: string type: array type: object TrailerStatReeferAlarmTypeResponseBody: description: Alarms that have been emitted by the reefer. properties: alarms: description: The alarms reported by the reefer. items: $ref: '#/components/schemas/TrailerStatReeferAlarmResponseBody' type: array time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string required: - alarms - time type: object JobsDeleteJobNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferRunModeWithDecorationsTypeResponseBody: description: The run mode of the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The operational mode of the reefer. example: '`Start/Stop`,`Continuous`' type: string required: - time - value type: object IssuesPatchIssueNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsHistoryInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsLocationObjectResponseBody: description: Form template location object. properties: latitude: description: Latitude of a location. example: 12333122.3 format: double type: number longitude: description: Longitude of a location. example: 1233331.4 format: double type: number required: - latitude - longitude type: object AssetsInputsGetAssetsInputsBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object EquipmentPatchEquipmentGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsDeleteAssetNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsHistoryResponseBody: properties: data: description: List of trailers and their stats items: $ref: '#/components/schemas/TrailerStatsObjectResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object IssuesPatchIssueServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody: description: Set point temperature of zone 3 of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The set point temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerStatReeferStateZone3TypeResponseBody: description: Reefer state event. properties: substateValue: description: The substate zone 3 of the reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The state zone 3 of the reefer. example: '`Off`, `On`' type: string required: - time - value type: object JobsPatchJobNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferAlarmWithDecorationsTypeResponseBody: description: Alarms that have been emitted by the reefer. properties: alarms: description: The alarms reported by the reefer. items: $ref: '#/components/schemas/TrailerStatReeferAlarmResponseBody' type: array decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string required: - alarms - time type: object AssetsDeleteAssetBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object fleetDeviceObjectResponseBody: description: fleetDeviceObject properties: id: description: Id of the device example: 123456 format: int64 type: integer name: description: Name of the device example: My Device type: string required: - id - name type: object TrailerStatReeferReturnAirTemperatureMilliCZone1WithDecorationsTypeResponseBody: description: Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The return air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object IssuesGetIssuesResponseBody: properties: data: description: List of issues. items: $ref: '#/components/schemas/IssueResponseObjectResponseBody' type: array required: - data type: object EquipmentWithAttributesResponseObjectResponseBody: description: The equipment object. properties: attributes: description: List of attributes associated with the entity items: $ref: '#/components/schemas/GoaAttributeTinyResponseBody' type: array equipmentSerialNumber: description: The serial number of the equipment. example: 8V8WD530FLN016251 type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed. example: '494123' type: string installedGateway: $ref: '#/components/schemas/GoaGatewayTinyResponseResponseBody' name: description: The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: Equipment-123 type: string notes: description: These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are my equipment notes maxLength: 255 type: string tags: description: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Equipment. items: $ref: '#/components/schemas/GoaTagTinyResponseResponseBody' type: array type: object AempEquipmentGetAempEquipmentListInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsDeleteJobServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsTextValueObjectResponseBody: description: The value of a text form input field. properties: value: description: Text value. example: Exposed wires type: string required: - value type: object JobsPatchJobRequestBody: description: Job object with fields to update. If a field is not provided, it will not be updated properties: job: $ref: '#/components/schemas/PatchJobObjectRequestBody' keepHistory: default: true description: Defaults to true if user does not want to overwrite entire history for an active job (irrelevant for scheduled/completed jobs) example: true type: boolean required: - job type: object FormsTableCellObjectResponseBody: description: Defines a cell in a table row. properties: checkBoxesValue: $ref: '#/components/schemas/FormsCheckBoxesValueObjectResponseBody' dateTimeValue: $ref: '#/components/schemas/FormsDateTimeValueObjectResponseBody' id: description: Unique identifier for the cell. format: uuid type: string mediaValue: $ref: '#/components/schemas/FormsMediaValueObjectResponseBody' multipleChoiceValue: $ref: '#/components/schemas/FormsMultipleChoiceValueObjectResponseBody' numberValue: $ref: '#/components/schemas/FormsNumberValueObjectResponseBody' personValue: $ref: '#/components/schemas/FormsPersonValueObjectResponseBody' signatureValue: $ref: '#/components/schemas/FormsSignatureValueObjectResponseBody' textValue: $ref: '#/components/schemas/FormsTextValueObjectResponseBody' type: description: 'Type of the cell field. Valid values: `number, text, multiple_choice, check_boxes, datetime, signature, media, person`' enum: - number, text, multiple_choice, check_boxes, datetime, signature, media, person example: number type: string required: - id - type type: object FormSubmissionResponseObjectResponseBody: description: Form Submission response object. properties: asset: $ref: '#/components/schemas/FormsAssetObjectResponseBody' assignedAtTime: description: Assignment time of the form submission. Sometimes returned if the submission was assigned to a user or driver. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string assignedTo: $ref: '#/components/schemas/FormsPolymorphicUserObjectResponseBody' createdAtTime: description: Creation time of the form submission. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string dueAtTime: description: Time of when the submission is due. Sometimes returned, if the submission has a due date. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string externalIds: additionalProperties: type: string description: A map of external ids type: object fields: description: List of field inputs in a form submission. items: $ref: '#/components/schemas/FormsFieldInputObjectResponseBody' type: array formTemplate: $ref: '#/components/schemas/FormTemplateReferenceObjectResponseBody' id: description: ID of the form submission. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 type: string isRequired: description: Indicates whether the worker is required to complete this form or not. Sometimes returned if the submission was assigned to a user or driver. example: true type: boolean location: $ref: '#/components/schemas/FormsLocationObjectResponseBody' score: $ref: '#/components/schemas/FormsScoreObjectResponseBody' status: description: 'State for the Form Submission. Always returned. Valid values: `toDo`, `submitted`, `dismissed`' enum: - toDo - submitted - dismissed example: toDo type: string submittedAtTime: description: Submission time of the form submission. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string submittedBy: $ref: '#/components/schemas/FormsPolymorphicUserObjectResponseBody' title: description: Title of the form submission. Sometimes returned if the submission has a title. example: Form Submission Title type: string updatedAtTime: description: Update time of the form submission. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string required: - createdAtTime - fields - formTemplate - id - status - submittedAtTime - submittedBy - updatedAtTime type: object FormsSignatureValueObjectResponseBody: description: The value of a signature form input field. properties: media: $ref: '#/components/schemas/FormsMediaRecordObjectResponseBody' required: - media type: object EquipmentPatchEquipmentServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetResponseBody: description: Representation of a vehicle trailer or other equipment to be tracked. properties: createdAtTime: description: The time the asset was created in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: The unique ID of the asset. example: '12345' type: string licensePlate: description: The license plate of the asset. example: XHK1234 type: string make: description: The manufacturer of the asset. (If a VIN is entered and the system detects it is registered to a different manufacturer than provided an error will be returned). example: Bobcat type: string model: description: The manufacturer model of the asset. (If a VIN is entered and the system detects it is registered to a different model than provided an error will be returned). example: S630 T4 type: string name: description: The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: MyAsset-1234 type: string notes: description: These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are notes. type: string regulationMode: description: 'Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`' enum: - mixed - regulated - unregulated example: mixed type: string serialNumber: description: The serial number of the asset. example: 8V8WD530FLN016251 type: string tags: description: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset. items: $ref: '#/components/schemas/GoaTagTinyResponseResponseBody' type: array type: default: uncategorized description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' enum: - uncategorized - trailer - equipment - unpowered - vehicle example: trailer type: string updatedAtTime: description: The time the asset was last updated in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string vin: description: The vehicle identification number of the asset. example: 1FUJBBCKXCLBZ1234 type: string year: description: The year of manufacture of the asset. (If a VIN is entered and the system detects it is registered to a different year than provided an error will be returned). example: 2015 format: int64 type: integer required: - createdAtTime - id - updatedAtTime type: object AssetsUpdateAssetRequestBody: description: Representation of a vehicle trailer or other equipment to be tracked. properties: externalIds: additionalProperties: type: string description: A map of external ids type: object licensePlate: description: The license plate of the asset. example: XHK1234 type: string make: description: The manufacturer of the asset. (If a VIN is entered and the system detects it is registered to a different manufacturer than provided an error will be returned). example: Bobcat type: string model: description: The manufacturer model of the asset. (If a VIN is entered and the system detects it is registered to a different model than provided an error will be returned). example: S630 T4 type: string name: description: The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: MyAsset-1234 type: string notes: description: These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are notes. type: string regulationMode: description: 'Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`' enum: - mixed - regulated - unregulated example: mixed type: string serialNumber: description: The serial number of the asset. example: 8V8WD530FLN016251 type: string type: description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' enum: - uncategorized - trailer - equipment - unpowered - vehicle example: trailer type: string vin: description: The vehicle identification number of the asset. example: 1FUJBBCKXCLBZ1234 type: string year: description: The year of manufacture of the asset. (If a VIN is entered and the system detects it is registered to a different year than provided an error will be returned). example: 2015 format: int64 type: integer type: object EquipmentPatchEquipmentBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsListAssetsInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsMediaRecordObjectResponseBody: description: Forms media record object. properties: id: description: ID of the media record. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 format: uuid type: string processingStatus: description: 'Status of the media record. Valid values: `unknown`, `processing`, `finished`' enum: - unknown - processing - finished example: processing type: string url: description: URL containing a link to associated media content. Included if 'processingStatus' is 'finished'. example: https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456 format: uri type: string urlExpiresAt: description: Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string required: - id - processingStatus type: object TrailerStatReeferRunModeTypeResponseBody: description: The run mode of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The operational mode of the reefer. example: '`Start/Stop`,`Continuous`' type: string required: - time - value type: object IssuesGetIssuesTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsGetJobsTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferAmbientAirTemperatureWithDecorationsTypeResponseBody: description: Reefer ambient air temperature reading. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The ambient air temperature reading of the reefer in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object AempEquipmentWithAdditionalFieldsResponseBody: description: Contains equipment fields. properties: CumulativeOperatingHours: $ref: '#/components/schemas/CumulativeOperatingHoursResponseBody' DEFRemaining: $ref: '#/components/schemas/DEFRemainingResponseBody' Distance: $ref: '#/components/schemas/DistanceResponseBody' EngineStatus: $ref: '#/components/schemas/EngineStatusResponseBody' EquipmentHeader: $ref: '#/components/schemas/EquipmentHeaderWithAdditionalFieldsResponseBody' FuelRemaining: $ref: '#/components/schemas/FuelRemainingResponseBody' Location: $ref: '#/components/schemas/LocationResponseBody' required: - EquipmentHeader - Location type: object AssetsListAssetsGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsListAssetsMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object EngineStatusResponseBody: description: Equipment engine status. properties: Running: description: Boolean value for whether engine is running or not. example: true type: boolean datetime: description: 'Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object JobsPatchJobMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object assetsInputsResponseResponseBody: description: Full assets inputs objects. properties: asset: $ref: '#/components/schemas/AssetsInputsAssetResponseResponseBody' auxInput: $ref: '#/components/schemas/assetsInputsAuxInputResponseBody' happenedAtTime: description: UTC timestamp in RFC 3339 format of the event. example: '2020-01-27T07:06:25Z' type: string units: description: 'Units of the values in the returned data. Valid values: `boolean`, `millivolts`, `microamps`' enum: - boolean - millivolts - microamps example: boolean type: string value: description: Value of the data point. example: '1' type: string required: - asset - happenedAtTime - units - value type: object PatchIssueRequestBodyAssignedToRequestBody: description: Issue assignee update object properties: id: description: ID of the issue assignee. example: '938172' type: string type: description: 'Type of the issue assignee. Valid values: `user`' enum: - user example: user type: string required: - id - type type: object JobsCreateJobNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsGetJobsInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsTableValueObjectResponseBody: description: The value of a table form input field. properties: columns: description: List of table columns. items: $ref: '#/components/schemas/FormsTableColumnObjectResponseBody' type: array rows: description: List of table rows. items: $ref: '#/components/schemas/FormsTableRowObjectResponseBody' type: array required: - columns - rows type: object TrailerAssignmentsUpdateDriverTrailerAssignmentBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferDoorStateZone3WithDecorationsTypeResponseBody: description: Door stats that have been emitted by the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: 'The door state of zone 2 of the reefer. Valid values: `open`, `closed`' enum: - open - closed example: closed type: string required: - time - value type: object TripAssetResponseBody: description: Asset that the location readings are tied to properties: id: description: Unique ID for the asset object that is reporting the location. example: '12345' type: string name: description: Name for the asset object that is reporting the location. Only returns when `includeAsset` is set to `true`. example: MyAsset-1234 type: string type: description: 'Type for the asset object that is reporting the location. Only returns when `includeAsset` is set to `true`. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' enum: - uncategorized - trailer - equipment - unpowered - vehicle example: trailer type: string vin: description: VIN for the asset object that is reporting the location. Only returns when `includeAsset` is set to `true`. example: 1GBJ6P1B2HV112765 type: string required: - id type: object JobsCreateJobServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsGetJobsServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsDeleteJobBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsScoreObjectResponseBody: description: Forms score object. properties: maxPoints: description: Total possible points of the form submission. example: 80 format: double type: number scorePercent: description: Percentage score of the form submission, calculated as scorePoints / maxPoints. example: 75 format: double type: number scorePoints: description: Score, in points, of the form submission. example: 60 format: double type: number required: - maxPoints - scorePercent - scorePoints type: object SpeedingIntervalsGetSpeedingIntervalsNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalLocationResponseResponseBody: description: Location object of the closest location point to the interval. properties: accuracyMeters: description: Radial accuracy of gps location in meters. This will only return if strong GPS is not available. example: 5.801 format: double type: number address: $ref: '#/components/schemas/AddressResponseResponseBody' headingDegrees: description: Heading of the asset in degrees. May be 0 if the asset is not moving. example: 120 format: int64 type: integer latitude: description: Latitude of the closest location point to the interval. example: 37.7749 format: double type: number longitude: description: Longitude of the closest location point to the interval. example: 137.2719 format: double type: number required: - address - headingDegrees - latitude - longitude type: object EquipmentPatchEquipmentTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempFleetListResponseBody: description: Contains a list of equipment objects and links properties: Equipment: description: The list of Equipment objects. items: $ref: '#/components/schemas/AempEquipmentWithAdditionalFieldsResponseBody' type: array Links: description: The list of links associated with the current API request. items: $ref: '#/components/schemas/AempLinkResponseBody' type: array snapshotTime: description: Date and time at which the snapshot of the fleet was created in RFC 3339 format. example: '2019-06-13T19:08:25Z' type: string version: description: The version of the ISO/TS 15143-3 standard example: '1' type: string required: - Equipment - Links - snapshotTime - version type: object FormsAssetObjectResponseBody: description: Tracked or untracked (i.e. manually entered) asset object. properties: entryType: description: 'The type of entry for the asset. Valid values: `tracked`, `untracked`' enum: - tracked - untracked example: tracked type: string id: description: ID of a tracked asset. Included if 'entryType' is 'tracked'. example: '281474982859091' type: string name: description: Name of an untracked (i.e. manually entered) asset. example: trailer 123 type: string required: - entryType type: object JobsDeleteJobUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsDeleteAssetTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsUpdateAssetGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerObjectResponseBody: description: A trailer asset object associate with the assigment. properties: trailerId: description: Samsara ID of the trailer. example: '494123' type: string required: - trailerId type: object FormSubmissionsGetFormSubmissionsStreamGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSupplyAirTemperatureMilliCZone3WithDecorationsTypeResponseBody: description: Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The supply or discharge air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object GoaGatewayTinyResponseResponseBody: description: A minified gateway object properties: model: description: 'The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`' enum: - AG15 - AG24 - AG24EU - AG26 - AG26EU - AG41 - AG41EU - AG45 - AG45EU - AG46 - AG46EU - AG46P - AG46PEU - AG51 - AG51EU - AG52 - AG52EU - AG53 - AG53EU - IG15 - IG21 - IG41 - IG61 - SG1 - SG1B - SG1G - SG1G32 - SG1x - VG32 - VG33 - VG34 - VG34EU - VG34FN - VG34M - VG54ATT - VG54EU - VG54FN - VG54NA - VG54NAE - VG54NAH - VG55EU - VG55FN - VG55NA example: VG34 type: string serial: description: The serial number of the gateway installed on the asset. example: GFRV-43N-VGX type: string required: - model - serial type: object TrailerStatsGetTrailerStatsHistoryBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferStateWithDecorationsTypeResponseBody: description: Reefer state event. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' substateValue: description: The substate of the multizone carrier reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The overall state of the multizone carrier reefer. example: '`Off`, `On`' type: string required: - time - value type: object TrailerStatReeferReturnAirTemperatureMilliCZone2WithDecorationsTypeResponseBody: description: Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The return air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object AssetsCreateAssetMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsGetJobsBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsTableColumnObjectResponseBody: description: Defines a column in a table form input field. properties: id: description: Unique identifier for the column. format: uuid type: string label: description: Label of the column. example: Store Number type: string type: description: 'Type of the column field. Valid values: `text, number, datetime, check_boxes, multiple_choice, signature, media, person`' enum: - text, number, datetime, check_boxes, multiple_choice, signature, media, person example: number type: string required: - id - label - type type: object AssetsListAssetsBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsGetJobsBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody: description: Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The supply or discharge air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object AssetsDeleteAssetBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormTemplateReferenceObjectResponseBody: description: Form template reference object. properties: id: description: ID of the form template. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 format: uuid type: string revisionId: description: ID of the form template revision. example: 1214a1fa-f0c6-408b-bf85-51dc3bc71ac7 format: uuid type: string required: - id - revisionId type: object TrailerStatsGetTrailerStatsFeedResponseBody: properties: data: description: List of trailers and their stats items: $ref: '#/components/schemas/TrailerStatsObjectResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object JobsGetJobsResponseBody: properties: data: description: List of Job Objects items: $ref: '#/components/schemas/JobResponseObjectResponseBody' type: array id: description: The job id of the failed request example: '1553' type: string pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' uuid: description: The uuid of the failed request example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string required: - data - pagination type: object assetsInputsAuxInputResponseBody: description: Auxiliary input metadata properties: name: description: Name of the auxiliary input example: PTO type: string required: - name type: object TrailerStatGpsWithDecorationsTypeResponseBody: description: GPS location data for the trailer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' headingDegrees: description: Heading of the trailer in degrees. example: 7952863434806629000 format: int64 type: integer latitude: description: GPS latitude represented in degrees. example: 0.14973496163559114 format: double type: number longitude: description: GPS longitude represented in degrees. example: 0.09035777949770978 format: double type: number reverseGeo: $ref: '#/components/schemas/ReverseGeoObjectResponseBody' speedMilesPerHour: description: GPS speed of the trailer in miles per hour. example: 7073647433567555000 format: int64 type: integer time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string required: - latitude - longitude - time type: object PatchJobObjectjobLocationRequestObjectRequestBody: description: A location object for the job properties: address: description: Address of a location example: 1990 Alameda st, San Francisco, Ca 94103 type: string latitude: description: Latitude of a location example: 37.456345 format: double type: number longitude: description: Longitude of a location example: 34.5633749 format: double type: number name: description: Name of the location example: 'Worksite #1' type: string required: - address - latitude - longitude - name type: object TrailerStatsGetTrailerStatsHistoryMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferObdEngineSecondsTypeResponseBody: description: Reefer onboard engine seconds reading. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The number of seconds the reefer has been on according to the onboard diagnostics. example: 50 format: int64 type: integer required: - time - value type: object JobsCreateJobBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object EquipmentPatchEquipmentInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesPatchIssueBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsDeleteAssetGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsDeleteAssetUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object PostJobObjectRequestBody: description: Job object to be created properties: address: $ref: '#/components/schemas/PostJobObjectjobLocationRequestObjectRequestBody' customerName: description: Customer name for job example: Samsara type: string endDate: description: End date of job in RFC 3339 format. Must be greater than or equal to the start date example: '2019-06-13T19:08:25Z' type: string fleetDeviceIds: description: Fleet devices to be added to this job (cannot have both industrial assets and fleet devices in the same job) example: - 1234567 - 654321 items: example: 2041379700111686100 format: int64 type: integer type: array id: description: Job Id example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string industrialAssetIds: description: IndustrialAssets to be added to this job (cannot have both industrial assets and fleet devices in the same job) example: - 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 - ba84a7e2-9c8d-481f-a248-7cce6b22be9d items: example: Beatae atque explicabo voluptatibus vitae. type: string type: array name: description: Job name example: My Job Name type: string notes: description: Notes for the upcoming job example: These are my notes maxLength: 2000 type: string ontimeWindowAfterArrivalMs: description: Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'. example: 300000 maximum: 259200000 minimum: 0 type: integer ontimeWindowBeforeArrivalMs: description: Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'. example: 300000 maximum: 259200000 minimum: 0 type: integer startDate: description: Start date of job in RFC 3339 format. example: '2019-06-13T19:08:25Z' type: string required: - endDate - id - name - startDate type: object PatchJobObjectRequestBody: description: Job object with fields to update. If a field is not provided, it will not be updated properties: address: $ref: '#/components/schemas/PatchJobObjectjobLocationRequestObjectRequestBody' customerName: description: Customer name for job example: Samsara type: string endDate: description: End date of job in RFC 3339 format. Must be greater than or equal to the start date example: '2019-06-13T19:08:25Z' type: string fleetDeviceIds: description: Fleet devices to be added to this job (cannot have both industrial assets and fleet devices in the same job) example: - 1234567 - 654321 items: example: 2152573018252048100 format: int64 type: integer type: array id: description: Job Id example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string industrialAssetIds: description: IndustrialAssets to be added to this job (cannot have both industrial assets and fleet devices in the same job) example: - 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 - ba84a7e2-9c8d-481f-a248-7cce6b22be9d items: example: Quia est explicabo quas doloremque sit ratione. type: string type: array name: description: Job name example: My Job Name type: string notes: description: Notes for the upcoming job example: These are my notes maxLength: 2000 type: string ontimeWindowAfterArrivalMs: description: Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'. example: 300000 maximum: 259200000 minimum: 0 type: integer ontimeWindowBeforeArrivalMs: description: Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'. example: 300000 maximum: 259200000 minimum: 0 type: integer startDate: description: Start date of job in RFC 3339 format. example: '2019-06-13T19:08:25Z' type: string type: object AssetsDeleteAssetInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsMediaValueObjectResponseBody: description: The value of a media form input field. properties: mediaList: description: List of forms media record objects. items: $ref: '#/components/schemas/FormsMediaRecordObjectResponseBody' type: array required: - mediaList type: object TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody: description: Set point temperature of zone 2 of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The set point temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object AssetsInputsGetAssetsInputsGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object EquipmentPatchEquipmentResponseBody: properties: data: $ref: '#/components/schemas/EquipmentWithAttributesResponseObjectResponseBody' required: - data type: object TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody: properties: data: description: List of training assignments. items: $ref: '#/components/schemas/TrainingAssignmentResponseObjectResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object AssetsUpdateAssetNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsCreateJobBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempLinkResponseBody: description: Contains a list of relevant links properties: href: description: The hyperlink of the relationship. example: https://api.samsara.com/aemp/Fleet/1 type: string rel: description: The link relationship to the current call. example: self type: string required: - href - rel type: object AempEquipmentGetAempEquipmentListNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSupplyAirTemperatureMilliCZone2WithDecorationsTypeResponseBody: description: Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The supply or discharge air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerStatReeferDoorStateZone1TypeResponseBody: description: The door state of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: 'The door state of zone 2 of the reefer. Valid values: `open`, `closed`' enum: - open - closed example: closed type: string required: - time - value type: object JobsCreateJobUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody: description: Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The return air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerStatReeferStateTypeResponseBody: description: Reefer state event. properties: substateValue: description: The substate of the multizone carrier reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The overall state of the multizone carrier reefer. example: '`Off`, `On`' type: string required: - time - value type: object FormsMultipleChoiceValueObjectResponseBody: description: The value of a multiple choice form input field. properties: value: description: Selected choice. example: 'Yes' type: string required: - value type: object JobsCreateJobRequestBody: description: Job object to be created properties: job: $ref: '#/components/schemas/PostJobObjectRequestBody' required: - job type: object IssuesPatchIssueUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferDoorStateZone1WithDecorationsTypeResponseBody: description: Door stats that have been emitted by the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: 'The door state of zone 2 of the reefer. Valid values: `open`, `closed`' enum: - open - closed example: closed type: string required: - time - value type: object EquipmentPatchEquipmentRequestBody: properties: attributes: description: List of attributes associated with the entity items: $ref: '#/components/schemas/GoaAttributeTiny' type: array engineHours: description: When you provide a manual engine hours override, Samsara will begin updating a equipment's engine hours used since this override was set. example: 1234 format: int64 type: integer equipmentSerialNumber: description: The serial number of the equipment. example: 8V8WD530FLN016251 type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed. example: '494123' type: string name: description: The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: Equipment-123 type: string notes: description: These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are my equipment notes maxLength: 255 type: string odometerMeters: description: When you provide a manual odometer override, Samsara will begin updating a equipment's odometer using GPS distance traveled since this override was set. example: 1234 format: int64 type: integer tagIds: description: 'An array of IDs of tags to associate with this equipment. If your access to the API is scoped by one or more tags, this field is required to pass in. ' example: - Porro dolor provident consequatur est. - Aperiam consequatur laborum magnam illum a veniam. items: example: Corporis aut quas. type: string type: array type: object JobsGetJobsGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TripSpeedingIntervalsResponseBody: description: TripSpeedingIntervals properties: asset: $ref: '#/components/schemas/TripAssetResponseBody' createdAtTime: description: UTC time the trip was created in Samsara in RFC 3339 format. example: '2023-01-27T07:06:25Z' type: string driverId: description: The driver ID assigned to the trip. Only returned if includeDriverId is set to true. 'null' if no driver id. example: '12345' type: string intervals: description: List of speeding intervals that belong to the trip. The full list of intervals associated with the trip is always returned, empty if no intervals exist. items: $ref: '#/components/schemas/SpeedingIntervalResponseBody' type: array tripStartTime: description: UTC time the trip started in RFC 3339 format. example: '2023-01-27T07:06:25Z' type: string updatedAtTime: description: UTC time the trip was last updated in Samsara in RFC 3339 format. Valid updates are when trip's endTime populates or interval.isDismissed changes value. example: '2023-01-27T10:04:20Z' type: string required: - asset - createdAtTime - intervals - tripStartTime - updatedAtTime type: object AempEquipmentGetAempEquipmentListBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsHistoryNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferObdEngineSecondsWithDecorationsTypeResponseBody: description: Reefer onboard engine seconds reading. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The number of seconds the reefer has been on according to the onboard diagnostics. example: 50 format: int64 type: integer required: - time - value type: object JobsDeleteJobInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object GoaAttributeTinyResponseBody: description: Attribute properties. properties: id: description: Id of the attribute example: '494123' type: string name: description: Name of the attribute example: Compliance/ELD type: string numberValues: description: List of number values associated with the attribute example: - 867 - 5309 items: example: 0.7405685598633346 format: double type: number type: array stringValues: description: List of string values associated with the attribute. example: - HQ - Leased items: example: Tempora dolorum placeat. type: string type: array type: object IssuesPatchIssueGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object jobLocationResponseObjectResponseBody: description: jobLocation object properties: address: description: Address of a location example: 1990 Alameda st, San Francisco, Ca 94103 type: string latitude: description: Latitude of a location example: 37.456345 format: double type: number longitude: description: Longitude of a location example: 34.5633749 format: double type: number name: description: Name of a location example: 'Worksite #1' type: string required: - address - latitude - longitude - name type: object AssetsListAssetsBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody: description: Reefer ambient air temperature reading. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The ambient air temperature reading of the reefer in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerAssignmentsGetDriverTrailerAssignmentsNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsCreateJobGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesPatchIssueInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody: description: Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The supply or discharge air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrainingAssignmentsGetTrainingAssignmentsStreamMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object GoaPaginationResponseResponseBody: description: Pagination parameters. properties: endCursor: description: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view. example: MjkY type: string hasNextPage: description: True if there are more pages of results immediately available after this endCursor. example: true type: boolean required: - endCursor - hasNextPage type: object TrailerStatReeferSupplyAirTemperatureMilliCZone1WithDecorationsTypeResponseBody: description: Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The supply or discharge air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerAssignmentsGetDriverTrailerAssignmentsServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssueSourceObjectResponseBody: description: Contains information about where an issue came from. properties: id: description: ID of the issue's source object. The format depends on the 'type'. Included if 'type' is not 'ad-hoc'. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 type: string type: description: 'The type of issue source. Valid values: `form`, `ad-hoc`' enum: - form - ad-hoc example: form type: string required: - type type: object industrialAssetObjectResponseBody: description: industrialAssetObject properties: id: description: Id of the device example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string name: description: Name of the industrial asset example: My asset type: string required: - id - name type: object TrailerStatsObjectResponseBody: description: A trailer and its stats properties: carrierReeferState: description: A list of engine state points. items: $ref: '#/components/schemas/TrailerStatReeferStateWithDecorationsTypeResponseBody' type: array gps: description: A list of GPS points. items: $ref: '#/components/schemas/TrailerStatGpsWithDecorationsTypeResponseBody' type: array gpsOdometerMeters: description: A list of odometer points. items: $ref: '#/components/schemas/TrailerStatGpsOdometerMetersWithDecorationsTypeResponseBody' type: array id: description: ID of the trailer. example: '1234' type: string name: description: Name of the vehicle. example: Trailer-123 type: string reeferAlarms: description: A list of reefer alarm points. items: $ref: '#/components/schemas/TrailerStatReeferAlarmWithDecorationsTypeResponseBody' type: array reeferAmbientAirTemperatureMilliC: description: A list of ambient air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferAmbientAirTemperatureWithDecorationsTypeResponseBody' type: array reeferDoorStateZone1: description: A list of door state points. items: $ref: '#/components/schemas/TrailerStatReeferDoorStateZone1WithDecorationsTypeResponseBody' type: array reeferDoorStateZone2: description: A list of door state points. items: $ref: '#/components/schemas/TrailerStatReeferDoorStateZone2WithDecorationsTypeResponseBody' type: array reeferDoorStateZone3: description: A list of door state points. items: $ref: '#/components/schemas/TrailerStatReeferDoorStateZone3WithDecorationsTypeResponseBody' type: array reeferFuelPercent: description: A list of fuel percent points. items: $ref: '#/components/schemas/TrailerStatReeferFuelPercentWithDecorationsTypeResponseBody' type: array reeferObdEngineSeconds: description: A list of engine second points items: $ref: '#/components/schemas/TrailerStatReeferObdEngineSecondsWithDecorationsTypeResponseBody' type: array reeferReturnAirTemperatureMilliCZone1: description: A list of return air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone1WithDecorationsTypeResponseBody' type: array reeferReturnAirTemperatureMilliCZone2: description: A list of return air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone2WithDecorationsTypeResponseBody' type: array reeferReturnAirTemperatureMilliCZone3: description: A list of return air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone3WithDecorationsTypeResponseBody' type: array reeferRunMode: description: A list of run mode points items: $ref: '#/components/schemas/TrailerStatReeferRunModeWithDecorationsTypeResponseBody' type: array reeferSetPointTemperatureMilliCZone1: description: A list of set point temperature points. items: $ref: '#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone1WithDecorationsTypeResponseBody' type: array reeferSetPointTemperatureMilliCZone2: description: A list of set point temperature points. items: $ref: '#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone2WithDecorationsTypeResponseBody' type: array reeferSetPointTemperatureMilliCZone3: description: A list of set point temperature points. items: $ref: '#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone3WithDecorationsTypeResponseBody' type: array reeferStateZone1: description: A list of engine state points. items: $ref: '#/components/schemas/TrailerStatReeferStateZone1WithDecorationsTypeResponseBody' type: array reeferStateZone2: description: A list of engine state points. items: $ref: '#/components/schemas/TrailerStatReeferStateZone2WithDecorationsTypeResponseBody' type: array reeferStateZone3: description: A list of engine state points. items: $ref: '#/components/schemas/TrailerStatReeferStateZone3WithDecorationsTypeResponseBody' type: array reeferSupplyAirTemperatureMilliCZone1: description: A list of supply air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone1WithDecorationsTypeResponseBody' type: array reeferSupplyAirTemperatureMilliCZone2: description: A list of supply air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone2WithDecorationsTypeResponseBody' type: array reeferSupplyAirTemperatureMilliCZone3: description: A list of supply air temperature points. items: $ref: '#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone3WithDecorationsTypeResponseBody' type: array required: - id - name type: object TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody: description: Set point temperature of zone 1 of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The set point temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerStatsGetTrailerStatsHistoryServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamResponseBody: properties: data: description: List of form submissions. items: $ref: '#/components/schemas/FormSubmissionResponseObjectResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object TrailerStatReeferDoorStateZone3TypeResponseBody: description: The door state of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: 'The door state of zone 2 of the reefer. Valid values: `open`, `closed`' enum: - open - closed example: closed type: string required: - time - value type: object EquipmentHeaderWithAdditionalFieldsResponseBody: description: Equipment header fields. properties: EquipmentID: description: The unique Samsara ID of the equipment. This is automatically generated when the Equipment object is created. It cannot be changed. example: '494123' type: string Model: description: The model of the equipment. example: S630 T4 type: string OEMName: description: The make of the equipment. example: Bobcat type: string PIN: description: The PIN number of the equipment. example: 8V8WD530FLN016251 type: string SerialNumber: description: The serial number of the equipment. example: 8V8WD530FLN016251 type: string UnitInstallDateTime: description: 'Telematics unit install date in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object TrailerStatReeferSetPointTemperatureMilliCZone1WithDecorationsTypeResponseBody: description: Set point temperature of zone 1 of the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The set point temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object EquipmentPatchEquipmentNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody: properties: data: description: List of driver trailer assignment objects and their respective driver and trailer info. items: $ref: '#/components/schemas/GetDriverTrailerAssignmentsResponseBodyResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody: description: Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The return air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrailerStatsGetTrailerStatsHistoryTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object EquipmentPatchEquipmentMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object DEFRemainingResponseBody: description: DEF remaining in equipment. properties: Percent: description: Percent of DEF remaining in tank. example: 12 format: double type: number datetime: description: 'Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object TrailerStatReeferAlarmResponseBody: properties: alarmCode: description: The ID of the alarm. example: '3' type: string description: description: The description of the alarm. example: Test alarm type: string operatorAction: description: The recommended operator action. example: Manually disable alarm type: string severity: description: 'The severity of the alarm. `1`: Ok to run, `2`: Check as specified, `3`: Take immediate action.' example: 6644289420805649000 format: int64 type: integer required: - alarmCode - description - operatorAction - severity type: object AssetsUpdateAssetMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object GoaTagTinyResponseResponseBody: description: A minified tag object properties: id: description: ID of the tag example: '3914' type: string name: description: Name of the tag. example: East Coast type: string parentTagId: description: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. example: '4815' type: string required: - id - name type: object AssetsDeleteAssetMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object PostDriverTrailerAssignmentsResponseBodyResponseBody: description: Response after successfully submitting a Driver Trailer Assignment properties: createdAtTime: description: Time when the driver trailer assignment was created, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string driverId: description: Samsara ID for the driver that this assignment is for. example: 0987 type: string id: description: Samsara ID for the assignment. example: 08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6 type: string startTime: description: Time when the driver trailer assignment starts, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string trailerId: description: Samsara ID of the trailer example: '494123' type: string updatedAtTime: description: Time when the driver trailer assignment was last updated, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string required: - createdAtTime - driverId - id - startTime - trailerId - updatedAtTime type: object JobsGetJobsUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody: description: Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The supply or discharge air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object TrainingAssignmentsGetTrainingAssignmentsStreamBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsUpdateAssetServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsTableRowObjectResponseBody: description: Defines a row in a table form input field. properties: cells: description: List of cells in the row. items: $ref: '#/components/schemas/FormsTableCellObjectResponseBody' type: array id: description: Unique identifier for the row. format: uuid type: string required: - cells - id type: object JobsCreateJobResponseBody: properties: data: $ref: '#/components/schemas/JobResponseObjectResponseBody' id: description: The job id of the failed request example: '1553' type: string uuid: description: The uuid of the failed request example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string required: - data type: object TrailerStatsGetTrailerStatsFeedTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody: properties: data: $ref: '#/components/schemas/PatchDriverTrailerAssignmentsResponseBodyResponseBody' required: - data type: object TrailerAssignmentsGetDriverTrailerAssignmentsNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingLearnerObjectResponseBody: description: Learner that is associated with the training assignment. Only driver learners are supported currently. properties: id: description: ID of the polymorphic user. example: '938172' type: string type: description: 'The type of the polymorphic user. Valid values: `driver`' enum: - driver example: driver type: string required: - id - type type: object JobsDeleteJobMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsAssetResponseResponseBody: description: Asset that the input data is from. properties: attributes: description: List of attributes associated with the entity items: $ref: '#/components/schemas/GoaAttributeTinyResponseBody' type: array externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: ID of the asset example: '12345' type: string tags: description: The array of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset. items: $ref: '#/components/schemas/GoaTagTinyResponseResponseBody' type: array required: - id type: object AssetsInputsGetAssetsInputsInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsDeleteJobTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferStateZone2WithDecorationsTypeResponseBody: description: Reefer state event. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' substateValue: description: The substate zone 2 of the reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The state zone 2 of the reefer. example: '`Off`, `On`' type: string required: - time - value type: object IssuesPatchIssueMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsCheckBoxesValueObjectResponseBody: description: The value of a check boxes form input field. properties: value: description: List of selected options. example: - Option A - Option B items: description: Option example: Repudiandae eos. type: string type: array required: - value type: object DriverWithExternalIdObjectResponseBody: description: A driver object with an id and map of external ids. properties: driverId: description: Samsara ID of the driver. example: 0987 type: string externalIds: additionalProperties: type: string description: A map of external ids type: object required: - driverId type: object JobResponseObjectResponseBody: description: Job object to be passed back properties: address: $ref: '#/components/schemas/jobLocationResponseObjectResponseBody' createdAt: description: When the job was created example: '2019-06-13T19:08:25Z' type: string customerName: description: Customer name for job example: Samsara type: string endDate: description: End date of job in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string fleetDevices: description: fleet devices in this job (cannot have both industrial assets and fleet devices in the same job) items: $ref: '#/components/schemas/fleetDeviceObjectResponseBody' type: array id: description: Job id example: '1553' type: string industrialAssets: description: Industrial Assets in this job (cannot have both industrial assets and fleet devices in the same job) items: $ref: '#/components/schemas/industrialAssetObjectResponseBody' type: array modifiedAt: description: When the job was last modified example: '2019-06-13T19:08:25Z' type: string name: description: Job name example: My Job Name type: string notes: description: Notes for the upcoming job example: These are my notes maxLength: 2000 type: string ontimeWindowAfterArrivalMs: description: Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'. example: 300000 format: int64 type: integer ontimeWindowBeforeArrivalMs: description: Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'. example: 300000 format: int64 type: integer startDate: description: Start date of job in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string status: description: 'The current job status Valid values: `active`, `scheduled`, `completed`' enum: - active - scheduled - completed example: active type: string uuid: description: Samsara uuid example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string required: - address - createdAt - customerName - endDate - id - modifiedAt - name - notes - startDate - status - uuid type: object TrailerAssignmentsUpdateDriverTrailerAssignmentInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object DistanceResponseBody: description: Equipment odometer distance. properties: Odometer: description: Odometer value reported by equipment. example: 12 format: double type: number OdometerUnits: description: Unit of measurement for distance. example: kilometre type: string datetime: description: 'Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object FormsDateTimeValueObjectResponseBody: description: The value of a datetime form input field. properties: type: description: 'The type of datetime format. Valid values: `datetime`, `date`, `time`' enum: - datetime - date - time example: datetime type: string value: description: UTC timestamp in RFC 3339 format. example: '2024-08-08T18:53:23Z' format: date-time type: string required: - type - value type: object TrailerStatsGetTrailerStatsHistoryBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferStateZone1TypeResponseBody: description: Reefer state event. properties: substateValue: description: The substate zone 1 of the reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The state zone 1 of the reefer. example: '`Off`, `On`' type: string required: - time - value type: object IssuesPatchIssueRequestBody: description: Issue fields to update. properties: assignedTo: $ref: '#/components/schemas/PatchIssueRequestBodyAssignedToRequestBody' dueDate: description: Due date of the issue. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: ID of the issue. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the issue. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 type: string status: description: 'Status of the issue. Valid values: `open`, `inProgress`, `resolved`, `dismissed`' enum: - open - inProgress - resolved - dismissed example: open type: string required: - id type: object TrailerAssignmentsUpdateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsListAssetsNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingCourseObjectResponseBody: description: Course that is associated with the training assignments. properties: id: description: ID of the course. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 format: uuid type: string revisionId: description: ID of the course's specific version. example: 1214a1fa-f0c6-408b-bf85-51dc3bc71ac7 format: uuid type: string required: - id - revisionId type: object TrailerAssignmentsCreateDriverTrailerAssignmentTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsCreateJobInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormSubmissionsGetFormSubmissionsStreamUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsUpdateAssetInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsGetJobsNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatDecorationResponseBody: description: Decorated values for the primary trailer stat datapoints. properties: carrierReeferState: $ref: '#/components/schemas/TrailerStatReeferStateTypeResponseBody' gps: $ref: '#/components/schemas/TrailerStatGpsTypeResponseBody' gpsOdometerMeters: $ref: '#/components/schemas/TrailerStatGpsOdometerMetersTypeResponseBody' reeferAlarms: $ref: '#/components/schemas/TrailerStatReeferAlarmTypeResponseBody' reeferAmbientAirTemperatureMilliC: $ref: '#/components/schemas/TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody' reeferDoorStateZone1: $ref: '#/components/schemas/TrailerStatReeferDoorStateZone1TypeResponseBody' reeferDoorStateZone2: $ref: '#/components/schemas/TrailerStatReeferDoorStateZone2TypeResponseBody' reeferDoorStateZone3: $ref: '#/components/schemas/TrailerStatReeferDoorStateZone3TypeResponseBody' reeferFuelPercent: $ref: '#/components/schemas/TrailerStatReeferFuelPercentTypeResponseBody' reeferObdEngineSeconds: $ref: '#/components/schemas/TrailerStatReeferObdEngineSecondsTypeResponseBody' reeferReturnAirTemperatureMilliCZone1: $ref: '#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody' reeferReturnAirTemperatureMilliCZone2: $ref: '#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody' reeferReturnAirTemperatureMilliCZone3: $ref: '#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody' reeferRunMode: $ref: '#/components/schemas/TrailerStatReeferRunModeTypeResponseBody' reeferSetPointTemperatureMilliCZone1: $ref: '#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody' reeferSetPointTemperatureMilliCZone2: $ref: '#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody' reeferSetPointTemperatureMilliCZone3: $ref: '#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody' reeferStateZone1: $ref: '#/components/schemas/TrailerStatReeferStateZone1TypeResponseBody' reeferStateZone2: $ref: '#/components/schemas/TrailerStatReeferStateZone2TypeResponseBody' reeferStateZone3: $ref: '#/components/schemas/TrailerStatReeferStateZone3TypeResponseBody' reeferSupplyAirTemperatureMilliCZone1: $ref: '#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody' reeferSupplyAirTemperatureMilliCZone2: $ref: '#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody' reeferSupplyAirTemperatureMilliCZone3: $ref: '#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody' type: object PostJobObjectjobLocationRequestObjectRequestBody: description: A location object for the job properties: address: description: Address of a location example: 1990 Alameda st, San Francisco, Ca 94103 type: string latitude: description: Latitude of a location example: 37.456345 format: double type: number longitude: description: Longitude of a location example: 34.5633749 format: double type: number name: description: Name of the location example: 'Worksite #1' type: string required: - address - latitude - longitude - name type: object TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody: description: Create a new driver-trailer assignment properties: driverId: description: ID of the driver. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver. example: '494123' type: string startTime: description: The start time in RFC 3339 format. The time needs to be current or within the past 7 days. Defaults to now if not provided example: '2019-06-13T19:08:25Z' type: string trailerId: description: ID of the trailer. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the trailer. example: '12345' type: string required: - driverId - trailerId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody: description: Update a new driver-trailer assignment properties: endTime: description: The end time in RFC 3339 format. The end time should not be in the future example: '2019-06-13T19:08:25Z' type: string required: - endTime type: object JobsPatchJobGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsPolymorphicUserObjectResponseBody: description: User or driver object. properties: id: description: ID of the polymorphic user. example: '938172' type: string type: description: 'The type of the polymorphic user. Valid values: `driver`, `user`' enum: - driver - user example: driver type: string required: - id - type type: object CumulativeOperatingHoursResponseBody: description: Equipment operating hours. properties: Hour: description: Total number of equipment operating hours. example: 12.34 format: double type: number datetime: description: 'Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object GetDriverTrailerAssignmentsResponseBodyResponseBody: description: Object with driver assignment information and associated driver and trailer information. properties: createdAtTime: description: Time when the driver trailer assignment was created, in RFC 3339 format. example: '2019-06-13T19:08:25Z' type: string driver: $ref: '#/components/schemas/DriverWithExternalIdObjectResponseBody' endTime: description: Time when the driver trailer assignment will end, in RFC 3339 format. example: '2019-06-13T20:10:25Z' type: string id: description: Samsara ID of the driver trailer assignment. example: 08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6 type: string startTime: description: Time when the driver trailer assignment starts, in RFC 3339 format. example: '2019-06-13T19:08:25Z' type: string trailer: $ref: '#/components/schemas/TrailerObjectResponseBody' updatedAtTime: description: Time when the driver trailer assignment was last updated, in RFC 3339 format. example: '2019-06-13T19:10:25Z' type: string required: - driver - id - startTime - trailer type: object AssetsListAssetsNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferReturnAirTemperatureMilliCZone3WithDecorationsTypeResponseBody: description: Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The return air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object AssetsUpdateAssetUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FuelRemainingResponseBody: description: Fuel remaining in equipment. properties: Percent: description: Percent of fuel remaining in tank. example: 12 format: double type: number datetime: description: 'Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).' example: '2019-06-13T19:08:25Z' type: string type: object TrailerAssignmentsUpdateDriverTrailerAssignmentBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssueResponseObjectResponseBody: description: Issue response object. properties: asset: $ref: '#/components/schemas/FormsAssetObjectResponseBody' assignedTo: $ref: '#/components/schemas/FormsPolymorphicUserObjectResponseBody' createdAtTime: description: Creation time of the issue. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string description: description: Description of the issue. Included if the issue was given a description. example: Oil spill in left corner of SF1 type: string dueDate: description: Due date of the issue. UTC timestamp in RFC 3339 format. Included if the issue was assigned a due date. example: '2019-06-13T19:08:25Z' format: date-time type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: ID of the issue. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 type: string issueSource: $ref: '#/components/schemas/IssueSourceObjectResponseBody' mediaList: description: List of media objects for the issue. Included if the issue has media. items: $ref: '#/components/schemas/FormsMediaRecordObjectResponseBody' type: array priority: description: 'Priority of the issue. Included if the issue was assigned a priority. Valid values: `low`, `medium`, `high`' enum: - low - medium - high example: high type: string status: description: 'Status of the issue. Valid values: `open`, `inProgress`, `resolved`, `dismissed`' enum: - open - inProgress - resolved - dismissed example: open type: string submittedAtTime: description: Submission time of the issue. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string submittedBy: $ref: '#/components/schemas/FormsPolymorphicUserObjectResponseBody' title: description: Title of the issue. example: Oil spill type: string updatedAtTime: description: Update time of the issue. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string required: - createdAtTime - id - issueSource - status - submittedAtTime - submittedBy - title - updatedAtTime type: object JobsDeleteJobBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsPersonObjectResponseBody: description: Tracked or untracked (i.e. manually entered) person object. properties: entryType: description: 'The type of entry for the person. Valid values: `tracked`, `untracked`' enum: - tracked - untracked example: tracked type: string name: description: Name of an untracked (i.e. manually entered) person. example: Jake type: string polymorphicUserId: $ref: '#/components/schemas/FormsPolymorphicUserObjectResponseBody' required: - entryType type: object EquipmentPatchEquipmentBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobResponseBody: properties: data: $ref: '#/components/schemas/JobResponseObjectResponseBody' id: description: The job id of the failed request example: '1553' type: string uuid: description: The uuid of the failed request example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string required: - data type: object EquipmentPatchEquipmentNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsResponseBody: properties: data: description: Array of assets inputs objects. items: $ref: '#/components/schemas/assetsInputsResponseResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object TrailerStatReeferDoorStateZone2TypeResponseBody: description: The door state of the reefer. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: 'The door state of zone 2 of the reefer. Valid values: `open`, `closed`' enum: - open - closed example: closed type: string required: - time - value type: object AssetsUpdateAssetBadGatewayErrorResponseBody: description: Bad Gateway properties: message: description: Message of error example: 'rpc error: code = Unknown desc = connection refused' type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsCreateAssetResponseBody: properties: createdAtTime: description: The time the asset was created in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: The unique ID of the asset. example: '12345' type: string licensePlate: description: The license plate of the asset. example: XHK1234 type: string make: description: The manufacturer of the asset. (If a VIN is entered and the system detects it is registered to a different manufacturer than provided an error will be returned). example: Bobcat type: string model: description: The manufacturer model of the asset. (If a VIN is entered and the system detects it is registered to a different model than provided an error will be returned). example: S630 T4 type: string name: description: The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: MyAsset-1234 type: string notes: description: These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are notes. type: string regulationMode: description: 'Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`' enum: - mixed - regulated - unregulated example: mixed type: string serialNumber: description: The serial number of the asset. example: 8V8WD530FLN016251 type: string tags: description: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset. items: $ref: '#/components/schemas/GoaTagTinyResponseResponseBody' type: array type: default: uncategorized description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' enum: - uncategorized - trailer - equipment - unpowered - vehicle example: trailer type: string updatedAtTime: description: The time the asset was last updated in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string vin: description: The vehicle identification number of the asset. example: 1FUJBBCKXCLBZ1234 type: string year: description: The year of manufacture of the asset. (If a VIN is entered and the system detects it is registered to a different year than provided an error will be returned). example: 2015 format: int64 type: integer required: - createdAtTime - id - updatedAtTime type: object TrailerStatsGetTrailerStatsHistoryGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsDeleteJobNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsListAssetsServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsHistoryUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AempEquipmentGetAempEquipmentListMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesGetIssuesInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody: description: Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit. properties: time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The return air temperature reading in millidegree Celsius. example: 50 format: int64 type: integer required: - time - value type: object AssetsCreateAssetBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody: properties: data: $ref: '#/components/schemas/PostDriverTrailerAssignmentsResponseBodyResponseBody' required: - data type: object AssetsCreateAssetServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsCreateJobMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsGetDriverTrailerAssignmentsInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsInputsGetAssetsInputsNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsDeleteJobResponseBody: properties: id: description: The job id of the failed request example: '1553' type: string uuid: description: The uuid of the failed request example: 8d218e6c-7a16-4f9f-90f7-cc1d93b9e596 type: string type: object FormsAssetValueObjectResponseBody: description: The value of an asset form input field. properties: asset: $ref: '#/components/schemas/FormsAssetObjectResponseBody' required: - asset type: object IssuesGetIssuesServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatReeferStateZone1WithDecorationsTypeResponseBody: description: Reefer state event. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' substateValue: description: The substate zone 1 of the reefer, if available. example: '`Pretrip`, `Defrost`' type: string time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The state zone 1 of the reefer. example: '`Off`, `On`' type: string required: - time - value type: object AempEquipmentGetAempEquipmentListGatewayTimeoutErrorResponseBody: description: Gateway timeout properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatsGetTrailerStatsFeedUnauthorizedErrorResponseBody: description: Unauthorized properties: message: description: Message of error example: Invalid token. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerStatGpsTypeResponseBody: description: GPS location data for the trailer. properties: headingDegrees: description: Heading of the trailer in degrees. example: 5478981605182468000 format: int64 type: integer latitude: description: GPS latitude represented in degrees. example: 0.955367680792097 format: double type: number longitude: description: GPS longitude represented in degrees. example: 0.1542964882122642 format: double type: number reverseGeo: $ref: '#/components/schemas/ReverseGeoObjectResponseBody' speedMilesPerHour: description: GPS speed of the trailer in miles per hour. example: 6626263886997561000 format: int64 type: integer time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string required: - latitude - longitude - time type: object TrailerStatGpsOdometerMetersWithDecorationsTypeResponseBody: description: Trailer GPS odometer event. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: Number of meters the trailer has traveled according to the GPS calculations and the manually specified odometer reading. example: 50 format: int64 type: integer required: - time - value type: object JobsGetJobsMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsIssueCreatedByFieldObjectResponseBody: description: Issue created from this form input field input object. properties: externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: ID of the issue created from this form input field input object. example: '12345' type: string required: - id type: object ReverseGeoObjectResponseBody: description: Reverse geocoded information properties: formattedLocation: description: Formatted address of the reverse geocoding data. example: 850 Made Up Lane, Orange, CA type: string type: object TrailerStatsGetTrailerStatsFeedInternalServerErrorResponseBody: description: An internal server error occurred properties: message: description: Message of error example: Failed to execute GraphQL query. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentsGetTrainingAssignmentsStreamServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object JobsPatchJobBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object SpeedingIntervalsGetSpeedingIntervalsResponseBody: properties: data: description: List of speeding intervals associated with trips. items: $ref: '#/components/schemas/TripSpeedingIntervalsResponseBody' type: array pagination: $ref: '#/components/schemas/GoaPaginationResponseResponseBody' required: - data - pagination type: object TrailerAssignmentsCreateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody: description: Method not allowed properties: message: description: Message of error example: DELETE not allowed on /endpoint. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesPatchIssueTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object FormsFieldInputObjectResponseBody: description: Forms input field object. properties: assetValue: $ref: '#/components/schemas/FormsAssetValueObjectResponseBody' checkBoxesValue: $ref: '#/components/schemas/FormsCheckBoxesValueObjectResponseBody' dateTimeValue: $ref: '#/components/schemas/FormsDateTimeValueObjectResponseBody' id: description: ID of the forms input field object. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 format: uuid type: string issue: $ref: '#/components/schemas/FormsIssueCreatedByFieldObjectResponseBody' label: description: Forms input field label. example: Engine Hours type: string mediaList: description: List of forms media record objects. items: $ref: '#/components/schemas/FormsMediaRecordObjectResponseBody' type: array mediaValue: $ref: '#/components/schemas/FormsMediaValueObjectResponseBody' multipleChoiceValue: $ref: '#/components/schemas/FormsMultipleChoiceValueObjectResponseBody' note: description: A note attached to the field input. example: Fire and oil can lead to an accident. type: string numberValue: $ref: '#/components/schemas/FormsNumberValueObjectResponseBody' personValue: $ref: '#/components/schemas/FormsPersonValueObjectResponseBody' signatureValue: $ref: '#/components/schemas/FormsSignatureValueObjectResponseBody' tableValue: $ref: '#/components/schemas/FormsTableValueObjectResponseBody' textValue: $ref: '#/components/schemas/FormsTextValueObjectResponseBody' type: description: 'Type of the field. Valid values: `number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table`' enum: - number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table example: number type: string required: - id - type type: object TrailerStatsGetTrailerStatsFeedNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AddressResponseResponseBody: description: Closest address that the GPS latitude and longitude match to. properties: city: description: The name of the city example: New York type: string country: description: The country example: USA type: string neighborhood: description: The name of the neighborhood if one exists example: Mission District type: string pointOfInterest: description: Point that may be of interest to the user example: The Eiffel Tower type: string postalCode: description: The zip code example: '10010' type: string state: description: The name of the state example: New York type: string street: description: The street name example: Main Street type: string streetNumber: description: Street number of the address example: '16' type: string type: object JobsCreateJobTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesPatchIssueNotFoundErrorResponseBody: description: Resource not found properties: message: description: Message of error example: Object not found. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object AssetsUpdateAssetTooManyRequestsErrorResponseBody: description: Too many requests properties: message: description: Message of error example: Exceeded rate limit. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrainingAssignmentResponseObjectResponseBody: description: Training Assignment response object. properties: completedAtTime: description: Time training assignment is completed. UTC timestamp in RFC 3339 format. Returned when a training assignment completion status is "complete". example: '2019-06-13T19:08:25Z' format: date-time type: string course: $ref: '#/components/schemas/TrainingCourseObjectResponseBody' createdAtTime: description: Creation time of the training assignment. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string createdById: description: ID of the user who created the training assignment. example: user-4392 type: string deletedAtTime: description: Time training assignment is deleted. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string dueAtTime: description: Time training assignment is due. UTC timestamp in RFC 3339 format. Returned when an assignment has a due date set by an admin. example: '2019-06-13T19:08:25Z' format: date-time type: string durationMinutes: description: Time spent on the training assignment. example: 2750596961262481000 format: int64 type: integer id: description: ID of the training assignment. example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7 type: string isCompletedLate: description: Indicates whether the training assignment was completed on time or not. Returned when a training assignment completion status is "complete" and has a dueAtTime set by an admin. example: true type: boolean isOverdue: description: Indicates whether the training assignment is past the due date. Returned when a training assignment completion status is 'inProgress' or 'notStarted' and has a dueAtTime set by an admin. example: true type: boolean learner: $ref: '#/components/schemas/TrainingLearnerObjectResponseBody' scorePercent: description: Quiz score associated with training assignment. Returned when a training assignment completion status is "complete". example: 0.5695960957385368 format: double type: number startedAtTime: description: Time training assignment is started. UTC timestamp in RFC 3339 format. Returned when a training assignment completion status is "complete" or "inProgress". example: '2019-06-13T19:08:25Z' format: date-time type: string status: description: 'State for the Training Assignment. Always returned. Valid values: `notStarted`, `inProgress`, `completed`' enum: - notStarted - inProgress - completed example: inProgress type: string updatedAtTime: description: Time training assignment was updated by either a learner or an admin. UTC timestamp in RFC 3339 format. example: '2019-06-13T19:08:25Z' format: date-time type: string updatedById: description: ID of the user who updated the training assignment, either an admin or a learner. example: user-3112 type: string required: - course - createdAtTime - createdById - durationMinutes - id - learner - status - updatedAtTime - updatedById type: object TrailerStatReeferFuelPercentWithDecorationsTypeResponseBody: description: The fuel percentage of the reefer. properties: decorations: $ref: '#/components/schemas/TrailerStatDecorationResponseBody' time: description: UTC timestamp in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string value: description: The fuel level in percentage points (e.g. `99`, `50`, etc). example: 50 format: int64 type: integer required: - time - value type: object AssetsUpdateAssetResponseBody: properties: createdAtTime: description: The time the asset was created in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string externalIds: additionalProperties: type: string description: A map of external ids type: object id: description: The unique ID of the asset. example: '12345' type: string licensePlate: description: The license plate of the asset. example: XHK1234 type: string make: description: The manufacturer of the asset. (If a VIN is entered and the system detects it is registered to a different manufacturer than provided an error will be returned). example: Bobcat type: string model: description: The manufacturer model of the asset. (If a VIN is entered and the system detects it is registered to a different model than provided an error will be returned). example: S630 T4 type: string name: description: The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. example: MyAsset-1234 type: string notes: description: These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time. example: These are notes. type: string regulationMode: description: 'Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`' enum: - mixed - regulated - unregulated example: mixed type: string serialNumber: description: The serial number of the asset. example: 8V8WD530FLN016251 type: string tags: description: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset. items: $ref: '#/components/schemas/GoaTagTinyResponseResponseBody' type: array type: default: uncategorized description: 'The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`' enum: - uncategorized - trailer - equipment - unpowered - vehicle example: trailer type: string updatedAtTime: description: The time the asset was last updated in RFC 3339 format. example: '2020-01-27T07:06:25Z' type: string vin: description: The vehicle identification number of the asset. example: 1FUJBBCKXCLBZ1234 type: string year: description: The year of manufacture of the asset. (If a VIN is entered and the system detects it is registered to a different year than provided an error will be returned). example: 2015 format: int64 type: integer required: - createdAtTime - id - updatedAtTime type: object TrailerAssignmentsUpdateDriverTrailerAssignmentNotImplementedErrorResponseBody: description: Requested endpoint is not yet implemented properties: message: description: Message of error example: Not implemented. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object IssuesPatchIssueResponseBody: properties: data: $ref: '#/components/schemas/IssueResponseObjectResponseBody' required: - data type: object FormSubmissionsGetFormSubmissionsStreamBadRequestErrorResponseBody: description: Bad Request parameters properties: message: description: Message of error example: Invalid value for parameter. type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object TrailerAssignmentsUpdateDriverTrailerAssignmentServiceUnavailableErrorResponseBody: description: Service unavailable properties: message: description: Message of error example: context deadline exceeded type: string requestId: description: The request ID; used when reaching out to support for issues with requests. example: 8916e1c1 type: string required: - message - requestId type: object PatchDriverTrailerAssignmentsResponseBodyResponseBody: description: Response after successfully updating a Driver Trailer Assignment properties: createdAtTime: description: Time when the driver trailer assignment was created, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string driverId: description: Samsara ID for the driver that this assignment is for. example: 0987 type: string endTime: description: Time when the driver trailer assignment ends, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string id: description: Samsara ID for the assignment. example: 08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6 type: string startTime: description: Time when the driver trailer assignment starts, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string trailerId: description: Samsara ID of the trailer example: '494123' type: string updatedAtTime: description: Time when the driver trailer assignment was last updated, in RFC 3339 format example: '2019-06-13T19:08:25Z' type: string required: - driverId - endTime - id - startTime - trailerId type: object securitySchemes: AccessTokenHeader: type: http scheme: bearer x-original-swagger-version: '2.0' x-readme: explorer-enabled: true proxy-enabled: true