REST API

HomeKnowledge BaseAPI

Orcanos REST API

1699 views /  2 likes /  // neha.bansal/

Introduction

The Orcanos REST API enables seamless integration with test automation frameworks and other automated processes, allowing for efficient data exchange and automation of key processes.

 

Getting Started

 

Create an API User

Navigate to Admin > Users & Groups > Users.

Click the ‘+’ button in the bottom-right corner to create a new user.

Set the First Name to “API” and the Last Name to “User”, ensuring the Username is “API.User” (see example below):

Assign Projects and Permissions

When creating the API User, you must choose which user groups and projects to assign the new user. Please ensure the API user is assigned to all relevant projects and has the appropriate permissions. 

Please refer to our Users guide for more information on assigning users with groups and projects.

 

Generate an API Key

Navigate to Admin > System Configuration > API.

Check the checkbox next to Enable API Key to generate a unique key.

Authentication with the API Key

To authenticate API requests, include the API key in the request header:

Error Codes

What errors and status codes can a user expect?

  • 500: An error has occurred or something was wrong
  • 200: Data is OK, Success
  • 401: Unauthorized, When Authorization token is not passed.

URL:

https://app.orcanos.com/ xxxxxx /api/v2/Json

https://app.orcanos.com/ xxxxxx /api/swagger/ui/index    

Where xxxxxx is a customer account name. Users can enter their account name here.

JSON Response:

In Success:

“IsSuccess” : true ,

“Data” : Full Information of related API function will display here.

“Message” : “” ,

“HttpCode” : 200

In Failure:

“IsSuccess” : false ,

    “Data” : Error Message will display here.

    “Message” : “” ,

    “HttpCode” : 500

 

REST APIs Library is here:

  1. QW_Login
  2. QW_Add_Defect
  3. QW_Update_Defect
  4. QW_Add_Object
  5. QW_Update_Object
  6. QW_Add_Object to Add Service Calls
  7. QW_Delete_Object
  8. QW_Get_Object
  9. QW_Get_Object_View
  10. Get_Execution_Run_Details_XML
  11. Record_Execution_Results_New
  12. QW_Get_Item_Add_Edit
  13. GetItemURL
  14. QW_Add_Step
  15. Qw_Add_MiscAttachment
  16. QW_Save_Customer
  17. QW_Get_CustomerList_FromName
  18. QW_Get_CustomerList
  19. Create_Tag_Web
  20. Delete_Tag_Web
  21. QW_Get_Object_Relations
  22. QW_Delete_Relation_Custom_Code
  23. QW_Add_Relations_Custom_Code
  24. QW_Delete_Relation
  25. QW_AddRelation
  26. QW_Get_Filter_Results
  27. Add_Test_Run_Param_Value
  28. Copy_Attachment_CopiedFrom_Item
  29. GetItemEnvironment
  30. QW_Get_Execution_Set
  31. QW_Get_RunParameter
  32. QW_Get_Section_Data
  33. QW_Delete_Attachment
  34. Generate_PDF_New
  35. QW_Get_Updated_Items_List
  36. QW_Get_Updated_Items_List_By_Date
  37. SystemTableValue_Get
  38. SysTableValue_Save
  39. SysTableValue_Delete
  40. Add Step
  41. Update Step
  42. Delete Step
Related Articles