Skip to content

Support Issues

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/support-issues/ List Support Issues
GET /api/support-issues/{uuid}/ Retrieve
POST /api/support-issues/ Create
PUT /api/support-issues/{uuid}/ Update
PATCH /api/support-issues/{uuid}/ Partial Update
DELETE /api/support-issues/{uuid}/ Delete
Other Actions
POST /api/support-issues/{uuid}/comment/ Comment
POST /api/support-issues/{uuid}/sync/ Sync

Core CRUD

List Support Issues

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-issues/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issues import support_issues_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issues_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_issues_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportIssuesList } from 'waldur-js-client';

try {
  const response = await supportIssuesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
assignee string
assignee_name string
caller string
caller_full_name string Caller full name contains
customer string
customer_uuid string (uuid)
key string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string
project_uuid string (uuid)
query string Summary or key contains
remote_id string
reporter string
reporter_name string
resolution_year_month string
resource_external_ip string Resource external IP
resource_internal_ip string Resource internal IP
resource_uuid string (uuid) Resource UUID
status string
summary string
type string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issues import support_issues_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issues_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_issues_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssuesRetrieve } from 'waldur-js-client';

try {
  const response = await supportIssuesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-issues/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  summary="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_request import IssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueRequest(
    type="string-value",
    summary="string-value"
)
response = support_issues_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueRequest
  2. API Source: support_issues_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportIssuesCreate } from 'waldur-js-client';

try {
  const response = await supportIssuesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "type": "string-value",
    "summary": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
type string ✓
remote_id string
summary string ✓
description string
priority string
caller string (uri)
assignee string (uri)
customer string (uri)
project string (uri)
resource string
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False
template string (uri)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  summary="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.issue_request import IssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueRequest(
    type="string-value",
    summary="string-value"
)
response = support_issues_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueRequest
  2. API Source: support_issues_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportIssuesUpdate } from 'waldur-js-client';

try {
  const response = await supportIssuesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "type": "string-value",
    "summary": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
type string ✓
remote_id string
summary string ✓
description string
priority string
caller string (uri)
assignee string (uri)
customer string (uri)
project string (uri)
resource string
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False
template string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_issue_request import PatchedIssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedIssueRequest()
response = support_issues_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedIssueRequest
  2. API Source: support_issues_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssuesPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportIssuesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
summary string
description string
assignee string (uri)
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issues import support_issues_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issues_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_issues_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssuesDestroy } from 'waldur-js-client';

try {
  const response = await supportIssuesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Comment

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/comment/ \
  Authorization:"Token YOUR_API_TOKEN" \
  description="A sample description."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.comment_request import CommentRequest # (1)
from waldur_api_client.api.support_issues import support_issues_comment # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CommentRequest(
    description="A sample description."
)
response = support_issues_comment.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CommentRequest
  2. API Source: support_issues_comment
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportIssuesComment } from 'waldur-js-client';

try {
  const response = await supportIssuesComment({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "description": "A sample description."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string ✓
is_public boolean

200 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
description string
is_public boolean
author_name string
author_uuid string (uuid)
author_user string (uri)
author_email string (email)
backend_id string
remote_id string
created string (date-time)
update_is_available boolean
destroy_is_available boolean

Sync

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sync/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  summary="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.issue_request import IssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_sync # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueRequest(
    type="string-value",
    summary="string-value"
)
response = support_issues_sync.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueRequest
  2. API Source: support_issues_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportIssuesSync } from 'waldur-js-client';

try {
  const response = await supportIssuesSync({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "type": "string-value",
    "summary": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
type string ✓
remote_id string
summary string ✓
description string
priority string
caller string (uri)
assignee string (uri)
customer string (uri)
project string (uri)
resource string
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False
template string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean