COcoevera
Project

ProjectTypes.create

Creates a ProjectType record.

post/entities/ProjectTypes

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

form_editobject

JSON definition of the form layout used by the UI when creating or editing projects of this type. This payload conforms to the Form JSON Schema (see the linked schema).

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 required

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

namestring required

Name of the entity and its default text representation.

settingsstring binary required

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. This payload conforms to the EntityTypeSettings JSON Schema (see the linked schema).

is_publishedboolean

True when the entity configuration is published; false while it exists only as an unpublished draft.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "name": "string",
  "settings": "blob",
  "revision": 1
}

Response

The created ProjectType record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.