Skip to main content
POST
Requires version 2.0.0 or later of the Archetype platform.

Overview

This endpoint copies a blueprint into a project. The copy is a new blueprint with its own blp_ id, registered in the project under blueprint_key. It has the same document as the original, apart from name and description when you give them, and a source of kind copy that names the original. Any blueprint you can see can be copied: a platform one, one of your organization’s, or one in a project, including the target project itself. Copying is how you reuse a blueprint in a project, since a blueprint’s project is fixed when it is created. The original is named as in Get Blueprint: a blp_ id copies that exact version, and a key copies its active version. A key registered in a project resolves only when source_project_id names that project. Either way, the copy’s source records the exact version copied.

Request

string
required
The blueprint to copy: a blp_ id or a key (e.g. osm).
string
required
The prj_ id of the project to copy the blueprint into, which you must be able to modify.
string
required
The copy’s key. Must not be in use in the project, by the organization’s blueprints outside projects, or by a platform blueprint.
string
The copy’s display name. Defaults to the original’s.
string
The copy’s description. Defaults to the original’s.
string
The prj_ id of the project to resolve the blueprint’s key in, as well as outside projects. Needed to copy a blueprint registered in a project by its key, even into that same project; ignored for a blp_ id.

Response

Returns 201 Created with the copy, in the same shape as Get Blueprint.
string
required
TypeID-encoded identifier of the copy (blp_ prefix).
string
required
The key the copy was registered under.
string
required
Display name of the copy.
string
required
Description of the copy. Empty when it has none.
object
required
The blueprint document, copied from the original and carrying the copy’s blueprint_id.
boolean
required
Always false: a copy belongs to your organization.
boolean
required
true for the current version of a key.
string
required
The project the copy lives in; this is the project_id you specified when calling this endpoint.
object
required
The origin of the copy: kind is copy, blueprint_id is the exact version copied, and blueprint_key is that blueprint’s key when it was copied.
string
required
Creation timestamp (date-time).

Important Notes

  • Copying is open to every role that can modify the target project, not only admins. Registering a blueprint into a project with Create Blueprint requires the admin role.
  • In the free trial, only the platform blueprints the trial includes can be copied. Any other returns 403 with code capability_locked.
  • A 403 without that code means you have read-only access to the target project.
  • A 404 means the blueprint, the project, or the source project does not exist or is not visible to you.
  • A 409 means blueprint_key is already in use in the project, by your organization’s blueprints outside projects, or by a platform blueprint.