Skip to content

Support Comments

Operations Summary

Method Endpoint Description
GET /api/support-comments/ List Support Comments
GET /api/support-comments/{uuid}/ Retrieve
PUT /api/support-comments/{uuid}/ Update
PATCH /api/support-comments/{uuid}/ Partial Update
DELETE /api/support-comments/{uuid}/ Delete

List Support Comments

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-comments/ \
  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_comments import support_comments_list # (1)

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

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

try {
  const response = await supportCommentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
author_name string
author_user string
description string
is_public boolean
issue string
issue_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
remote_id_is_set boolean Remote ID is set.

200 -

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

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

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-comments/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_comments import support_comments_retrieve # (1)

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

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

try {
  const response = await supportCommentsRetrieve({
  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
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

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/support-comments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  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_comments import support_comments_update # (2)

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

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

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

try {
  const response = await supportCommentsUpdate({
  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

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-comments/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_comment_request import PatchedCommentRequest # (1)
from waldur_api_client.api.support_comments import support_comments_partial_update # (2)

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

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

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

try {
  const response = await supportCommentsPartialUpdate({
  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 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

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-comments/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_comments import support_comments_destroy # (1)

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

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

try {
  const response = await supportCommentsDestroy({
  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