Сheck object scheme
  • 30 Mar 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Сheck object scheme

  • Dark
    Light
  • PDF

Check object scheme

Method for checking object scheme in Corezoid. The method is used for detecting the processes in a folder, which have undeployed changes before exporting the folder. After detecting the processes, users can deploy these processes and retain the unsaved changes otherwise lost after the export.

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

{
    "ops": [
        {
            "obj_id": {{OBJ_ID}},
            "obj_type": "{{OBJ_TYPE}}",
            "type": "check",
            "obj": "obj_scheme"
        }
    ]
}
Parameter Type Description Required 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.
obj_id number / number as string ID of the object (folder) that is checked for undeployed changes + ID of an existing folder
obj_type string Type of the object, in which undeployed changes need to be checked + folder
type string Type of the operation on the object + check
obj string The object of request + obj_scheme

Example of response for deployed proceses

{
  "request_proc": "ok",
  "ops": [
    {
      "id": "",
      "obj": "obj_scheme",
      "proc": "ok"
    }
  ]
}
Parameter Type Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops JSON Object The list of operations proceeded via Corezoid API. A parameter keeping JSON objects with operations
id string Request ID empty
obj string The object of request obj_scheme
proc string The processing status of a specific operation ok, error

Example of response for undeployed proceses

{
  "request_proc": "ok",
  "ops": [
    {
      "id": "",
      "proc": "error",
      "errors": [
        {
          "obj_id": 783230,
          "obj_type": "conv",
          "description": "The process with ID 783230 has an uncommitted version"
        }
      ]
    }
  ]
}
Parameter Type Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops JSON Object The list of operations proceeded via Corezoid API. A parameter keeping JSON objects with operations
id string Request ID empty
proc string The processing status of a specific operation ok, error
errors JSON Object The list of errors (Processes with undeployed changes)
obj_id number / number as string ID of the object (Process) that has undeployed changes ID of an existing Process
obj_type string Type of the object, which has undeployed changes conv
description string Specification of the Processes with their {{OBJ_ID}} that have uncommitted changes The process with ID {{OBJ_ID}} has an uncommitted version

Was this article helpful?

What's Next