Create Project
  • 14 Aug 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create Project

  • Dark
    Light
  • PDF

Create Project

Method for creating new Corezoid Projects

postman Download our collection of Postman queries to see more examples of Corezoid API v2.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{TIMESTAMP}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "create",
            "obj": "project",
            "title": {{TITLE}},
            "short_name": {{SHORT_NAME}},
            "description": {{DESCRIPTION}},
            "stages": [{{STAGE_NAME}}, ...],
            "status": "active",
            "company_id": {{COMPANY_ID}}
        }
    ]
}
Parameter Type Required Description Possible value
ops JSON Object + The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations * The number is user-limited by RPS limit.
type string + Request type create
obj string + An object of the request project
title number / number as string - Project name Any valid string
short_name string + Project short name Any valid string
description string - Project description Any valid string
stages array - An array with stages names String list of "a-z", "0-9" or "-" symbols. E.g.: "stages": ["master", "stage", "dev"]
stages[] string - Stage name Any valid string
status string - Project status active
company_id string + Company ID An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "project",
            "obj_id": {{OBJECT_ID}},
            "stages": [
                {{STAGE_ID}},
                ....
            ]
        }
    ]
}
Parameter Type Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops array The list of request results
id string Request ID empty
proc string Processing status of a specific operation ok, error
obj string Object of the request project
obj_id number Created Project ID
stages array Array of created Stages IDs

What's Next