Show Alias details in a Stage
  • 08 Nov 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Show Alias details in a Stage

  • Dark
    Light
  • PDF

Show Alias Details

Method for showing details of an Alias in a Stage.

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": "alias",
            "obj_id": {{ALIAS_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 show
obj string + An object of request alias
obj_id number + ID of the Alias, which details will be displayed. You can use the obj_short_name instead ID of an existing Alias
obj_short_name string +* Short name of the Alias, which details will be displayed, optional. *You can use it instead of the obj_id Short name of an existing Alias
company_id string + Company ID An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "alias",
            "is_favorite": false,
            "is_owner": true,
            "owner_id": 81220,
            "owner_name": "New Key",
            "owner_login": "6149e8ee82ba966317ac22f2",
            "obj_id": 2147,
            "obj_type": "alias",
            "title": "Corezoid 2",
            "description": "CYRAX",
            "short_name": "c3po",
            "company_id": "i232593215",
            "project_id": 101,
            "stage_id": 27,
            "obj_to_id": null,
            "obj_to_type": null,
            "create_time": 1632237194,
            "change_time": 1632237194,
            "uuid": "964c3ed9-83b2-45f5-afc8-3c19e5bcaed1",
            "stage_title": "New",
            "privs": [
                {
                    "type": "create",
                    "list_obj": [
                        "all"
                    ]
                },
                {
                    "type": "view",
                    "list_obj": [
                        "all"
                    ]
                },
                {
                    "type": "modify",
                    "list_obj": [
                        "all"
                    ]
                },
                {
                    "type": "delete",
                    "list_obj": [
                        "all"
                    ]
                }
            ]
        }
    ]
}
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 object
is_favorite boolean Flag of adding Alias to favorites true, false
is_owner boolean Flag of Alias ownership true, false
owner_id number Alias owner ID
owner_name string Alias owner name
owner_login string Alias owner login
obj_id number Alias ID
obj_type string Object type
title string Alias name
description string Alias description
short_name string Alias short name
company_id string Company ID
project_id number Project ID
stage_id number Stage ID
obj_to_id number ID of an object (Process or State Diagram) linked to the Alias null if Alias is not linked, otherwise an ID of Process or State Diagram
obj_to_type string Type of an object linked to the Alias null if Alias is not linked, otherwise conv
create_time number Time of Alias creation, timestamp
change_time number Time of Alias last change, timestamp
obj_to_title string (RETURNS ONLY IF THE ALIAS IS LINKED TO AN OBJECT) A name of linked object
list[].uuid string Universally Unique Identifier of the object
list[].stage_title string Title of the Stage that contains the Alias
privs array An array of User rights settings for a linked object