Support
Operations Summary
Core CRUD
List Support Settings Atlassian
Retrieve
Create
Update
Partial Update
Delete
Other Actions
Get current Atlassian settings (masked secrets)
Get current Atlassian settings (masked secrets).
Discover available custom fields
Discover available custom fields.
Discover available priorities
Discover available priorities.
Discover available Service Desk projects
Discover available Service Desk projects.
Discover request types for a selected project
Discover request types for a selected project.
| http \
POST \
https://api.example.com/api/support/settings/atlassian/discover_request_types/ \
Authorization:"Token YOUR_API_TOKEN" \
api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
auth_method=null \
project_id="string-value"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_request_types_request_request import DiscoverRequestTypesRequestRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_discover_request_types # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = DiscoverRequestTypesRequestRequest(
api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
auth_method=null,
project_id="string-value"
)
response = support_settings_atlassian_discover_request_types.sync(
client=client,
body=body_data
)
for item in response:
print(item)
|
- Model Source:
DiscoverRequestTypesRequestRequest
- API Source:
support_settings_atlassian_discover_request_types
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 | import { supportSettingsAtlassianDiscoverRequestTypes } from 'waldur-js-client';
try {
const response = await supportSettingsAtlassianDiscoverRequestTypes({
auth: "Token YOUR_API_TOKEN",
body: {
"api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
"auth_method": null,
"project_id": "string-value"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Description |
page |
integer |
A page number within the paginated result set. |
page_size |
integer |
Number of results to return per page. |
| Field |
Type |
Required |
Description |
api_url |
string (uri) |
✓ |
Atlassian API URL (e.g., https://your-domain.atlassian.net) |
auth_method |
any |
✓ |
Authentication method to use |
email |
string (email) |
|
|
token |
string |
|
Constraints: write-only |
personal_access_token |
string |
|
Constraints: write-only |
username |
string |
|
|
password |
string |
|
Constraints: write-only |
verify_ssl |
boolean |
|
Constraints: default: True |
project_id |
string |
✓ |
Service Desk project ID or key |
200 -
The response body is an array of objects, where each object has the following structure:
| Field |
Type |
id |
string |
name |
string |
description |
string |
issue_type_id |
string |
Generate preview of settings to be saved
Generate preview of settings to be saved.
| http \
POST \
https://api.example.com/api/support/settings/atlassian/preview_settings/ \
Authorization:"Token YOUR_API_TOKEN" \
api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
auth_method="api_token" \
project_id="string-value"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.atlassian_settings_preview_request import AtlassianSettingsPreviewRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_preview_settings # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = AtlassianSettingsPreviewRequest(
api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
auth_method="api_token",
project_id="string-value"
)
response = support_settings_atlassian_preview_settings.sync(
client=client,
body=body_data
)
print(response)
|
- Model Source:
AtlassianSettingsPreviewRequest
- API Source:
support_settings_atlassian_preview_settings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 | import { supportSettingsAtlassianPreviewSettings } from 'waldur-js-client';
try {
const response = await supportSettingsAtlassianPreviewSettings({
auth: "Token YOUR_API_TOKEN",
body: {
"api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
"auth_method": "api_token",
"project_id": "string-value"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Field |
Type |
Required |
Description |
api_url |
string (uri) |
✓ |
|
auth_method |
string |
✓ |
Enum: api_token, personal_access_token, basic |
email |
string (email) |
|
|
token |
string |
|
Constraints: write-only |
personal_access_token |
string |
|
Constraints: write-only |
username |
string |
|
|
password |
string |
|
Constraints: write-only |
verify_ssl |
boolean |
|
Constraints: default: True |
project_id |
string |
✓ |
|
issue_types |
array of strings |
|
|
support_type_mapping |
object (free-form) |
|
Mapping from frontend types to backend request types |
reporter_field |
string |
|
|
impact_field |
string |
|
|
organisation_field |
string |
|
|
project_field |
string |
|
|
affected_resource_field |
string |
|
|
caller_field |
string |
|
|
template_field |
string |
|
|
sla_field |
string |
|
|
resolution_sla_field |
string |
|
|
satisfaction_field |
string |
|
|
request_feedback_field |
string |
|
|
waldur_backend_id_field |
string |
|
|
default_offering_issue_type |
string |
|
Default issue type for marketplace request-based orders |
use_old_api |
boolean |
|
Constraints: default: False |
custom_field_mapping_enabled |
boolean |
|
Constraints: default: True |
Save selected settings to constance
Save selected settings to constance.
| http \
POST \
https://api.example.com/api/support/settings/atlassian/save_settings/ \
Authorization:"Token YOUR_API_TOKEN" \
api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
auth_method="api_token" \
project_id="string-value" \
confirm_save=true
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.atlassian_settings_save_request import AtlassianSettingsSaveRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_save_settings # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = AtlassianSettingsSaveRequest(
api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
auth_method="api_token",
project_id="string-value",
confirm_save=true
)
response = support_settings_atlassian_save_settings.sync(
client=client,
body=body_data
)
print(response)
|
- Model Source:
AtlassianSettingsSaveRequest
- API Source:
support_settings_atlassian_save_settings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 | import { supportSettingsAtlassianSaveSettings } from 'waldur-js-client';
try {
const response = await supportSettingsAtlassianSaveSettings({
auth: "Token YOUR_API_TOKEN",
body: {
"api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
"auth_method": "api_token",
"project_id": "string-value",
"confirm_save": true
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Field |
Type |
Required |
Description |
api_url |
string (uri) |
✓ |
|
auth_method |
string |
✓ |
Enum: api_token, personal_access_token, basic |
email |
string (email) |
|
|
token |
string |
|
Constraints: write-only |
personal_access_token |
string |
|
Constraints: write-only |
username |
string |
|
|
password |
string |
|
Constraints: write-only |
verify_ssl |
boolean |
|
Constraints: default: True |
project_id |
string |
✓ |
|
issue_types |
array of strings |
|
|
support_type_mapping |
object (free-form) |
|
Mapping from frontend types to backend request types |
reporter_field |
string |
|
|
impact_field |
string |
|
|
organisation_field |
string |
|
|
project_field |
string |
|
|
affected_resource_field |
string |
|
|
caller_field |
string |
|
|
template_field |
string |
|
|
sla_field |
string |
|
|
resolution_sla_field |
string |
|
|
satisfaction_field |
string |
|
|
request_feedback_field |
string |
|
|
waldur_backend_id_field |
string |
|
|
default_offering_issue_type |
string |
|
Default issue type for marketplace request-based orders |
use_old_api |
boolean |
|
Constraints: default: False |
custom_field_mapping_enabled |
boolean |
|
Constraints: default: True |
confirm_save |
boolean |
✓ |
Must be True to confirm saving settings |
Validate Atlassian credentials without saving them
Validate Atlassian credentials without saving them.