Show Aliases for Process/State Diagram
  • 23 Jun 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Show Aliases for Process/State Diagram

  • Dark
    Light
  • PDF

Show all linked Aliases for Process/State Diagram

Method for showing list of linked Aliases for a Process/State Diagram.

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": "list",
            "obj": "aliases",
            "conv_id": {{CONV_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 list
obj string + An object of request aliases
conv_id number + An ID of Process / State diagram An ID of an existing Process or State diagram
company_id string + An ID of a Company An ID of an existing Company

Response Body

{
       "request_proc": "ok",
       "ops": [
           {
               "id": "",
               "proc": "ok",
               "list": [
                   {
                       "is_favorite": false,
                       "obj_to_title": "api",
                       "is_owner": true,
                       "owner_id": 21976,
                       "owner_name": "node",
                       "owner_login": "614c52ee094bab7e5000617c",
                       "obj_id": 14240,
                       "obj_type": "alias",
                       "title": "api",
                       "description": null,
                       "short_name": "api",
                       "company_id": "i642605356",
                       "project_id": 0,
                       "stage_id": 0,
                       "obj_to_id": 486271,
                       "obj_to_type": "conv",
                       "create_time": 1632419049,
                       "change_time": 1632419049,
                       "uuid": "94e50987-4afa-49d7-9f7f-e9482d4881a2",
                       "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 A request id empty
proc string The processing status of a specific operation ok, error
list array An array with a list of Aliases
list[].is_favorite boolean A flag of adding Alias to favorites true, false
list[].obj_to_title string (RETURNS ONLY IF ALIAS LINKED TO OBJECT) A name of linked object
list[].is_owner boolean A flag of ownership over Alias true, false
list[].owner_id number An ID of Alias owner
list[].owner_name string A Name of Alias owner
list[].owner_login string A Login of Alias owner
list[].obj_id number An ID of Alias
list[].obj_type string Object type alias
list[].project_id number Not used for company Aliases (see Aliases in Stages) 0
list[].stage_id number Not used for company Aliases (see Aliases in Stages) 0
list[].title string A name of Alias
list[].description string A description of Alias
list[].short_name string A short name of Alias
list[].company_id string An ID of a Company
list[].obj_to_id number An ID of object (Process or State Diagram) that linked to Alias null if Alias is not linked, otherwise an ID of Process or State Diagram
list[].obj_to_type string A type of linked to Alias object null if Alias is not linked, otherwise conv
list[].create_time number Time of creation of Alias, timestamp
list[].change_time number Time of last change of Alias, timestamp
list[].uuid string Universally Unique Identifier of the object
list[].privs array An array of User rights settings over linked object

Was this article helpful?