List Versions
  • 14 Aug 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

List Versions

  • Dark
    Light
  • PDF

List Versions

Method for getting a list of Versions.

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": "versions",
            "project_id": {{PROJECT_ID}},
            "sort": {{SORT_FIELD}},
            "order": {{ORDER}},
            "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 versions
project_id number + ID of the Project, which Versions will be listed. You can use project_short_name instead ID of an existing Project
project_short_name string +* Short name of the Project, which Versions will be listed, optional. *You can use it instead of the project_id Short name of an existing Project
sort string - Name of field to sort result title, vsn, date, status
order string - Sort the result in ascending or descending order asc / desc
company_id string + An ID of an Company An ID of an existing Company

Responce Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "obj": "versions",
            "proc": "ok",
            "list": [
                {
                    "is_owner": false,
                    "owner_id": 9054,
                    "owner_name": "Yevhen Sorokin",
                    "owner_login": "yevhen.sorokin@corezoid.com",
                    "obj_id": 1942,
                    "obj_type": "version",
                    "project_id": 154057,
                    "project_title": "PLOVSVAD",
                    "stage_id": 154241,
                    "stage_title": "dev",
                    "vsn": "0.0.1",
                    "title": null,
                    "changelog": "Add BotPlatform",
                    "link": "version_154241_0.0.1_1625665022728.zip",
                    "create_time": 1625665023,
                    "change_time": 1625838247,
                    "user_id": 9054,
                    "status": 1,
                    "file_format_vsn": 1,
                    "privs": []
                },
                {
                    "is_owner": false,
                    "owner_id": 9054,
                    "owner_name": "Yevhen Sorokin",
                    "owner_login": "yevhen.sorokin@corezoid.com",
                    "obj_id": 2003,
                    "obj_type": "version",
                    "project_id": 154057,
                    "project_title": "PLOVSVAD",
                    "stage_id": 154241,
                    "stage_title": "dev",
                    "vsn": "0.0.2",
                    "title": null,
                    "changelog": "",
                    "link": "version_154241_0.0.2_1625740034101.zip",
                    "create_time": 1625740035,
                    "change_time": 1625838247,
                    "user_id": 9054,
                    "status": 1,
                    "file_format_vsn": 1,
                    "privs": []
                },
                {
                    "is_owner": false,
                    "owner_id": 9054,
                    "owner_name": "Yevhen Sorokin",
                    "owner_login": "yevhen.sorokin@corezoid.com",
                    "obj_id": 2004,
                    "obj_type": "version",
                    "project_id": 154057,
                    "project_title": "PLOVSVAD",
                    "stage_id": 154241,
                    "stage_title": "dev",
                    "vsn": "0.0.3",
                    "title": null,
                    "changelog": "",
                    "link": "version_154241_0.0.3_1625740611194.zip",
                    "create_time": 1625740612,
                    "change_time": 1625838247,
                    "user_id": 9054,
                    "status": 1,
                    "file_format_vsn": 1,
                    "privs": []
                },
                {
                    "is_owner": false,
                    "owner_id": 9054,
                    "owner_name": "Yevhen Sorokin",
                    "owner_login": "yevhen.sorokin@corezoid.com",
                    "obj_id": 2018,
                    "obj_type": "version",
                    "project_id": 154057,
                    "project_title": "PLOVSVAD",
                    "stage_id": 154240,
                    "stage_title": "pre",
                    "vsn": "777.777.777",
                    "title": null,
                    "changelog": "свввыв",
                    "link": "version_154240_777.777.777_1625835769103.zip",
                    "create_time": 1625835771,
                    "change_time": 1625838247,
                    "user_id": 9054,
                    "status": 1,
                    "file_format_vsn": 1,
                    "privs": []
                }
            ]
        }
    ]
}
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 projects
list array The list of Users and their rights to requested object An array of projects
list[].is_owner boolean Flag of the current User ownership of the Version true / false
list[].owner_id number Version owner ID
list[].owner_name string Version owner displayed name
list[].owner_login string Version owner login
list[].obj_id number Version ID
list[].obj_type string An object type version
list[].project_id number Project ID
list[].project_title number Project title
list[].stage_id number Stage ID
list[].stage_title number Stage title
list[].vsn string Version number
list[].title string Version title null
list[].changelog string Version changelog
list[].link string Part of URL for Version downloading
list[].create_time number Version creation time, timestamp
list[].change_time number Time of the Version last change, timestamp
list[].user_id number ID of a user who created the Version false
list[].status number Version status 1 - Active, 3 - Deleted
list[].file_format_vsn number Version scheme version, for backward compatibility 1
list[].privs array An array of users rights settings for a shared object view, create, modify, delete

What's Next