partial_update projects

patch

https://<subdomain>.huvrdata.app/api/projects/{id}/

View projects

Requires authentication.

Required permissions:

IsAuthenticated
WorkspaceRequired
HasRolePermissions::project_edit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

name

string

description

string | null

Project text. Visible to the client.

work_done_on

date-time | null

The date of the latest inspection or image upload. For historical, projects allow this field to be set. Otherwise, it is automatically set when data is uploaded.

historical_project

boolean

If historical_project then work_done_on is not modified automatically, instead its editable.

start

date | null

Work start date (Optional)

end

date | null

Work end date (Optional)

status

string

enum

Project status

Allowed:

type

integer

required

parent

integer | null

Parent project. Allows for nested projects to manage larger campaigns.

priority

string

length ≤ 50

Project priority, human readable. e.g. A1, HIGH.

asset

integer

required

Asset work is being performed on

crews

array of integers

Work crews assigned to complete this project.

crews

management_company

integer | null

Company to manage the project.

created_by

integer

created_on

date-time

scope

object

checklist_id

integer

labels

object

List of Key/Value pairs where keys are 'name' and 'value'

labels_update

object

update_children

boolean

app_key

string | null

Application identifier this entity is related to/sourced from.

external_id

string | null

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

application/yaml

200