{ "opencollection": "1.0.0", "info": { "name": "Samsara Industrial API", "version": "2024-11-18" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Industrial", "type": "folder" }, "items": [ { "info": { "name": "[beta] Fetches All Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.samsara.com/beta/industrial/jobs", "params": [ { "name": "id", "value": "", "type": "query", "description": "A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`)." }, { "name": "startDate", "value": "", "type": "query", "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)." }, { "name": "endDate", "value": "", "type": "query", "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)." }, { "name": "industrialAssetIds", "value": "", "type": "query", "description": "IndustrialAssetId in STRING format. (Example: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`)." }, { "name": "fleetDeviceIds", "value": "", "type": "query", "description": "FleetDeviceId in INTEGER format. (Example: `123456`)." }, { "name": "status", "value": "", "type": "query", "description": "A job status in STRING format. Job statuses can be one of three (ignores case): `\"active\", \"scheduled\", \"completed\"` Valid values: `active`, `scheduled`, `completed`" }, { "name": "customerName", "value": "", "type": "query", "description": "Customer name to filter by" }, { "name": "after", "value": "", "type": "query", "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." } ] }, "docs": "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 noti" }, { "info": { "name": "[beta] Create a Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.samsara.com/beta/industrial/jobs", "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "[beta] Patches a Job", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.samsara.com/beta/industrial/jobs", "params": [ { "name": "id", "value": "", "type": "query", "description": "A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 inaccu" }, { "info": { "name": "[beta] Deletes an Existing Job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.samsara.com/beta/industrial/jobs", "params": [ { "name": "id", "value": "", "type": "query", "description": "A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`)." } ] }, "docs": "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 A" }, { "info": { "name": "Get Machines", "type": "http" }, "http": { "method": "POST", "url": "https://api.samsara.com/v1/machines/list" }, "docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nGet machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them. \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 documentati" } ] } ], "bundled": true }