Get object information
  • 14 Dec 2022
  • 4 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Get object information

  • Dark
    Light
  • PDF

Get object information

Method for getting details of staus, ID, name, description, creation and last change time of object.

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": "show",
      "obj": {{OBJ}},
      "obj_id": 800473,
      "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 show
obj string + An object of request folder, conv, dashboard
obj_id number + An ID of object of request
company_id string - An ID of a Company where object stored An ID of an existing Company

Response Body for "obj": "folder"

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "folder",
            "obj_id": 354776,
            "title": "Messangers",
            "obj_type": 0,
            "parent_obj_id": 0,
            "parent_obj_type": "folder"
        }
    ]
}
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 request folder, conv, dashboard
obj_id number An ID of an object
title string A Name of an object
obj_type number
parent_obj_id number ID of a parent object
parent_obj_type string Parent object type folder

Response Body for "obj": "conv"

{
  "request_proc": "ok",
  "ops": [
    {
      "id": "",
      "proc": "ok",
      "obj": "conv",
      "obj_id": 790914,
      "title": "Process_1656100869194",
      "status": "active",
      "size": 0,
      "owner_name": "ApiKeyForTest",
      "owner_login": "612f2acd56167c519a000d03",
      "create_time": 1656100869,
      "change_time": 1656100869,
      "project_id": 0,
      "stage_id": 0,
      "immutable": false,
      "parent_obj_id": 0,
      "parent_obj_type": "folder"
    }
  ]
}
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 request folder, conv, dashboard
obj_id number An ID of an object
title string Process name
status string --- active, paused, debug, blocked
size number Number of nodes in object
owner_name string An displayed name of object owner
owner_login string An login of object owner
create_time string Timestamp of object creation
change_time string Timestamp of last object change
project_id number Project ID 0
stage_id number Stage ID 0
immutable boolean Shows whether the stage is immutable false, true
parent_obj_id number ID of a parent object
parent_obj_type string Parent object type folder

Response Body for "obj": "dashboard"

{
  "request_proc": "ok",
  "ops": [
    {
      "id": "",
      "proc": "ok",
      "obj": "dashboard",
      "obj_id": 54438,
      "title": "New object",
      "description": "",
      "parent_obj_id": 0,
      "parent_obj_type": "folder",
      "create_time": 1648457196,
      "change_time": 1648457200,
      "time_range": {
        "timezone_offset": -180,
        "select": "online"
      },
      "favorite": false,
      "privs": [
        {
          "type": "delete",
          "list_obj": [
            "all"
          ]
        },
        {
          "type": "create",
          "list_obj": [
            "all"
          ]
        },
        {
          "type": "view",
          "list_obj": [
            "all"
          ]
        },
        {
          "type": "modify",
          "list_obj": [
            "all"
          ]
        }
      ],
      "company_id": "i112493970",
      "chart_list": [
        {
          "name": "New Chart",
          "obj_id": "624175ee56167c29a800bfae",
          "type": "table"
        }
      ],
      "folder_id": 211000,
      "folder_name": "7121",
      "owner_id": 15745,
      "owner_login": "starttesting16@gmail.com",
      "owner_name": "Aleksandr",
      "grid": [
        {
          "obj_id": "624175ee56167c29a800bfae",
          "x": 0,
          "y": 0,
          "width": 4,
          "height": 4
        }
      ]
    }
  ]
 }
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 request dashboard
obj_id number An ID of Dashboard An ID of existing Dashboard
title string A name of Dashboard
description string A description of Dashboard
parent_obj_id number ID of a parent object
parent_obj_type string Parent object type folder
create_time string Timestamp of object creation
change_time string Timestamp of last object change
time_range JSON Object A settings of dashboard
timezone_offset number ---
select string --- online, previous_hour, today, last10minute , lastHour, last24hour, lastWeek, lastMonth
favorite boolean A Favorite flag true, false
privs array An array of user rights settings over Dashboard view, create, modify, delete
company_id string An ID of an Company, where Dashboard is stored An ID of existing Company
chart_list array An array of Charts on Dashboard
name string A Chart name
obj_id string An ID of Chart An ID of existing Chart
type string A type of Chart table, funnel, column, pie
folder_id number ID of a folder, in which the Dashboard is stored An ID of existing Folder
folder_name string Name of a folder, in which the Dashboard is stored An ID of existing Folder
owner_id number Dashboard owner ID An ID of existing User
owner_login string Dashboard owner login
owner_name string Displayed name of the Dashboard owner
grid array An array of Charts displaying placement
obj_id string An ID of Chart An ID of existing Chart
x number A chart placement on X-axis 0-11
y number A chart placement on Y-axis 0-11
width number A chart width 0-12
height number A chart height 0-12

What's Next