COcoevera
Project

Projects.batch_create_or_update

Creates or updates Project records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/Projects/batch-modify

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

account_idstring uuid

Id of the related account.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this project.

descriptionstring

Free-form description of the project.

end_datestring date

Planned end date of the project. Must be on or after start_date when both are set.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the project owner.

project_type_idstring uuid

Id of the project type that classifies this project.

share_mode0 | 1 | 2 | 3

Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

start_datestring date

Date when the project starts.

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

Example request

[
  {
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "end_date": "2019-01-01",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "start_date": "2019-01-01",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "revenue_goal": {
      "currency_id": "01234567-abcd-dcba-ffff-000000000000"
    }
  }
]

Response

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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