# huvrdata Documentation > The Inspection Data Management Software Platform you need to aggregate, automate and analyze all of your inspection data from any source. ## Guides - [Getting Started](https://docs.huvrdata.app/docs/getting-started.md) - [Access Token Authentication](https://docs.huvrdata.app/docs/authentication.md) - [Pagination Guide](https://docs.huvrdata.app/docs/pagination-guide.md) - [Checklist Field Updates](https://docs.huvrdata.app/docs/field-updates.md) - [Key Models](https://docs.huvrdata.app/docs/key-models.md) - [HUVR Nomenclature](https://docs.huvrdata.app/docs/huvr-nomenclature.md) ## API Reference - [list asset notes](https://docs.huvrdata.app/reference/api_asset-notes_list.md): List notes for an asset. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_view - [create asset notes](https://docs.huvrdata.app/reference/api_asset-notes_create.md): Create a note for an asset. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [read asset notes](https://docs.huvrdata.app/reference/api_asset-notes_read.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_view - [partial_update asset notes](https://docs.huvrdata.app/reference/api_asset-notes_partial_update.md): Update a note. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [delete asset notes](https://docs.huvrdata.app/reference/api_asset-notes_delete.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [create asset types](https://docs.huvrdata.app/reference/api_asset-types_create-3.md): Asset Type endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [read asset types](https://docs.huvrdata.app/reference/api_asset-types_read-3.md): Return the specific asset type :params id asset ID Required permissions: - IsAuthenticated - WorkspaceRequired - [update asset types](https://docs.huvrdata.app/reference/api_asset-types_update-3.md): AssetType updates Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [partial_update asset types](https://docs.huvrdata.app/reference/api_asset-types_partial_update-3.md): Asset Type endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [delete asset types](https://docs.huvrdata.app/reference/api_asset-types_delete-3.md): Asset Type endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [list asset types](https://docs.huvrdata.app/reference/api_asset-types_list.md): Returns an array asset types. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get all Assets](https://docs.huvrdata.app/reference/api_assets_list-3.md): Returns an array of assets. Required permissions: - IsAuthenticated - WorkspaceRequired - [Create Asset](https://docs.huvrdata.app/reference/api_assets_create-3.md): Create a new asset. Asset name and parent must be unique. Assets are stored in a folder like structure with a parent-child relationship. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_create - [Get Asset Condition Map](https://docs.huvrdata.app/reference/api_assets_asset_condition_map-3.md): Returns a list of asset with conditions and location. Lighter version of asset list to support more data displayed on the map. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get Asset Filters/Summary](https://docs.huvrdata.app/reference/api_assets_filters-3.md): Returns object with a list of owners(companies), parents(sites), asset types, asset conditions, and labels No query parameters are supported on this endpoint. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get Asset Tree](https://docs.huvrdata.app/reference/api_assets_tree-3.md): Returns a tree of assets with parent-child relationships. Does not currently support query parameters. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get Asset](https://docs.huvrdata.app/reference/api_assets_read-3.md): Return the specific asset :params id asset ID Required permissions: - IsAuthenticated - WorkspaceRequired - [Update Asset](https://docs.huvrdata.app/reference/api_assets_update-3.md): Asset type and asset path are ignored on updates. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [partial_update assets](https://docs.huvrdata.app/reference/api_assets_partial_update-3.md): Asset endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [delete assets](https://docs.huvrdata.app/reference/api_assets_delete-3.md): Asset endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_delete - [Verify API Key](https://docs.huvrdata.app/reference/api_auth_obtain-access-token_create-3.md): NOTE - we're using `client_id` and `client_secret` standard naming for "OAuth Client Credentials Flow" they map internally to service user's `email` and `password` https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow Return a short-lived Token used for subsequent requests Required permissions: - WorkspaceRequired - AllowAny - [POST /api/auth/revoke-all/](https://docs.huvrdata.app/reference/api_auth_revoke-all_create-3.md): Revoke all refresh tokens for the user The verify_token or verify_session_cookie will see this change IF they are called with check_revoked=True check_revoked requires and extra network call to the Identity Platform so we do not call it all the time Required permissions: - AllowAny - [POST /api/auth/session-login/](https://docs.huvrdata.app/reference/api_auth_session-login_create-3.md): Verify JWT from client - sets `auth` cookie on response (used for _firebase_ auth) - sets `sessionid` cookie on response (used for _django_ auth) Required permissions: - WorkspaceRequired - AllowAny - [POST /api/auth/session-logout/](https://docs.huvrdata.app/reference/api_auth_session-logout_create-3.md): Removes session cookie Required permissions: - AllowAny - [list case folders](https://docs.huvrdata.app/reference/api_case-folders_list.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [create case folders](https://docs.huvrdata.app/reference/api_case-folders_create.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_create - [read case folders](https://docs.huvrdata.app/reference/api_case-folders_read.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [update case folders](https://docs.huvrdata.app/reference/api_case-folders_update.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_edit - [partial_update case folders](https://docs.huvrdata.app/reference/api_case-folders_partial_update.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_edit - [delete case folders](https://docs.huvrdata.app/reference/api_case-folders_delete.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_delete - [list case templates](https://docs.huvrdata.app/reference/api_case-templates_list.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [create case templates](https://docs.huvrdata.app/reference/api_case-templates_create.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_create - [read case templates](https://docs.huvrdata.app/reference/api_case-templates_read.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [update case templates](https://docs.huvrdata.app/reference/api_case-templates_update.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_edit - [partial_update case templates](https://docs.huvrdata.app/reference/api_case-templates_partial_update.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_edit - [delete case templates](https://docs.huvrdata.app/reference/api_case-templates_delete.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_delete - [list cases](https://docs.huvrdata.app/reference/api_cases_list.md): CRUD for tt-calc calculation cases. Company-scoped: users only see cases owned by their company. `user` (creator) is set server-side to request.user. Required permissions: - IsAuthenticated - WorkspaceRequired - [create cases](https://docs.huvrdata.app/reference/api_cases_create.md): CRUD for tt-calc calculation cases. Company-scoped: users only see cases owned by their company. `user` (creator) is set server-side to request.user. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_create - [read cases](https://docs.huvrdata.app/reference/api_cases_read.md): CRUD for tt-calc calculation cases. Company-scoped: users only see cases owned by their company. `user` (creator) is set server-side to request.user. Required permissions: - IsAuthenticated - WorkspaceRequired - [partial_update cases](https://docs.huvrdata.app/reference/api_cases_partial_update.md): CRUD for tt-calc calculation cases. Company-scoped: users only see cases owned by their company. `user` (creator) is set server-side to request.user. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_edit - [delete cases](https://docs.huvrdata.app/reference/api_cases_delete.md): CRUD for tt-calc calculation cases. Company-scoped: users only see cases owned by their company. `user` (creator) is set server-side to request.user. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_delete - [Nested under /api/cases/:case_pk/runs/.](https://docs.huvrdata.app/reference/api_cases_runs_list.md): POST kicks off a calc-obs compute job: creates a CaseRun, enqueues a Cloud Task targeting calc-obs, returns 201. Returns 409 + the existing run if there's already an active (queued/running) run on the case so the SPA can safely retry the "Run" button without spawning duplicates. GET endpoints are pollable by the SPA. All write-fields on CaseRun are server-managed via the calc-obs callback at /api/internal/runs/:id/update. Required permissions: - IsAuthenticated - WorkspaceRequired - [Nested under /api/cases/:case_pk/runs/.](https://docs.huvrdata.app/reference/api_cases_runs_create.md): POST kicks off a calc-obs compute job: creates a CaseRun, enqueues a Cloud Task targeting calc-obs, returns 201. Returns 409 + the existing run if there's already an active (queued/running) run on the case so the SPA can safely retry the "Run" button without spawning duplicates. GET endpoints are pollable by the SPA. All write-fields on CaseRun are server-managed via the calc-obs callback at /api/internal/runs/:id/update. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::case_edit - [Nested under /api/cases/:case_pk/runs/.](https://docs.huvrdata.app/reference/api_cases_runs_read.md): POST kicks off a calc-obs compute job: creates a CaseRun, enqueues a Cloud Task targeting calc-obs, returns 201. Returns 409 + the existing run if there's already an active (queued/running) run on the case so the SPA can safely retry the "Run" button without spawning duplicates. GET endpoints are pollable by the SPA. All write-fields on CaseRun are server-managed via the calc-obs callback at /api/internal/runs/:id/update. Required permissions: - IsAuthenticated - WorkspaceRequired - [list checklist result lines](https://docs.huvrdata.app/reference/api_checklist-result-lines_list-3.md): Returns a list of ChecklistResultLines, supports various filters Required permissions: - IsAuthenticated - WorkspaceRequired - [read checklist result lines](https://docs.huvrdata.app/reference/api_checklist-result-lines_read-3.md): Return a single ChecklistResultLine by id `id` pattern: "{checklist_id}::{section_key}::{line_key}" for example: "24::my_section::my_line" Required permissions: - IsAuthenticated - WorkspaceRequired - [list checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_list-3.md): Returns an array of ChecklistTasks. Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [create checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_create-3.md): View Checklist Task * Requires authentication. Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [bulk_create checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_bulk_create-3.md): Bulk create checklist tasks for a list of project ids. Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [read checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_read-3.md): Return the specific Checklist Task :params id Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [update checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_update-3.md): View Checklist Task * Requires authentication. Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [partial_update checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_partial_update-3.md): View Checklist Task * Requires authentication. Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [delete checklist tasks](https://docs.huvrdata.app/reference/api_checklist-tasks_delete-3.md): View Checklist Task * Requires authentication. Required permissions: - ((IsAuthenticated AND HasRolePermissions) AND IsOwnerOrManager) OR APIKeyRequired - [list checklist templates fillable](https://docs.huvrdata.app/reference/api_checklist-templates-fillable_list-3.md): Returns an array of checklist templates ready to be used by the client. Required permissions: - IsAuthenticated - WorkspaceRequired - [read checklist templates fillable](https://docs.huvrdata.app/reference/api_checklist-templates-fillable_read-3.md): Return the specific Checklist Templates :params id template ID Required permissions: - IsAuthenticated - WorkspaceRequired - [list checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_list-3.md): Returns an array of checklist templates. Required permissions: - IsAuthenticated - WorkspaceRequired - [create checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_create-3.md): View Checklist Templates * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [categories checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_categories-3.md): Return a list of all checklist template categories. Used to retrieve the options to filter Checklists by category. The list cannot be altered, and only shows categories that are currently in use by Checklists. Required permissions: - IsAuthenticated - WorkspaceRequired - [import_template checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_import_template-3.md): Import a checklist template, this endpoint can simply do the conversion from excel to JSON. Or it can create/update the template in a single request. The `action` parameter switches between import/convert. If the `id` is passed in it will attempt to update the exisiting template. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [read checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_read-3.md): Return the specific Checklist Templates :params id template ID Required permissions: - IsAuthenticated - WorkspaceRequired - [update checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_update-3.md): View Checklist Templates * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [partial_update checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_partial_update-3.md): View Checklist Templates * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [delete checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_delete-3.md): View Checklist Templates * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [export_template checklist templates](https://docs.huvrdata.app/reference/api_checklist-templates_export_template-3.md): Exports existing checklist template in excel format. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [Get all checklist instances](https://docs.huvrdata.app/reference/api_checklists_list-3.md): Returns an array of checklist instances. The data returned is limited to the current user's permissions. The ChecklistInstanceListSerializer is used to limit the data returned to only the necessary fields. Required permissions: - IsAuthenticated - WorkspaceRequired - [Create checklist](https://docs.huvrdata.app/reference/api_checklists_create-3.md): Create a new checklist instance (aka a Form) from a template. The `template` field is required and should be the ID of the checklist_template to use. The checklist is optionally linked to a project and an asset. Use an unique `client_id` to avoid duplicates. Using a `client_id` that already exists will result in a 400 error. The main edits to the checklist are done using the `edit` object. Each edit is a change to the checklist and is stored in the database. The combined edits are used to generate the final checklist results. The keys should match the key in the Checklist Template. The structure is as follows: { "section_key1": { "line_key1": { "value": "new value", "notes": "Optional note" }, "line_key2": { "value": "new value", "media": [{"id": 1}] }, "section_key2": { "line_key": { "notes": "Optional note" } } } The line dictionary supports the following keys: value, notes, media - where media is an list of media objects. The line dictionary can include other keys, but they may not be shown in reports or used in the system. Do not send keys that have not changed - when creating or editing a checklist, only send the keys that needed. The section and line keys should match the checklist template - the validation does not currently check this, but mismatched keys will be ignored and not displayed. When adding a media object to the media array, only the id is required. The media array that is returned from the API will inclue the full media object. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_create - [Bulk lock/unlock Checklists](https://docs.huvrdata.app/reference/api_checklists_bulk_lock-3.md): Pass the checklist IDs and the action (LOCK/UNLOCK) to lock/unlock multiple checklists at once. The number of modified checklists is returned. Example request: {"ids": [1, 2], "action": "LOCK"} Example response {"modified": 2} **Note:** Primary checklists are part of the project and cannot be locked/unlocked independently. They are always locked/unlocked with the project. Sending a primary checklist ID will be ignored. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get all checklist instances with detailed information](https://docs.huvrdata.app/reference/api_checklists_list_detailed-3.md): Show a detailed list of checklist instances. This endpoint is slow but it avoids needing to make many queries to get detailed information. Use a low number for the limit, such as ?limit=10. Includes all related fields, such as the checklist template, asset, and project. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get Checklist](https://docs.huvrdata.app/reference/api_checklists_read-3.md): Return the specific Checklist Instances Required permissions: - IsAuthenticated - WorkspaceRequired - [Update Checklist (not supported)](https://docs.huvrdata.app/reference/api_checklists_update-3.md): We don't allow updating using `update` as we have a special `edit` method. Required permissions: - IsAuthenticated - WorkspaceRequired - [Update a checklist instance](https://docs.huvrdata.app/reference/api_checklists_partial_update-3.md): Method not supported. Use the /edit/ endpoint instead. Required permissions: - IsAuthenticated - WorkspaceRequired - [Delete a checklist instance](https://docs.huvrdata.app/reference/api_checklists_delete-3.md): Checklists can be deleted by the user who created them or by a user with the `checklist_edit` permission. Locked and primary checklists cannot be deleted. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [Edit a checklist](https://docs.huvrdata.app/reference/api_checklists_edit-3.md): Updates the results of a checklist instance by applying an edit. The changes are tracked per user. Locked checklists will save - but not apply the edit. The main edits to the checklist are done using the `edit` object. Each edit is a revision to the checklist and is stored in the database. The combined edits are used to generate the final checklist results. The keys should match the keys in the Checklist Template. The structure is as follows: { "section_key1": { "line_key1": { "value": "new value", "notes": "Optional note" }, "line_key2": { "value": "new value", "media": [{"id": 1}] }, "section_key2": { "line_key": { "notes": "Optional note" } } } The line dictionary supports the following keys: value, notes, media - where media is an list of media objects. The line dictionary can include other keys, but they may not be shown in reports or used in the system. Do not send keys that have not changed - when creating or editing a checklist, only send the keys that needed. The section and line keys should match the checklist template - the validation does not currently check this, but mismatched keys will be ignored and not displayed. When adding a media object to the media array, only the id is required. The media array that is returned from the API will inclue the full media object. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [Lock checklist](https://docs.huvrdata.app/reference/api_checklists_lock-3.md): Lock a checklist so it can't be modified. Use the /bulk-lock/ endpoint instead. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_lock - [Get list of revisions/edits](https://docs.huvrdata.app/reference/api_checklists_revisions-3.md): List of revisions/edits to the checklist instance. This API is subject to change to support pagination, filtering, and sorting. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [Unlock checklist](https://docs.huvrdata.app/reference/api_checklists_unlock-3.md): Unlock a checklist so it can't be modified. Use the /bulk-lock/ endpoint instead. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_unlock - [list cmls](https://docs.huvrdata.app/reference/api_cmls_list-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [create cmls](https://docs.huvrdata.app/reference/api_cmls_create-3.md): create CML Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_create - [read cmls](https://docs.huvrdata.app/reference/api_cmls_read-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [update cmls](https://docs.huvrdata.app/reference/api_cmls_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [partial_update cmls](https://docs.huvrdata.app/reference/api_cmls_partial_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_edit - [delete cmls](https://docs.huvrdata.app/reference/api_cmls_delete-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::asset_delete - [Get all Companies](https://docs.huvrdata.app/reference/api_companies_list-3.md): Returns an array companies. Required permissions: - IsAuthenticated - WorkspaceRequired - [Create company](https://docs.huvrdata.app/reference/api_companies_create-3.md): Create a new company. Company name must be unique. A company is can be thought of as an organization within a large company or a standalone company. Companies can own assets, have crews, and have users. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_create - [Get Company](https://docs.huvrdata.app/reference/api_companies_read-3.md): Return the specific company or organization by ID Required permissions: - IsAuthenticated - WorkspaceRequired - [Update company](https://docs.huvrdata.app/reference/api_companies_update-3.md): Update the company data. Use the membership endpoint to update users in the company. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [partial_update companies](https://docs.huvrdata.app/reference/api_companies_partial_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [delete companies](https://docs.huvrdata.app/reference/api_companies_delete-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_delete - [Update company membership](https://docs.huvrdata.app/reference/api_companies_membership-3.md): Pass in a list of user IDs to add or remove from the company Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [Get or update a company's settings.](https://docs.huvrdata.app/reference/api_companies_settings_read.md): GET returns the settings (defaults if none exist yet, with no row created). PATCH creates the row on first write; requires company edit permission. Required permissions: - IsAuthenticated - WorkspaceRequired - [Get or update a company's settings.](https://docs.huvrdata.app/reference/api_companies_settings_partial_update.md): GET returns the settings (defaults if none exist yet, with no row created). PATCH creates the row on first write; requires company edit permission. Required permissions: - IsAuthenticated - WorkspaceRequired - [list company media](https://docs.huvrdata.app/reference/api_company-media_list.md): Per-company media (logos, etc). Hosted on GCS via signed-url upload. Required permissions: - IsAuthenticated - WorkspaceRequired - [create company media](https://docs.huvrdata.app/reference/api_company-media_create.md): Per-company media (logos, etc). Hosted on GCS via signed-url upload. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [read company media](https://docs.huvrdata.app/reference/api_company-media_read.md): Per-company media (logos, etc). Hosted on GCS via signed-url upload. Required permissions: - IsAuthenticated - WorkspaceRequired - [update company media](https://docs.huvrdata.app/reference/api_company-media_update.md): Per-company media (logos, etc). Hosted on GCS via signed-url upload. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [partial_update company media](https://docs.huvrdata.app/reference/api_company-media_partial_update.md): Per-company media (logos, etc). Hosted on GCS via signed-url upload. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [delete company media](https://docs.huvrdata.app/reference/api_company-media_delete.md): Per-company media (logos, etc). Hosted on GCS via signed-url upload. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::company_edit - [list crews](https://docs.huvrdata.app/reference/api_crews_list-3.md): Returns an array of Crew objectss Required permissions: - IsAuthenticated - WorkspaceRequired - [create crews](https://docs.huvrdata.app/reference/api_crews_create-3.md): accept a flat object for create, return nested detail object Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::crew_create - [read crews](https://docs.huvrdata.app/reference/api_crews_read-3.md): Return the specific Crew :params id crew ID Required permissions: - IsAuthenticated - WorkspaceRequired - [update crews](https://docs.huvrdata.app/reference/api_crews_update-3.md): Crew update. Company is ignored on updates Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::crew_edit - [partial_update crews](https://docs.huvrdata.app/reference/api_crews_partial_update-3.md): Crew endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::crew_edit - [delete crews](https://docs.huvrdata.app/reference/api_crews_delete-3.md): Crew endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::crew_delete - [membership crews](https://docs.huvrdata.app/reference/api_crews_membership-3.md): Crew endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::crew_manage - [list defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_list-3.md): Returns an array of defect profiles. Required permissions: - IsAuthenticated - WorkspaceRequired - [create defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_create-3.md): View DefectProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::defect_create - [import_template defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_import_template-3.md): Import a defect profile template, currently imports yaml templates. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [read defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_read-3.md): Return the specific Defect Profile :params id Required permissions: - IsAuthenticated - WorkspaceRequired - [update defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_update-3.md): View DefectProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::defect_edit - [partial_update defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_partial_update-3.md): View DefectProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::defect_edit - [delete defect profiles](https://docs.huvrdata.app/reference/api_defect-profiles_delete-3.md): View DefectProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::defect_delete - [Get all defects](https://docs.huvrdata.app/reference/api_defects_list-3.md): Returns an array of defects. The data returned is limited to the current user's permissions. The DefectListSerializer is used to limit the data returned to only the necessary fields. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [create defects](https://docs.huvrdata.app/reference/api_defects_create-3.md): Defect / Finding API endpoint Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Bulk edit defects](https://docs.huvrdata.app/reference/api_defects_edit-3.md): Bulk edit defects. Pass a list of defects and the fields to update. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Get summary of defect fields](https://docs.huvrdata.app/reference/api_defects_filters-3.md): This is an internal endpoint and subject to change at anytime. It provides the distinct list items in defects. No query parameters are supported on this endpoint. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Link/Merge Defects](https://docs.huvrdata.app/reference/api_defects_link-3.md): For defects (Findings) that are about the issue. They can be merged/linked. This allows for tracking of the issue across multiple inspections. Newer inspections may see a crack getting larger, or a repair not holding up. This allows the preservation of the original defect and the new defect includes the latest data and imagery etc. Pass a list of defects, will link them (via `Defect.newer_defect` field) and return list of updated defects, in order. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Get Defect](https://docs.huvrdata.app/reference/api_defects_read-3.md): Return the specific Defect Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Update Defect](https://docs.huvrdata.app/reference/api_defects_update-3.md): Update the defect object. After the initial review of a defect, certain fields are locked. These fields are: - asset - component - location_zone - location_code - cml - severity - type - sub_type Only users with `defect_edit_protected` permission can edit these fields after the initial review. Subsequent inspections can create a new defect and link them to the original defects. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [partial_update defects](https://docs.huvrdata.app/reference/api_defects_partial_update-3.md): Defect / Finding API endpoint Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [delete defects](https://docs.huvrdata.app/reference/api_defects_delete-3.md): Defect / Finding API endpoint Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [screenshot defects](https://docs.huvrdata.app/reference/api_defects_screenshot.md): Attaches a screenshot to a defect/finding. The screenshot is a media object linked to the defect. If a screenshot is already attached it is replaced. The system will call this API automatically when a findings is updated to attach a screenshot from the DDI diagram. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [list heat data](https://docs.huvrdata.app/reference/api_heat-data_list-3.md): Returns an array HEAT data Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::process_data_view - [read heat data](https://docs.huvrdata.app/reference/api_heat-data_read-3.md): Return the specific HEAT data :params id HeatData ID Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [list inspection media overlays](https://docs.huvrdata.app/reference/api_inspection-media-overlays_list-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [create inspection media overlays](https://docs.huvrdata.app/reference/api_inspection-media-overlays_create-3.md): create inspection media overlay, the media object has to already exist. The defect can be passed in. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [read inspection media overlays](https://docs.huvrdata.app/reference/api_inspection-media-overlays_read-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [update inspection media overlays](https://docs.huvrdata.app/reference/api_inspection-media-overlays_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [partial_update inspection media overlays](https://docs.huvrdata.app/reference/api_inspection-media-overlays_partial_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [delete inspection media overlays](https://docs.huvrdata.app/reference/api_inspection-media-overlays_delete-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [list inspection media](https://docs.huvrdata.app/reference/api_inspection-media_list-3.md): List inspection media. Regular users must apply at least one filter. Users with project_manage_all permission can list all records. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Create inspection media](https://docs.huvrdata.app/reference/api_inspection-media_create-3.md): For larger files, the preferred method is send the data directly to cloud storage. The response includes a signed url that will allow the client to upload directly to the cloud storage provider. The signed url is only valid for a short period of time. Refreshing the inspection media object will return a new signed url. Media objects are contained by a project or a checklist instance. The name of the media object is unique within the project or checklist instance. If a duplicate name is found, the system will append a number to the end of the name to make it unique. After a few attempts to rename the system will return an error. `client_id` is a unique identifier for the media object in the entire workspace. If a media object with the same `client_id` is found, the system will return an error. `client_id` needs to be unique or null. After file upload, the system will process the media to: - extracting metadata (GPS, EXIF, etc.) - generating thumbnails and preview images - convert video to a streamable format The state is set to `UPLOADED` after the file is uploaded and processed. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Bulk delete Inspection Media](https://docs.huvrdata.app/reference/api_inspection-media_delete-3.md): Delete multiple Inspection Media objects at once. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Bulk edit Inspection Media](https://docs.huvrdata.app/reference/api_inspection-media_edit-3.md): Allows the same value to be applied to multiple Inspection Media objects at once. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Process Inspection Media](https://docs.huvrdata.app/reference/api_inspection-media_process-3.md): Perform processing of InspectionMedia objects. For now only supports decompressing and extracting files from a zip file. The contents of the zip file will be added to the containing project or checklist instance. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Get Inspection Media](https://docs.huvrdata.app/reference/api_inspection-media_read-3.md): Return the specific Inspection Media. The media object includes the metadata not the file contents. The file contents are linked to. If the file has not been uploaded, the `upload` object includes a signed_url that can be used to upload the file directly to the cloud storage provider. The `upload` object is only valid for a short period of time and can be refreshed by calling `GET` again. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Update inspection media](https://docs.huvrdata.app/reference/api_inspection-media_update-3.md): Update the inspection media object. This endpoint is used to update the metadata of the media object. Once a file is uploaded, the file cannot be updated. If the file needs to be updated, a new media object should be created. The PATCH operation is preferred for updating metadata, only send the fields that have changed. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Patch Inspection Media](https://docs.huvrdata.app/reference/api_inspection-media_partial_update-3.md): Update the inspection media - this does not change the file contents. Once a file is uploaded, the file cannot be updated. If the file needs to be updated, a new media object should be created. Preview and thumbnail images are generated by the system, but can be provided for unusual file types. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Delete a single Inspection Media](https://docs.huvrdata.app/reference/api_inspection-media_delete_alt-3.md): Delete removes the database object and the file in the Cloud Storage. Media objects can not be deleted for: - `PUBLISHED` projects - `locked` checklists - or media attached to Defects / Findings Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Extract text](https://docs.huvrdata.app/reference/api_inspection-media_extract_text-3.md): Extract text from supported media types Uses Vision to extract text from the media object. Supported media types are images and PDFs. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Inspection Media Overlays](https://docs.huvrdata.app/reference/api_inspection-media_overlays_create-3.md): Add or edit a overlay on a media object. Overlays are used to attach Defects (Findings) to media objects. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [Inspection Media Overlays](https://docs.huvrdata.app/reference/api_inspection-media_overlays_partial_update-3.md): Add or edit a overlay on a media object. Overlays are used to attach Defects (Findings) to media objects. Required permissions: - (IsAuthenticated AND HasRolePermissions) OR APIKeyRequired - [PATCH /api/internal/runs/{run_id}/update/](https://docs.huvrdata.app/reference/api_internal_runs_update_partial_update.md): PATCH /api/internal/runs/:run_id/update. Required permissions: - IsAuthenticated - WorkspaceRequired - [Returns an array library media.](https://docs.huvrdata.app/reference/api_libraries_list-3.md): GET /api/libraries/ Required permissions: - IsAuthenticated - WorkspaceRequired - [read libraries](https://docs.huvrdata.app/reference/api_libraries_read-3.md): View library media * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [Returns an array library media.](https://docs.huvrdata.app/reference/api_library-media_list-3.md): GET /api/library-media/ Required permissions: - IsAuthenticated - [create library media](https://docs.huvrdata.app/reference/api_library-media_create-3.md): create library media, the actual media object is hosted on GCS. For larger files, the preferred method is send the data directly storage. Generate a signed url that will allow the client to upload directly to GCS. Required permissions: - IsAuthenticated - [Bulk delete Library Media](https://docs.huvrdata.app/reference/api_library-media_delete-3.md): Delete multiple Library Media objects at once. Required permissions: - IsAuthenticated - [summary library media](https://docs.huvrdata.app/reference/api_library-media_summary-3.md): View library media * Requires authentication. Required permissions: - IsAuthenticated - [read library media](https://docs.huvrdata.app/reference/api_library-media_read-3.md): Return the specific library media :params id media ID Required permissions: - IsAuthenticated - [update library media](https://docs.huvrdata.app/reference/api_library-media_update-3.md): View library media * Requires authentication. Required permissions: - IsAuthenticated - [partial_update library media](https://docs.huvrdata.app/reference/api_library-media_partial_update-3.md): View library media * Requires authentication. Required permissions: - IsAuthenticated - [delete library media](https://docs.huvrdata.app/reference/api_library-media_delete_alt-3.md): View library media * Requires authentication. Required permissions: - IsAuthenticated - [list location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_list-3.md): Returns an array of LocationLayerProfile. Required permissions: - IsAuthenticated - WorkspaceRequired - [create location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_create-3.md): View LocationLayerProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [import_template location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_import_template-3.md): Import a Location Layer template, this endpoint can simply do the conversion to yaml The `action` parameter switches between import/convert. If the `id` is passed in it will attempt to update the exisiting template. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [read location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_read-3.md): Return the specific LocationLayerProfile :params id Required permissions: - IsAuthenticated - WorkspaceRequired - [update location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_update-3.md): View LocationLayerProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [partial_update location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_partial_update-3.md): View LocationLayerProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [delete location layer profiles](https://docs.huvrdata.app/reference/api_location-layer-profiles_delete-3.md): View LocationLayerProfile * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [list measurements](https://docs.huvrdata.app/reference/api_measurements_list-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [create measurements](https://docs.huvrdata.app/reference/api_measurements_create-3.md): create Measurement Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [delete measurements](https://docs.huvrdata.app/reference/api_measurements_delete-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [Bulk edit measurements](https://docs.huvrdata.app/reference/api_measurements_edit-3.md): Allows the same value to be applied to multiple measurements at once. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [import_measurements measurements](https://docs.huvrdata.app/reference/api_measurements_import_measurements-3.md): import measurements if asset_path is passed in. We will walk the downtree assets looking for matching CML's Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [read measurements](https://docs.huvrdata.app/reference/api_measurements_read-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - [update measurements](https://docs.huvrdata.app/reference/api_measurements_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [partial_update measurements](https://docs.huvrdata.app/reference/api_measurements_partial_update-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [delete measurements](https://docs.huvrdata.app/reference/api_measurements_delete_alt-3.md): Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::checklist_edit - [list personas](https://docs.huvrdata.app/reference/api_personas_list.md): Read-only viewset for the requesting user's personas. Required permissions: - IsAuthenticated - WorkspaceRequired - [create personas](https://docs.huvrdata.app/reference/api_personas_create.md): Read-only viewset for the requesting user's personas. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [read personas](https://docs.huvrdata.app/reference/api_personas_read.md): Read-only viewset for the requesting user's personas. Required permissions: - IsAuthenticated - WorkspaceRequired - [activate personas](https://docs.huvrdata.app/reference/api_personas_activate.md): Activate this persona, updating the user's roles and company memberships. Required permissions: - IsAuthenticated - WorkspaceRequired - [list project types](https://docs.huvrdata.app/reference/api_project-types_list-3.md): Returns an array project types. Required permissions: - IsAuthenticated - WorkspaceRequired - [create project types](https://docs.huvrdata.app/reference/api_project-types_create-3.md): accept a flat object for create, return nested detail object Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [read project types](https://docs.huvrdata.app/reference/api_project-types_read-3.md): Return the specific project type :params id project_type ID Required permissions: - IsAuthenticated - WorkspaceRequired - [update project types](https://docs.huvrdata.app/reference/api_project-types_update-3.md): Project Type endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [partial_update project types](https://docs.huvrdata.app/reference/api_project-types_partial_update-3.md): Project Type endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [delete project types](https://docs.huvrdata.app/reference/api_project-types_delete-3.md): Project Type endpoint * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [list projects](https://docs.huvrdata.app/reference/api_projects_list-3.md): Returns an array projects. Required permissions: - IsAuthenticated - WorkspaceRequired - [create projects](https://docs.huvrdata.app/reference/api_projects_create-3.md): accept a flat object for create, return nested detail object Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_create - [delete projects](https://docs.huvrdata.app/reference/api_projects_delete-3.md): View projects * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_delete - [edit projects](https://docs.huvrdata.app/reference/api_projects_edit-3.md): View projects * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_edit - [bulk_share projects](https://docs.huvrdata.app/reference/api_projects_bulk_share-3.md): allow for bulk assignment/unassignment of multiple users to multiple projects Required permissions: - IsAuthenticated - WorkspaceRequired - [counts_by_status projects](https://docs.huvrdata.app/reference/api_projects_counts_by_status-3.md): View projects * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [list_detailed projects](https://docs.huvrdata.app/reference/api_projects_list_detailed-3.md): Shows a detailed list or projects (slow). Required permissions: - IsAuthenticated - WorkspaceRequired - [status_bulk_update projects](https://docs.huvrdata.app/reference/api_projects_status_bulk_update-3.md): Updates multiple project's status at once. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_status_edit - [read projects](https://docs.huvrdata.app/reference/api_projects_read-3.md): Return the specific project :params id Project ID Required permissions: - IsAuthenticated - WorkspaceRequired - [update projects](https://docs.huvrdata.app/reference/api_projects_update-3.md): Project update. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_edit - [partial_update projects](https://docs.huvrdata.app/reference/api_projects_partial_update-3.md): View projects * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_edit - [delete projects](https://docs.huvrdata.app/reference/api_projects_delete_alt-3.md): View projects * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_delete - [GET /api/projects/{id}/asset-condition/](https://docs.huvrdata.app/reference/api_projects_asset-condition_read-3.md): Set the project asset condition, allow retrival of the project asset condition history Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_edit - [POST /api/projects/{id}/asset-condition/](https://docs.huvrdata.app/reference/api_projects_asset-condition_create-3.md): Set the project asset condition, allow retrival of the project asset condition history Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_edit - [PUT /api/projects/{id}/asset-condition/](https://docs.huvrdata.app/reference/api_projects_asset-condition_update-3.md): Set the project asset condition, allow retrival of the project asset condition history Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_edit - [export projects](https://docs.huvrdata.app/reference/api_projects_export-3.md): Exports existing project in excel format. This is a simple helper API endpoint that is run by developers only as this process will probably (depending on data) outgrow an inline request. Required permissions: - IsAuthenticated - WorkspaceRequired - [location_summary projects](https://docs.huvrdata.app/reference/api_projects_location_summary-3.md): Location summary of the findings/defects for a given project Required permissions: - IsAuthenticated - WorkspaceRequired - [GET /api/projects/{id}/status/](https://docs.huvrdata.app/reference/api_projects_status_read-3.md): Set the project status, allow retrieval of the project status history Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_status_edit - [POST /api/projects/{id}/status/](https://docs.huvrdata.app/reference/api_projects_status_create-3.md): Set the project status, allow retrieval of the project status history Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_status_edit - [PUT /api/projects/{id}/status/](https://docs.huvrdata.app/reference/api_projects_status_update-3.md): Set the project status, allow retrieval of the project status history Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::project_status_edit - [watch projects](https://docs.huvrdata.app/reference/api_projects_watch-3.md): Set the project watchers, allow retrival of the project watchers Required permissions: - IsAuthenticated - WorkspaceRequired - [reports projects](https://docs.huvrdata.app/reference/api_projects_reports.md): View projects * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [GET /api/schedule/events/](https://docs.huvrdata.app/reference/api_schedule_events_list-3.md): Returns an array of schedule events. Required permissions: - IsAuthenticated - WorkspaceRequired - [POST /api/schedule/events/](https://docs.huvrdata.app/reference/api_schedule_events_create-3.md): * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [GET /api/schedule/events/{id}/](https://docs.huvrdata.app/reference/api_schedule_events_read-3.md): Return the specific schedule event :params id schedule event ID Required permissions: - IsAuthenticated - WorkspaceRequired - [PUT /api/schedule/events/{id}/](https://docs.huvrdata.app/reference/api_schedule_events_update-3.md): * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_event_manage - [PATCH /api/schedule/events/{id}/](https://docs.huvrdata.app/reference/api_schedule_events_partial_update-3.md): * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_event_manage - [DELETE /api/schedule/events/{id}/](https://docs.huvrdata.app/reference/api_schedule_events_delete-3.md): * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_event_manage - [GET /api/schedule/plan-work/](https://docs.huvrdata.app/reference/api_schedule_plan-work_list-3.md): Returns an array of schedule plan work items Required permissions: - IsAuthenticated - WorkspaceRequired - [POST /api/schedule/plan-work/](https://docs.huvrdata.app/reference/api_schedule_plan-work_create-3.md): View schedule work plan * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_create - [GET /api/schedule/plan-work/{id}/](https://docs.huvrdata.app/reference/api_schedule_plan-work_read-3.md): Return the specific schedule plan work :params id schedule plan work ID Required permissions: - IsAuthenticated - WorkspaceRequired - [PUT /api/schedule/plan-work/{id}/](https://docs.huvrdata.app/reference/api_schedule_plan-work_update-3.md): Schedule Plan update Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_edit - [PATCH /api/schedule/plan-work/{id}/](https://docs.huvrdata.app/reference/api_schedule_plan-work_partial_update-3.md): View schedule work plan * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_edit - [DELETE /api/schedule/plan-work/{id}/](https://docs.huvrdata.app/reference/api_schedule_plan-work_delete-3.md): View schedule work plan * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_delete - [GET /api/schedule/plans/](https://docs.huvrdata.app/reference/api_schedule_plans_list-3.md): Returns an array of schedule plans Required permissions: - IsAuthenticated - WorkspaceRequired - [POST /api/schedule/plans/](https://docs.huvrdata.app/reference/api_schedule_plans_create-3.md): View schedule plan * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_create - [GET /api/schedule/plans/{id}/](https://docs.huvrdata.app/reference/api_schedule_plans_read-3.md): Return the specific schedule plan :params id schedule plan ID Required permissions: - IsAuthenticated - WorkspaceRequired - [PUT /api/schedule/plans/{id}/](https://docs.huvrdata.app/reference/api_schedule_plans_update-3.md): Schedule Plan update Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_edit - [PATCH /api/schedule/plans/{id}/](https://docs.huvrdata.app/reference/api_schedule_plans_partial_update-3.md): View schedule plan * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_edit - [DELETE /api/schedule/plans/{id}/](https://docs.huvrdata.app/reference/api_schedule_plans_delete-3.md): View schedule plan * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_delete - [POST /api/schedule/plans/{id}/generate-events/](https://docs.huvrdata.app/reference/api_schedule_plans_generate-events_create-3.md): Generate Events for a SchedulePlan Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_create - [PUT /api/schedule/plans/{id}/generate-events/](https://docs.huvrdata.app/reference/api_schedule_plans_generate-events_update-3.md): Generate Events for a SchedulePlan Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_plan_create - [GET /api/schedule/tasks/](https://docs.huvrdata.app/reference/api_schedule_tasks_list-3.md): Returns an array of schedule task. Required permissions: - IsAuthenticated - WorkspaceRequired - [GET /api/schedule/tasks/{id}/](https://docs.huvrdata.app/reference/api_schedule_tasks_read-3.md): Return the specific schedule task :params id schedule task ID Required permissions: - IsAuthenticated - WorkspaceRequired - [PUT /api/schedule/tasks/{id}/](https://docs.huvrdata.app/reference/api_schedule_tasks_update-3.md): * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_task_edit - [POST /api/schedule/tasks/{id}/delete/](https://docs.huvrdata.app/reference/api_schedule_tasks_delete-3.md): * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_task_edit - [POST /api/schedule/tasks/{id}/reconcile/](https://docs.huvrdata.app/reference/api_schedule_tasks_reconcile-3.md): Look for work that matches the schedule task. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::schedule_task_edit - [list tool histories](https://docs.huvrdata.app/reference/api_tool-histories_list-3.md): ToolHistory endpoint (read-only) Required permissions: - IsAuthenticated - WorkspaceRequired - [read tool histories](https://docs.huvrdata.app/reference/api_tool-histories_read-3.md): ToolHistory endpoint (read-only) Required permissions: - IsAuthenticated - WorkspaceRequired - [list tool types](https://docs.huvrdata.app/reference/api_tool-types_list-3.md): ToolType endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [create tool types](https://docs.huvrdata.app/reference/api_tool-types_create-3.md): ToolType endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [read tool types](https://docs.huvrdata.app/reference/api_tool-types_read-3.md): ToolType endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [update tool types](https://docs.huvrdata.app/reference/api_tool-types_update-3.md): ToolType endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [partial_update tool types](https://docs.huvrdata.app/reference/api_tool-types_partial_update-3.md): ToolType endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [delete tool types](https://docs.huvrdata.app/reference/api_tool-types_delete-3.md): ToolType endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::configuration_management_build - [list tools](https://docs.huvrdata.app/reference/api_tools_list-3.md): Tool endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - [create tools](https://docs.huvrdata.app/reference/api_tools_create-3.md): Tool endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::tool_create - [Bulk delete Tools](https://docs.huvrdata.app/reference/api_tools_delete-3.md): Delete multiple Tool objects at once. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::UNDEFINED - [Bulk edit Tools](https://docs.huvrdata.app/reference/api_tools_edit-3.md): Allows the same value to be applied to multiple Tool objects at once. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::tool_edit - [read tools](https://docs.huvrdata.app/reference/api_tools_read-3.md): Tool endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - [update tools](https://docs.huvrdata.app/reference/api_tools_update-3.md): Tool endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::tool_edit - [partial_update tools](https://docs.huvrdata.app/reference/api_tools_partial_update-3.md): Tool endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::tool_edit - [delete tools](https://docs.huvrdata.app/reference/api_tools_delete_alt-3.md): Tool endpoint Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::tool_delete - [list users](https://docs.huvrdata.app/reference/api_users_list-3.md): Returns an array users. Required permissions: - IsAuthenticated - WorkspaceRequired - [create users](https://docs.huvrdata.app/reference/api_users_create-3.md): User create This function is used when creating a new user using the Users tab on the frontend Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::user_create - [import_users users](https://docs.huvrdata.app/reference/api_users_import_users-3.md): Pass a list of users addresses, sets the same roles/company for all Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::user_create - [GET /api/users/me/](https://docs.huvrdata.app/reference/api_users_me_read-3.md): View users * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [POST /api/users/me/](https://docs.huvrdata.app/reference/api_users_me_create-3.md): View users * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [GET /api/users/me/preferences/](https://docs.huvrdata.app/reference/api_users_me_preferences_read-3.md): View users * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [PATCH /api/users/me/preferences/](https://docs.huvrdata.app/reference/api_users_me_preferences_partial_update-3.md): View users * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - [read users](https://docs.huvrdata.app/reference/api_users_read-3.md): Return the specific user :params id User ID Required permissions: - IsAuthenticated - WorkspaceRequired - [update users](https://docs.huvrdata.app/reference/api_users_update-3.md): User update Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::user_edit - [partial_update users](https://docs.huvrdata.app/reference/api_users_partial_update-3.md): View users * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::user_edit - [delete users](https://docs.huvrdata.app/reference/api_users_delete-3.md): View users * Requires authentication. Required permissions: - IsAuthenticated - WorkspaceRequired - HasRolePermissions::user_delete