CommonProjects

Update a project

Update a project.

Path parameters

project_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
codestringOptionalformat: "^[a-zA-Z0-9]+$">=1 character<=20 characters
Project code
colorstringOptional<=128 characters
Project color
descriptionstringOptional<=1024 characters
Description of project
end_datestringOptionalformat: "date"
Project end date
namestringOptional>=1 character<=255 characters
The project name.
parent_idstringOptionalformat: "uuid"
Parent project ID
partner_metadatamap from strings to anyOptional
Project metadata
start_datestringOptionalformat: "date"
Project start date
tag_idslist of stringsOptional

A list of IDs of user-defined tags (labels) assigned to this project.

Response

Successful Response
idstringformat: "uuid"
A unique ID assigned to this project.
created_atdatetime
Project created at
updated_atdatetime
Last time project was updated at
entity_idstringformat: "uuid"
The ID of the entity to which the project was issued.
namestring>=1 character<=255 characters
The project name.
codestring or nullformat: "^[a-zA-Z0-9]+$">=1 character<=20 characters
Project code
colorstring or null<=128 characters
Project color
created_by_entity_user_idstring or nullformat: "uuid"
Project created by entity user
descriptionstring or null<=1024 characters
Description of project
end_datestring or nullformat: "date"
Project end date
parent_idstring or nullformat: "uuid"
Parent project ID
partner_metadatamap from strings to any or null
Project metadata
start_datestring or nullformat: "date"
Project start date
tagslist of objects or null

A list of user-defined tags (labels) assigned to this project.

Errors