1. Home
  2. Docs
  3. API Documentation
  4. Integration
  5. ChangeJira

ChangeJira

Route: https://api.cytrix.io/ChangeJira

Use this function to associate an existing scan to a Jira Project.

Roles Required: Admin. Users can attach only Scans they have created.

Request Syntax

{
"apiKey": "String",
"projectKey": "String"
,
"token": "String"
}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your CYTRIX given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

projectKey

Parameter Usage and Options :

Navigate to the “Projects” section in your Jira account, from the table being displayed, take the “Key” value of the desired project. You can also use the “GetAllJira” function.

Type :

String

Is it Optional ? :

No.


Parameter Name :

token

Parameter Usage and Options :

The scan’s token.

How do I get it ? :

Simply use the “GetScan” or “GetAllScans” function, or navigate to a certain scan’s page, and in the address bar, you will notice “token=String”, use that String.

Type :

String

Is it Optional ? :

No.


Successful Response

 
{
    "Error": 0,
    "Function": "ChangeJira",
    "Data": "Successfully updated"
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.