Testinium
  • Testinium Cloud
    • GET STARTED
      • What is Testinium?
      • Go to Testinium
    • How to run tests in Testinium?
    • Testinium Cloud Navigation
  • LOGIN
    • Login
      • Log in to Testinium
      • Reset Password
  • DASHBOARD
    • Dashboard
  • USER PROFILE
    • User Profile
      • Account Information
  • PROJECTS
    • Projects
      • Create New Project
      • Summary
      • Scenarios
      • Plans
      • Advanced
      • Properties
  • SCENARIOS
    • Scenarios
      • Create Scenario
      • Edit Scenarios
      • Delete Scenarios
      • Create New Group
      • Sync Scenarios
  • PLANS
    • Plans
      • Create Plan
      • Edit Plans
      • Delete Plans
      • Report
      • Run Plan
      • Quick Run Plan
  • REPORTS
    • Reports
      • Test Execution(Auto)
      • Scheduled Reports(Periodically Scheduled)
        • Create New Periodically Reports
        • Edit Periodically Report
        • Delete Periodically Report
        • Periodically Report History
      • Smart Prioritization Report
  • AUTOMATED TEST
    • Automated Test
      • Test Code Generator(Web)
      • Test Code Generator(Android Web)
      • Test Code Generator(IOS Web)
      • Test Code Generator(Android App)
      • Test Code Generator(IOS App)
      • Operation Report
  • PLUGINS
    • Plugins
      • Jenkins
      • Automated Test
      • Jira
      • Slack
      • TestRail
  • API's
    • Auth
      • Login
    • Account
      • Delete Customer API
      • Get All Roles
      • Get Customer ID by Company ID
      • Get Package Price by Package, Period, and Currency
      • Get User Details by Customer ID and User ID
      • Get Customer Information
      • Get Last Subscribed Product Packages of Customer
      • Update User
      • Get Billings by Customer ID
      • Get Address Types
      • Get Phone Types
      • Get Countries
      • Get Live Testing Parallel Limit
      • Update Live Testing Parallel Limit
      • Update Repository Information
      • Get Users of a Customer
      • Get All Products
    • Project
      • Get All Projects
      • Get All Projects By ProjectID
      • Get All Projects By Company ID
      • Get All Active Projects
      • Create Mobile Project
      • Create Service Project
      • Create WEB Project
      • Create Project From Template
      • Upload Mobile App
      • Delete Mobile App
      • Get Framework Summary
      • Enable Project
      • Disable Project
      • Get Jira Settings By ProjectID
      • Update Project For Jira Issue Settings
      • Get TestRail Settings By ProjectID
      • Update Project TestRail Settings
      • Get Xray Settings By ProjectID
      • Update Xray Settings By ProjectID
      • Get Xray Project Key Activation Information
      • Delete Project
      • Get Branch List By ProjectID
      • Get Plugins
    • Plan
      • Get All Test Plans
      • Get Plan By Plan ID
      • Get All Parent Plans
      • Get All Plans By Project ID
      • Get Active Test Plans
      • Run Test Plan
      • Force Run Test Plan
      • Quick Run Test Plan
      • Check Test Plan Running Status
      • Create Test Plan
      • Update Test Plan
      • Delete Test Plan
      • Get Band Width Types
      • Get Maximum Execution Times
      • Get Browsers
      • Get All Desktop Environments
      • Get All Mobile Environments
      • Get Total Plan Count by Filter
      • Get Files of a Test Plan
    • Reports
      • Get All Test Executions By Plan ID
      • Get Test Execution By ID
      • Download Execution Report by ID
      • Get Test Results of Execution by Scenario ID
      • Get Detailed Test Result
      • Filter Test Executions
      • Get Total Test Execution Runtime
      • Get Test Results Per Day
      • Graph Prioritization
      • Graph Prioritization Scenario
      • Get Plans By Scheduled Reports
      • Create Scheduled Report
      • Get All Scheduled Reports
      • Get Scheduled Report by ID
      • Update Scheduled Report
      • Get Scheduled Report History
      • Delete Scheduled Report
      • Get Public Report Link
      • Get Automated Apps for a Company
      • Get Remote Test Results Detailed
      • Get Test Result Detailed
    • Scenario
      • Get All Scenarios
      • Get All Group Scenarios
      • Get Scenario By ID
      • Get Test Scenarios By Filter
      • Get Scenarios by Execution ID
      • Get Last Failed Scenarios of a Test Plan
      • Create Scenario
      • Create Group Scenario
      • Update Scenario
      • Delete Scenario
      • Delete Multiple Scenarios
      • Get Total Scenario Count by Filter
      • Get File List (Source Tree)
      • Get BDD Steps
      • Read Test Method List
  • RELEASE NOTES
    • Release Notes
      • Testinium-Cloud 2.13.8 Release Notes
      • Testinium-Cloud 2.13.6 Release Notes
      • Testinium-Cloud 2.13.5 Release Notes
      • Testinium-Cloud 2.13.4 Release Notes
      • Testinium-Cloud 2.13.3 Release Notes
      • Testinium-Cloud 2.13.2 Release Notes
      • Testinium-Cloud 2.13.1 Release Notes
      • Testinium-Cloud 2.13.0 Release Notes
      • Testinium-Cloud 2.12.4 Release Notes
