Link a Stage Alias to an Object
  • 08 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Link a Stage Alias to an Object

  • Dark
    Light
  • PDF

Link Alias to object (Process or State Diagram)

Method for linking objects to Aliases created in Stages.

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": "link",
            "obj": "alias",
            "obj_id": {{ALIAS_ID}},
            "obj_to_id": {{OBJ_ID}},
            "obj_to_type": {{OBJ_TYPE}},
            "link": "true",
            "project_id": {{PROJECT_ID}},
            "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 link
obj string + An object of request invite
obj_id number + ID of the Alias, to which objects will be linked. You can use the obj_short_name instead ID of an existing Alias
obj_short_name string +* Short name of the Alias, to which objects will be linked, optional. *You can use it instead of the obj_id Short name of an existing Alias
obj_to_id number + An ID of an object (Process or State diagram) that will be linked to/unlinked from the Alias An ID of existing Process or State diagram
obj_to_type string + A type of linked to Alias object conv
link boolean + A flag of linking or unlinking true, false
project_id number + ID of the Project, in which objects will be linked to the Alias. You can use project_short_name instead ID of an existing Project
project_short_name string +* Short name of the Project, in which objects will be linked to the Alias, optional. *You can use it instead of the project_id Short name of an existing Project
company_id string + Company ID An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "alias",
            "obj_id": 73
        }
    ]
}
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 An object of request alias
obj_id number Alias ID