Get object scheme

Updated on 10 Aug 2022
3 Minutes to read
Contributors

Print
Share
Dark

Light
PDF

Get object scheme

Method for getting object scheme.

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": "list",
            "obj": "conv",
            "obj_id": 783230,
            "get_counter": false,
            "company_id": "i404856373"
        }
    ]
}

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	list
obj	string	+	An object of request	folder, conv, dashboard
obj_id	number / number as string	+	An ID of Process or State diagram
get_counter	boolean	+	Adding values of tasks number in the nodes ("count")	true, false
company_id	string	+	An ID of a Company	An ID of an existing Company

Response Body

{
  "request_proc": "ok",
  "ops": [
    {
      "id": "",
      "obj": "conv",
      "obj_id": 420858,
      "project_id": 0,
      "stage_id": 0,
      "immutable": false,
      "privs": [
        {
          "type": "delete",
          "list_obj": [
            "all"
          ]
        },
        {
          "type": "create",
          "list_obj": [
            "all"
          ]
        },
        {
          "type": "view",
          "list_obj": [
            "all"
          ]
        },
        {
          "type": "modify",
          "list_obj": [
            "all"
          ]
        }
      ],
      "status": "active",
      "title": "Test",
      "description": "",
      "conv_type": "process",
      "is_owner": true,
      "owner_name": "api",
      "owner_id": 18769,
      "owner_login": "60706e88094bab6a7a002042",
      "proc": "ok",
      "list": [
        {
          "obj": "node",
          "obj_id": "6089613956167c0561005ccb",
          "title": "final",
          "description": "",
          "logics": [],
          "semaphors": [],
          "count": 0,
          "obj_type": 2,
          "position": null,
          "extra": null,
          "options": null
        },
        {
          "obj": "node",
          "obj_id": "6089613956167c0561005cca",
          "title": "process",
          "description": "",
          "logics": [
            {
              "to_node_id": "6089613956167c0561005ccb",
              "type": "go"
            }
          ],
          "semaphors": [],
          "count": 0,
          "obj_type": 0,
          "position": null,
          "extra": null,
          "options": null
        },
        {
          "obj": "node",
          "obj_id": "6089613956167c0561005cc9",
          "title": "start",
          "description": "",
          "logics": [
            {
              "to_node_id": "6089613956167c0561005cca",
              "type": "go"
            }
          ],
          "semaphors": [],
          "count": 0,
          "obj_type": 1,
          "position": null,
          "extra": null,
          "options": null
        }
      ],
      "escalation_conv": "undefined",
      "shared": false,
      "folder_id": 142773,
      "folder_name": "NewTest",
      "change_time": 1619616057,
      "create_time": 1619616057,
      "tacts": 36,
      "favorite": false,
      "company_id": "i555506875",
      "commits": {},
      "size": 3
    }
  ]
}

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
obj	string	An object type	folder, conv, dashboard
obj_id	number	An ID of object
project_id	number	Project ID	0
stage_id	number	Stage ID	0
immutable	boolean	Identifies whether the stage is immutable	false, true
privs	array	An array of users rights settings over shared object	view, create, modify, delete
status	string	A current state of object	active, paused, debug, blocked
title	string	A name of object
description	string	A description of object
conv_type	string	A type of object	process, state
is_owner	boolean	A flag of ownership over object	true, false
owner_name	string	A Name of object owner
owner_id	number	An ID of object owner
owner_login	string	A Login of object owner
proc	string	The processing status of a specific operation	ok, error
list	array	The list of object logic (Nodes)	---
list.obj	string	A type of object	node
list.obj_id	string	An ID of node	---
list.title	string	A name of node
list.description	string	A description of node	---
list.logics	array	An array of node settings	---
list.semaphors	array	An array of node escalations settings	---
list.count	number	(AVAILABLE FOR get_counter = true) A number of tasks in the node
list.obj_type	number	An identifier of node type	0 (logic node), 1 (start node), 2 (final node)
list.position	array	An array of x and y coordinates	---
list.extra	string	A stringify object of additional node settings (expand or minimize, node icon)	---
escalation_conv	---	Deprecated field	---
shared	boolean	A flag of sharing status	true, false
folder_id	number	An ID of folder where object stored
folder_name	string	A Name of folder where object stored	---
change_time	timestamp	Timestamp of last changes	---
create_time	timestamp	Timestamp of object creation	---
tacts	number	A number of tacts used by object over all time	---
favorite	boolean	A flag of adding object to favorites	true, false
company_id	string	An ID of an Company where object stored	---
commits	JSON Object	A list of saved but not deployed changes of object
size	number	A number of Nodes of object

Was this article helpful?

What's Next

Change object (Name/Description/State)

Table of contents