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

A user-defined identifier of this project.

colorstringOptional<=128 characters

Project color as a CSS-compatible value. Client applications can use this to color-code the projects or project-related data.

descriptionstringOptional<=1024 characters

A user-defined description of the project.

end_datestringOptionalformat: "date"
Project end date. If specified, must be later than or equal to the start date.
namestringOptional>=1 character<=255 characters
The project name.
parent_idstringOptionalformat: "uuid"
Unused. Reserved for future use.
partner_metadatamap from strings to anyOptional

Metadata for partner needs.

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
UTC date and time when this project was created.
updated_atdatetime
UTC date and time when this project was last updated.
entity_idstringformat: "uuid"
ID of the entity that owns this project.
namestring>=1 character<=255 characters
The project name.
codestring or nullformat: "^[a-zA-Z0-9]+$">=1 character<=20 characters

A user-defined identifier of this project.

colorstring or null<=128 characters

Project color as a CSS-compatible value. Client applications can use this to color-code the projects or project-related data.

created_by_entity_user_idstring or nullformat: "uuid"

ID of the entity user who created this project, or null if it was created using a partner access token.

descriptionstring or null<=1024 characters

A user-defined description of the project.

end_datestring or nullformat: "date"
Project end date.
parent_idstring or nullformat: "uuid"
Unused. Reserved for future use.
partner_metadatamap from strings to any or null

Metadata for partner needs.

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