REST API - Create Project Request
9 min
/api/v1/projects description creates a project from a template or without a template url structures \[blueprint uri]/api/v1/projects supported methods post docid\ hsi lzxs8g rx ydudzkg request body parameters the new project must be defined in the body of the request name (required) defines the name of the new project description (optional) defines the description of the new project path (optional) defines the location of the new project this parameter must be the full path to an instance folder if not provided, the newly created project will be added to the root templatelocation (optional) defines the template used for the new project this parameter must be the full path of the template project if not provided, the newly created project will not be based off of an existing project includecontent (optional) defines whether artifact contents of the template project should be copied into the new project this parameter must be set to "true" or "false " if not provided, the newly created project will not be created with artifact content from the template project http status codes 200 ok 201 successfully created 206 partial content 400 bad request this error can occur for a variety of reasons at least one uri or request body parameter is invalid, such as one of the filter docid\ sv9gjverxczcgqdn28j7u , traces, offset or limit parameters a required value has not been provided if you are submitting a post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui request and have not added the x http method override parameter to your request header if you have set includecontent to "true", but have not defined the templatelocation body parameter 401 unauthorized the blueprint token is missing, invalid or expired 403 forbidden the applicable permissions are needed for example, this error can occur when an author or collaborate license is needed for access comment permissions are needed on the artifact edit permissions are needed on the change summary job 404 notfound item is not found in the project for example, this error can occur when artifact not found artifact type not found project not found alm target not found change summary job not found user does not have edit permissions for this artifact, project or alm target 409 conflict reason for failure can be found in the response body additional information may also be found in the log 411 length required if the content length header is missing in the request 413 request entity too large if the provided file size is larger than allowed 415 unsupported media type if the provided media type is not of mime multipart content "form data " 416 request range not satisfiable if offset points to a part of a collection that is not available 500 internal server error 501 not implemented examples xml examples request uri https //production blueprintcloud com/api/v1/projects request body \<?xml version="1 0"?>\<createprojectrequest xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<description>this is my new project \</description> \<name>new project\</name> \<path>/blueprint\</path> \<templatelocation>/blueprint/templates/defaultprojecttemplate\</templatelocation>\</createprojectrequest> response body \<?xml version="1 0" ?>\<project xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<description>this is my new project \</description> \<id>4344\</id> \<location>/blueprint/new project\</location> \<name>new project\</name>\</project> json example request uri https //production blueprintcloud com/api/v1/projects request body \[ { "name" "new project", "description" "this is my new project ", "path" "/blueprint", "templatelocation" "/blueprint/templates/defaultprojecttemplate" }] response body \[ { "id" 4344, "name" "new project", "description" "this is my new project ", "location" "/blueprint/new project" }]