Show Alias
  • 16 Oct 2020
  • 2 Minutes To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Show Alias

  • Print
  • Share
  • Dark
    Light

Show Alias Details

Method for showing Alias details.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{GMT_UNIXTIME}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "show",
            "obj": "alias",
            "obj_id": {{ALIAS_ID}},
            "project_id": 0,
            "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 + An ID of Alias An ID of existing Alias
project_id number - Currently deprecated feature, please use 0 0
company_id string + An ID of a Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj_id": 73,
            "name": "Corezoid",
            "description": "R2D2",
            "short_name": "r2-d2",
            "obj_to_id": 271140,
            "obj_to_type": "conv",
            "obj_to_title": "Router",
            "privs": [
                {
                    "type": "create",
                    "list_obj": [
                        "all"
                    ]
                },
                {
                    "type": "view",
                    "list_obj": [
                        "all"
                    ]
                },
                {
                    "type": "modify",
                    "list_obj": [
                        "all"
                    ]
                },
                {
                    "type": "delete",
                    "list_obj": [
                        "all"
                    ]
                }
            ],
            "is_owner": true,
            "owner_id": 15402,
            "owner_name": "Alases API Test",
            "owner_login": "5f4527f0094bab5a6c000005",
            "create_time": 1598431462,
            "change_time": 1598435953,
            "is_favorite": false,
            "project_id": 0,
            "company_id": "i460234064"
        }
    ]
}
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 A request id empty
proc string The processing status of a specific operation ok, error
obj_id number An ID of Alias
name string A name of Alias
description string A description of Alias
short_name string A short name of Alias
obj_to_id number An ID of object (Process or State Diagramm) that linked to Alias null if Alias is not linked, otherwise an ID of Process or State Diagramm
obj_to_type string A type of linked to Alias object null if Alias is not linked, otherwise conv
obj_to_title string (RETURNS ONLY IF ALIAS LINKED TO OBJECT) A name of linked object
privs array An array of User rights settings over linked object
is_owner boolean A flag of ownership over Alias true, false
owner_name string A Name of Alias owner
owner_id number An ID of Alias owner
owner_login string A Login of Alias owner
create_time number Time of creation of Alias, timestamp
change_time number Time of last change of Alias, timestamp
is_favorite boolean A flag of adding Alias to favorites true, false
project_id number Currently deprecated feature 0
company_id string An ID of a Company
Was This Article Helpful?