Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Project

ProjectTypes.update

Modifies ProjectType or ProjectTypes with given id(s)

patch/entities/ProjectTypes/{id}

Path parameters

idstring uuid required

ID of ProjectType to update

Query parameters

validation-levelinteger

Specify validation level of ProjectType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

form_editobject

JSON definition of the form layout used by the UI when creating or editing projects of this type.

icon0 | 1

Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account).

Integer enum value: 0 - GeneralIcon, 1 - Account

is_readonlyboolean

True when the project type is system-managed and cannot be edited or deleted by users.

namestring

Name of the entity and its default text representation.

settingsstring binary

Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "name": "string",
  "settings": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ProjectType

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "name": "string",
    "settings": "blob",
    "revision": 1
  }
}