Powered by GitBook
On this page
  • Endpoint Information
  • Path Parameters
  • Request Body
  • Response
  • Error Codes
  • Example Request
  1. API's
  2. Project

Update Project For Jira Issue Settings

This endpoint updates the Jira issue settings associated with a specified project. The user must have access to the project and be part of the associated company. The Jira settings are updated based on the provided input model.


Endpoint Information

  • URL: https://testinium.io/Testinium.RestApi/api/projects/{projectId}/plugins/jira

  • Method: PUT

  • Authentication: Required (Bearer Token)


Path Parameters

Parameter
Type
Required
Description

projectId

Long

Yes

The ID of the project to update Jira issue settings.


Request Body

The request body should contain a DetailedJiraIssueModel with updated Jira issue settings for the project.

Request Body Structure

Field
Type
Required
Description

assignee

Object

Yes

The assignee information for the Jira project.

assignee.label

String

Yes

The label of the assignee.

assignee.value

String

Yes

The value (ID) of the assignee.

issue_tracker_fields

Object

Yes

The Jira fields to be configured.

issue_tracker_fields.fields

Array<Object>

Yes

Fields that are available for selection.

issue_tracker_fields.selected_fields

Array<Object>

Yes

Fields that are selected.

issue_type

Array<Object>

Yes

The issue types for Jira.

project

Array<Object>

Yes

The project settings to be configured.

Example Request Body:

{
  "assignee": {
    "label": "furkan kartal",
    "value": "62108f3a2fd2470071cc1e79"
  },
  "issue_tracker_fields": {
    "fields": [
      {
        "field_name": "description",
        "required": false,
        "predefined": false,
        "display_name": "Description",
        "field_type": 1,
        "schema_type": "string",
        "schema_system": "description",
        "component_type": "INPUT_TEXT_AREA"
      },
      {
        "field_name": "customfield_10021",
        "required": false,
        "predefined": false,
        "display_name": "Flagged",
        "field_type": 2,
        "schema_type": "array",
        "schema_items": "option",
        "component_type": "SELECT_MANY_MENU",
        "allowed_values": [
          {
            "label": "Impediment",
            "value": "10019"
          }
        ]
      },
      {
        "field_name": "labels",
        "required": false,
        "predefined": false,
        "display_name": "Labels",
        "field_type": 2,
        "schema_type": "array",
        "schema_system": "labels",
        "schema_items": "string",
        "component_type": "AUTO_COMPLETE_MANY"
      }
    ],
    "selected_fields": [
      {
        "field_name": "summary",
        "required": true,
        "predefined": false,
        "display_name": "Summary",
        "field_type": 1,
        "schema_type": "string",
        "schema_system": "summary",
        "component_type": "INPUT_TEXT"
      },
      {
        "field_name": "reporter",
        "required": true,
        "predefined": false,
        "display_name": "Reporter",
        "field_type": 1,
        "schema_type": "user",
        "schema_system": "reporter",
        "component_type": "AUTO_COMPLETE_SINGLE"
      }
    ]
  },
  "issue_type": [
    {
      "label": "Story",
      "selected": true,
      "value": "10001"
    },
    {
      "label": "Task",
      "selected": false,
      "value": "10002"
    },
    {
      "label": "Bug",
      "selected": false,
      "value": "10003"
    },
    {
      "label": "Epik",
      "selected": false,
      "value": "10004"
    }
  ],
  "project": [
    {
      "label": "BernaPO",
      "value": "BER",
      "selected": false
    },
    {
      "label": "Kartal",
      "value": "KAR",
      "selected": true
    },
    {
      "label": "SenaEroğlu",
      "value": "SEN",
      "selected": false
    }
  ]
}

Response

The response will contain the updated Jira issue settings for the project.

Example Response:

