3.9.0 How to Deploy/Import in QG model by API – How can we help?

Abbreviations, used in manual:

EF - Execution Flow

DS - Data Source

AD - Active Directory

ARC - Chrome Advanced Rest Client extension

How to run/test API calls:
Can be triggered from Postman or ARC.

Applicative mode required headers:
1. Authorization (Basic):

Authorization: Basic “{Authorization Key }” (Example: Basic YWRabW5AUUE6YWRtaW4=)
The Authorization Key is an encrypted combination of User name and Password String representation value and can be generated as follow: from quilliup module in the upper right corner click the User's icon and choose "Authentication":

Fill in the currently logged-in User's password and click "Run" In the "Authentication Key" field relevant Authentication Key value will be shown:

Header Value (when quilliup runs in applicative mode) - User name in format Username@TenantName & valid password value:

1.a. User Name: “{User_Name}”@”{Tenant_Name}” (Example: admin@QA).

2.Content-Type: application/json

AD mode required headers:
1.Header Name – Authorization (NTLM)
1.a. Header Value - User name in format domainName\userName & valid password value:

Content-Type: application/json

Deploy Steps:

Deploy package is a folder that will contain all required data and will be used for further Import process. In order to create a Deploy package for required FWs, /deployChosenObjects API of type POST should be implemented.

This API requires Body in next format:

{
"projectId": "cf412243-09c5-475d-bfa5-f44bb0287553",
"environemtId": "0f8d0f03-ecb0-4dc4-bd14-4c17ca408116", 
"moduleId": 2,
"packageName": "NP1",
"deleted_objects": [ ... ],
"related_objects": [ … ]
}

In order to build /deployChosenObjects API’s body in the required format, the following APIs should be implemented beforehand:

1. Step 1 - API that returns a list of all Projects in QG - choose needed Project Id from Response, that will be used for further Deploy process:

Method – GET
Request URL - http://localhost:8080/api/projects?filter=id,name&moduleId=2
Response will be returned in the format:

[
{
"id": "cf412243-09c5-475d-bfa5-f44bb0287553",
"name": "chen_test"
},
{
"id": "15e55ea2-0ad7-4f3d-b164-fb569cafff2f",
"name": "Cycle 4"
}, ...
]

Note: API that return all Roles in QG:
Request URL - http://localhost:8080/api/roles?filter=id,name&moduleId=2

Note: API that return all Tags in QG:
Request URL - http://localhost:8080/api/tags?filter=id,name&moduleId=2

2. Step 2 - API that returns a list of all objects in a specific project - choose needed Rules/Variable/Data set/Test/EF/DS Id from Response, that will be used for further Deploy process:

Method – GET
Request URL for Rules - http://localhost:8080/api/rules?filter=id,name&projectId={Project_ID}
Request URL for Scripts - http://localhost:8080/api/script_command?filter=id,name&projectId={Project_ID}
Note: There is an option to add a filter by the parameter "scriptType":
http://localhost:8080/api/script_command?filter=id,name&projectId={Project_ID}&scriptType={required script type}
Request URL for Variables - http://localhost:8080/api/variables?filter=id,name&projectId={Project_ID}
Request URL for Data Sets - http://localhost:8080/api/data_sets?filter=id,name&projectId={Project_ID}
Request URL for Tests - http://localhost:8080/api/tests?filter=id,name&projectId={Project_ID}
Request URL for EFs - http://localhost:8080/api/execution_flow?filter=id,name&projectId={Project_ID}
Request URL for DSs - http://localhost:8080/api/data_sources?filter=id,name&projectId={Project_ID}&moduleId=2
Response will be returned in format (the same format for all the options):

[
{
"id": "53d42671-d619-4e6d-a287-f3277c226f14",
"name": "Omer_FW"
},
{
"id": "1f704e0e-2ee3-437b-abfa-852b4a3e6f0f",
"name": "Zen_3013"
},
...
]

3.Step 3 - API that returns Environments list- select Environment Id from Response, that will be used for further Deploy process:

Method – GET
Request URL - http://localhost:8080/api/environments?allowDeploy=true&filter=id,name&ignoreSecurity=true
Response will be returned in format:

