CEceledon-solutions
Content

Add objects

Changed on

Adds objects to the running project, opening it if needed. The write goes through the same path an interactive client uses, so parentage, layout, and the broadcast to anyone else in the project all happen as normal.

The objects are in memory once this returns; they are in git only after a commit. A response reporting fewer objects than were sent does not happen — the request either applies in full or fails.

Every object is checked against the schema for its type before anything is written, so one bad object fails the whole request and the project is left untouched. Any type the model defines can be written here; the 400 names what was wrong with each object it refused.

post/api/v2/projects/{projectId}/objects

Request

  • Base URL
    https://davinci-app.com
  • Auth
    HTTP bearer

Query parameters

branchstring

Request body

objectsobject required

Objects to add, keyed by the id each should take. A key is an id, so it must be a UUID — mint one per object. Ids must be unique within the project; reusing one overwrites, which is why guessable keys are not accepted.

Each body is validated against the schema for its type. Fields differ by type, anything the type does not define is refused rather than dropped, and every field is optional except type — the model supplies the rest.

tags is refused here rather than accepted and discarded: creation does not carry them. Assign them once the object exists.

parentIdstring uuid nullable

Parent for objects that do not name one themselves. An id, so a UUID.

Response

Objects added.

addedCountinteger required
objectIdsstring[] required

Changes

  • v267c8b8616dbbRevision changes
    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

  • v248948af37797Revision changes
    • info

      endpoint added