{
  "assignee": {
    "label": "furkan kartal",
    "value": "62108f3a2fd2470071cc1e79"
  },
  "issue_tracker_fields": {
    "fields": [
      {
        "field_name": "description",
        "required": false,
        "predefined": false,
        "display_name": "Description",
        "field_type": 1,
        "schema_type": "string",
        "schema_system": "description",
        "component_type": "INPUT_TEXT_AREA"
      },
      {
        "field_name": "customfield_10021",
        "required": false,
        "predefined": false,
        "display_name": "Flagged",
        "field_type": 2,
        "schema_type": "array",
        "schema_items": "option",
        "component_type": "SELECT_MANY_MENU",
        "allowed_values": [
          {
            "label": "Impediment",
            "value": "10019"
          }
        ]
      },
      {
        "field_name": "labels",
        "required": false,
        "predefined": false,
        "display_name": "Labels",
        "field_type": 2,
        "schema_type": "array",
        "schema_system": "labels",
        "schema_items": "string",
        "component_type": "AUTO_COMPLETE_MANY"
      }
    ],
    "selected_fields": [
      {
        "field_name": "summary",
        "required": true,
        "predefined": false,
        "display_name": "Summary",
        "field_type": 1,
        "schema_type": "string",
        "schema_system": "summary",
        "component_type": "INPUT_TEXT"
      },
      {
        "field_name": "reporter",
        "required": true,
        "predefined": false,
        "display_name": "Reporter",
        "field_type": 1,
        "schema_type": "user",
        "schema_system": "reporter",
        "component_type": "AUTO_COMPLETE_SINGLE"
      }
    ]
  },
  "issue_type": [
    {
      "label": "Story",
      "selected": true,
      "value": "10001"
    },
    {
      "label": "Task",
      "selected": false,
      "value": "10002"
    },
    {
      "label": "Bug",
      "selected": false,
      "value": "10003"
    },
    {
      "label": "Epik",
      "selected": false,
      "value": "10004"
    }
  ],
  "project": [
    {
      "label": "BernaPO",
      "value": "BER",
      "selected": false
    },
    {
      "label": "Kartal",
      "value": "KAR",
      "selected": true
    },
    {
      "label": "SenaEroğlu",
      "value": "SEN",
      "selected": false
    }
  ]
}

Error Codes

HTTP Code
Error Code
Description

400

INVALID_PROJECT_ID

The provided project ID is invalid.

403

ACCESS_DENIED

The user does not have access to the specified project.

404

PROJECT_NOT_FOUND

The project with the specified ID does not exist.

500

INTERNAL_SERVER_ERROR

An unexpected error occurred while updating Jira settings.


Example Request

cURL Example

curl --location --request PUT "https://testinium.io/Testinium.RestApi/api/projects/{projectId}/plugins/jira" \
--header 'Authorization: Bearer <your_access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "assignee": {
    "label": "furkan kartal",
    "value": "62108f3a2fd2470071cc1e79"
  },
  "issue_tracker_fields": {
    "fields": [
      {
        "field_name": "description",
        "required": false,
        "predefined": false,
        "display_name": "Description",
        "field_type": 1,
        "schema_type": "string",
        "schema_system": "description",
        "component_type": "INPUT_TEXT_AREA"
      },
      {
        "field_name": "customfield_10021",
        "required": false,
        "predefined": false,
        "display_name": "Flagged",
        "field_type": 2,
        "schema_type": "array",
        "schema_items": "option",
        "component_type": "SELECT_MANY_MENU",
        "allowed_values": [
          {
            "label": "Impediment",
            "value": "10019"
          }
        ]
      },
      {
        "field_name": "labels",
        "required": false,
        "predefined": false,
        "display_name": "Labels",
        "field_type": 2,
        "schema_type": "array",
        "schema_system": "labels",
        "schema_items": "string",
        "component_type": "AUTO_COMPLETE_MANY"
      }
    ],
    "selected_fields": [
      {
        "field_name": "summary",
        "required": true,
        "predefined": false,
        "display_name": "Summary",
        "field_type": 1,
        "schema_type": "string",
        "schema_system": "summary",
        "component_type": "INPUT_TEXT"
      },
      {
        "field_name": "reporter",
        "required": true,
        "predefined": false,
        "display_name": "Reporter",
        "field_type": 1,
        "schema_type": "user",
        "schema_system": "reporter",
        "component_type": "AUTO_COMPLETE_SINGLE"
      }
    ]
  },
  "issue_type": [
    {
      "label": "Story",
      "selected": true,
      "value": "10001"
    },
    {
      "label": "Task",
      "selected": false,
      "value": "10002"
    },
    {
      "label": "Bug",
      "selected": false,
      "value": "10003"
    },
    {
      "label": "Epik",
      "selected": false,
      "value": "10004"
    }
  ],
  "project": [
    {
      "label": "BernaPO",
      "value": "BER",
      "selected": false
    },
    {
      "label": "Kartal",
      "value": "KAR",
      "selected": true
    },
    {
      "label": "SenaEroğlu",
      "value": "SEN",
      "selected": false
    }
  ]
}'
PreviousGet Jira Settings By ProjectIDNextGet TestRail Settings By ProjectID

Last updated 3 months ago