OVERVIEW
This REST API helps to add the defect in the pool (on the Work Item page).
Method: Post
Input:
Authorization: Using an API key in the Request Headers. For more information, please refer to our Orcanos REST API article.
Post body:
Purpose of Fields given in this API:
| Parameter | Value | Mandatory | Description |
| Project_Name | String | Yes | Defect project name. |
| Major_Version | Int | Yes | The major version view number as appears in Orcanos.
Default is 0 |
| Minor_Version | Int | Yes | The Minor version view number as appears in Orcanos.
Default is 0 |
| Parent_ID | String | No | Input the parent item id where defect will be created under. Default value will be the input project. Example: 10289, 10276 etc |
| Synopsis | String | Yes | Defect synopsis |
| Description | String | Yes | Defect description in plain text/HTML format |
| Defect_type | String | No | Type of defect – “Internal”/”External”.
Default is “Internal” [External stands for defects reported by customers] |
| Assigned_to | String | Yes | User name the defect should be assigned to. User must belong to project.
Default is the default assigned user in status workflow |
| Created_date | String | No | The defect created date.
Format must be the date format of the local machine Default is Current date & time |
| Created_by | String | No | The name of the user created the defect.
Default is the user that calls the service. |
| Category | String | No | Defect category.
Default is category default value (Taken from admin system tables) |
| Severity | String | No | Defect severity.
Default is severity default value (Taken from admin system tables) |
| Status | String | No | Defect status.
Default is status default process flow value (Taken from admin system tables) |
| Priority | String | No | Defect priority.
Default is priority default value (taken from admin system tables) |
| Found_version | String | No | Defect found version.
Format: 99.99.999.9999 Default is input version (major_version.minor_version.0.0) |
| Fixed_version | String | No | Defect fixed version.
Format: 99.99.999.9999 Default is input version (major_version.minor_version.0.0) |
| Target_version | String | No | Defect target version.
Format: 99.99.999.9999 Default is input version (major_version.minor_version.0.0) |
| Start_date | String | No | The defect start date.
Format must be the date format of the local machine Default is Current date & time |
| Effort_estimation | String | No | Defect effort estimation.
Default is 0 |
| Due_date | String | No | The defect due date.
Format must be the date format of the local machine Default is Current date & time |
| Solution | String | No | Defect resolution |
| Work_around | String | No | Defect work around |
| CS1_Name | String | No | Defect 1st custom field name |
| CS1_value | String | No | Defect 1st custom field value |
| Upto CS60_Name | String | No | Upto Defect 60th custom field name |
| Upto CS60_value | String | No | Upto Defect 60th custom field value |
| MigrationReference | String | No | For each item inserted, you can add a reference string. Later on you will be able to use this reference in reports, or in order to delete group of items – you will be able to delete a group of items by the migration reference string |
| external_id | String | No | If the defect source is from 3rd party system. You can add the ID from the 3rd party system for later use. |
Output:
Orcanos Output class:
{
"IsSuccess": true,
"Data": 1097,
"Message": "Defect created successfully."
"HttpCode": 200
}
IsSuccess: if successful then true else false
Data: Updated or Newly created Defect ID
Message: Error message in case IsSuccess is false
HttpCode: Response HttpCode