-
Print
-
DarkLight
-
PDF
Show Stage Aliases for a Process/State Diagram
Show all linked Aliases for Process/State Diagram
Method for showing a list of Aliases linked to a Process/State Diagram in a Stage.

URL
https://api.corezoid.com/api/2/json/{API_LOGIN}/{TIMESTAMP}/{SIGNATURE}
Request Body
{
"ops": [
{
"type": "list",
"obj": "aliases",
"conv_id": {{OBJECT_ID}},
"project_id": {{PROJECT_ID}},
"stage_id": {{STAGE_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 | + | Request type | list |
obj | string | + | An object of the request | project |
conv_id | number | - | Process/State diagram ID | ID of an existing Process/State diagram |
project_id | number | + | ID of the Project, for which Aliases linked to the Process/State diagram are listed. You can use project_short_name instead |
ID of an existing Project |
project_short_name | string | +* | Short name of the Project, for which Aliases linked to the Process/State diagram are listed, optional. *You can use it instead of the project_id |
Short name of an existing Project |
stage_id | number | + | ID of the Stage, for which Aliases linked to the Process/State diagram are listed. You can use stage_short_name instead |
ID of an existing Stage |
stage_short_name | string | +* | Short name of a Stage, for which Aliases linked to the Process/State diagram are listed, optional. *You can use it instead of the stage_id |
Short name of an existing Stage |
company_id | string | + | Company ID | An ID of an existing Company |
Response Body
{
"request_proc": "ok",
"ops": [
{
"id": "",
"proc": "ok",
"list": [
{
"name": "newName",
"is_favorite": false,
"obj_to_title": "Conv_1637821192948",
"is_owner": true,
"owner_id": 21396,
"owner_name": "ApiKeyForTest",
"owner_login": "612f2acd56167c519a000d03",
"obj_id": 19317,
"obj_type": "alias",
"title": "newName",
"description": "modify",
"short_name": "modify",
"company_id": "i738314881",
"project_id": 180372,
"stage_id": 180373,
"obj_to_id": 518409,
"obj_to_type": "conv",
"create_time": 1637821194,
"change_time": 1637821194,
"uuid": "23ec9638-1536-44d3-b83b-d2c1f60de8d9",
"stage_title": "Stage_1637821192689",
"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 | 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 |
list | array | An array with a list of Aliases | |
list[].name | string | Alias name (similar to Title) | |
list[].is_favorite | boolean | Flag of adding Alias to favorites | true, false |
list[].obj_to_title | string | (RETURNS ONLY IF AN ALIAS IS LINKED TO AN OBJECT) A name of linked object | |
list[].is_owner | boolean | Flag of Alias ownership | true, false |
list[].owner_id | number | Alias owner ID | |
list[].owner_name | string | Alias owner name | |
list[].owner_login | string | Alias owner login | |
list[].obj_id | number | Alias ID | |
list[].obj_type | string | Object type | alias |
list[].title | string | Alias name | |
list[].description | string | Alias description | |
list[].short_name | string | Alias short name | |
list[].company_id | string | Company ID | |
list[].project_id | number | ID of the Project, in which you want to show a list of Aliases linked to a Process/State diagram | |
list[].stage_id | number | ID of the Stage, in which you want to show a list of Aliases linked to a Process/State diagram | |
list[].obj_to_id | number | ID of an object (Process or State Diagram) linked to an Alias | null if Alias is not linked, otherwise a Process or State Diagram ID |
list[].obj_to_type | string | Type of an object linked to an Alias | null if Alias is not linked, otherwise conv |
list[].create_time | number | Time of Alias creation, timestamp | |
list[].change_time | number | Time of Alias last change, timestamp | |
list[].uuid | string | Universally Unique Identifier of an object | |
list[].stage_title | string | Title of a Stage containing the Aliases | |
list[].privs | array | An array of User rights settings for a linked object |
Was this article helpful?