[
{
"id": "de98c6ba-7401-485b-9d5a-4758326d8763",
"name": "Amiran_check"
},
{
"id": "0f8d0f03-ecb0-4dc4-bd14-4c17ca408116",
"name": "Moran_test"
},
...
]

4. Step 4 - API that returns Related Objects and Deleted Objects:

Method – POST
Request URL - http://localhost:8080/api/deployments/related_objects
Body:

{
"environemtId": "{Environment_id_from_Step3}",
"moduleId": 2,
"objects": [
{
"id": "{Object_ID_from_Step2}",
"type": "{tests/execution_flow/data_sources}"
},
{in case you chose more than 1 object to deploy, please add the 
"id": "{Object_ID_from_Step2}",
"type": "{tests/execution_flow/data_sources}" 
of the other objects}
]
}

Response will be returned in format:

{ "status": true,
"message": {
"related_objects": [
{
"date": 0,
"displayed": true,
"error": "",
"id": "53d42671-d619-4e6d-a287-f3277c226f14",
"name": "Omer_FW",
"nodes": [
{
"date": 0,
"displayed": true,
"error": "",
"id": "e6b0048c-acf4-41c2-b2bb-dc4ecebce1c0",
"name": "Omer-Test",
"nodes": [],
"objectAction": 3,
"selected": true,
"status": "",
"type": "projects"},
......
],
"deleted_objects": [
{
"date": 1634450754000,
"displayed": true,
"error": "",
"id": "53d42671-d619-4e6d-a287-f3277c226f14",
"name": "Omer_FW",
"nodes": [],
"objectAction": 0,
"selected": true,
"status": "",
"type": "form_wizards" },
.........
]
} }

5. Deploy chosen objects – add the Test/EF/DS's Ids and set the environment to Deploy :

Method – POST
Request URL - http://localhost:8080/api/deployments/deployChosenObjects
Body:

{
"environemtId": "{Environment_id_from_Step3}",
"moduleId": 2,
"projectId": "{Project_ID_From_Step2}",
"packageName": "{New_deploy_package_name}",
"deleted_objects": [ { deleted_objects from Response from Step4 } ],
"related_objects": [ { related_objects from Response from Step4 } ]
}

Response will be returned in format:

{"status":true, "message":"a2308e00-ac03-4742-8c94-ac10f126013a"}

Import Steps:

In order to import an existing package /api/imports/import API of type POST should be implemented.

This API requires Body in the next format:

{
"projectId": "cf412243-09c5-475d-bfa5-f44bb0287553",
"filePath": "D:\\Public\\ImpFolder\\import\\3\\NP1_20211017150451", -- you can use constant path to the folder that will contain all the packages for Import 
"moduleId": 2,
"deleted_objects": [ … ], -- you can use "deleted_objects" value received in “Deploy Steps -> Step 4
"related_objects": [ … ], -- you can use "relted_objects" value received in “Deploy Steps -> Step 4
}

1.Step 1 - API that allows to get Project's list - choose needed Project Id from Response, it will be used for further Import process:

Method – GET
Request URL - http://localhost:8080/api/projects?filter=id,name&moduleId=2
Response will be returned in format:

[
{"id": "cf412243-09c5-475d-bfa5-f44bb0287553", "name": "chen_test"},
{"id": "15e55ea2-0ad7-4f3d-b164-fb569cafff2f", "name": "Check"},
...
]

2. Import package:

Method – POST
Request URL - http://localhost:8080/api/imports/import
Body:

{
"projectId": "{From_Step1}",
"filePath": "valid path to existing deployed package”,
"moduleId": 2,
"deleted_objects": [ ... ],
"related_objects": [ … ]
}

Response example:

{
"status": true,
"message": {
"related_objects": [
{
"date": 0,
"displayed": true,
"error": "",
"id": "53d42671-d619-4e6d-a287-f3277c226f14",
"name": "Omer_FW",
"nodes": [
{
"date": 0,
"displayed": true,
"error": "",
"id": "e6b0048c-acf4-41c2-b2bb-dc4ecebce1c0",
"name": "Omer-Test",
"nodes": [],
"objectAction": 3,
"selected": true,
"status": "completed",
"type": "projects"
}
……,
"deleted_objects": []
}
}

Related articles