Skip to content

Provider Canned Responses

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/provider-canned-responses/ List Provider Canned Responses
GET /api/provider-canned-responses/{uuid}/ Retrieve
POST /api/provider-canned-responses/ Create
PUT /api/provider-canned-responses/{uuid}/ Update
PATCH /api/provider-canned-responses/{uuid}/ Partial Update
DELETE /api/provider-canned-responses/{uuid}/ Delete
Other Actions
POST /api/provider-canned-responses/{uuid}/render/ Render a canned response with context variables

Core CRUD

List Provider Canned Responses

1
2
3
4
http \
  GET \
  https://api.example.com/api/provider-canned-responses/ \
  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.provider_canned_responses import provider_canned_responses_list # (1)

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

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

try {
  const response = await providerCannedResponsesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
category string
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
provider_helpdesk_uuid string (uuid)

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)
name string
provider_helpdesk string (uuid)
text string Template text. Supports Django template syntax.
category string
usage_count integer
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/provider-canned-responses/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.provider_canned_responses import provider_canned_responses_retrieve # (1)

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

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

try {
  const response = await providerCannedResponsesRetrieve({
  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)
name string
provider_helpdesk string (uuid)
text string Template text. Supports Django template syntax.
category string
usage_count integer
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/provider-canned-responses/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-provider-canned-response" \
  provider_helpdesk="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  text="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.provider_canned_response_request import ProviderCannedResponseRequest # (1)
from waldur_api_client.api.provider_canned_responses import provider_canned_responses_create # (2)

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

body_data = ProviderCannedResponseRequest(
    name="my-awesome-provider-canned-response",
    provider_helpdesk="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    text="string-value"
)
response = provider_canned_responses_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await providerCannedResponsesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-provider-canned-response",
    "provider_helpdesk": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "text": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
provider_helpdesk string (uuid) ✓
text string ✓ Template text. Supports Django template syntax.
category string

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
provider_helpdesk string (uuid)
text string Template text. Supports Django template syntax.
category string
usage_count integer
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/provider-canned-responses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-provider-canned-response" \
  provider_helpdesk="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  text="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.provider_canned_response_request import ProviderCannedResponseRequest # (1)
from waldur_api_client.api.provider_canned_responses import provider_canned_responses_update # (2)

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

body_data = ProviderCannedResponseRequest(
    name="my-awesome-provider-canned-response",
    provider_helpdesk="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    text="string-value"
)
response = provider_canned_responses_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await providerCannedResponsesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-provider-canned-response",
    "provider_helpdesk": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "text": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
provider_helpdesk string (uuid) ✓
text string ✓ Template text. Supports Django template syntax.
category string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
provider_helpdesk string (uuid)
text string Template text. Supports Django template syntax.
category string
usage_count integer
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/provider-canned-responses/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_provider_canned_response_request import PatchedProviderCannedResponseRequest # (1)
from waldur_api_client.api.provider_canned_responses import provider_canned_responses_partial_update # (2)

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

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

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

try {
  const response = await providerCannedResponsesPartialUpdate({
  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
name string
provider_helpdesk string (uuid)
text string Template text. Supports Django template syntax.
category string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
provider_helpdesk string (uuid)
text string Template text. Supports Django template syntax.
category string
usage_count integer
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/provider-canned-responses/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.provider_canned_responses import provider_canned_responses_destroy # (1)

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

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

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

Render a canned response with context variables

1
2
3
4
http \
  POST \
  https://api.example.com/api/provider-canned-responses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/render/ \
  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.canned_response_render_request import CannedResponseRenderRequest # (1)
from waldur_api_client.api.provider_canned_responses import provider_canned_responses_render # (2)

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

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

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

try {
  const response = await providerCannedResponsesRender({
  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
context object (free-form)

200 -

Field Type
rendered_text string