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

Modify Project

  • Dark
    Light
  • PDF

Modify Project

Method for modifying a Project

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": "modify",
            "obj": "project",
            "obj_id": {{OBJECT_ID}},
            "title": {{TITLE}},
            "short_name": {{SHORT_NAME}},
            "description": {{DESCRIPTION}},
            "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 + A request type modify
obj string + An object of request project
obj_id number + ID of the Project, which will be modified. You can use the obj_short_name instead ID of an existing Project
obj_short_name string +* Short name of the Project, which will be modified, optional. *You can use it instead of the obj_id Short name of an existing Project
title string - A Name of an instance Any valid string
short_name string - Project short name Any valid string
description string - A description of an Project Any valid string
company_id string - An ID of an Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "project",
            "obj_id": 120465
        }
    ]
}
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 The processing status of a specific operation ok, error
obj string An object of the request project
obj_id number Project ID

What's Next