Skip to content

Backend Resource Requests

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/backend-resource-requests/ List backend resource requests
GET /api/backend-resource-requests/{uuid}/ Retrieve a backend resource request
POST /api/backend-resource-requests/ Create a backend resource request
Other Actions
POST /api/backend-resource-requests/{uuid}/set_done/ Mark a request as done
POST /api/backend-resource-requests/{uuid}/set_erred/ Mark a request as erred
POST /api/backend-resource-requests/{uuid}/start_processing/ Start processing a request

Core CRUD

List backend resource requests

Returns a paginated list of requests for backend resources.

1
2
3
4
http \
  GET \
  https://api.example.com/api/backend-resource-requests/ \
  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.backend_resource_requests import backend_resource_requests_list # (1)

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

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

try {
  const response = await backendResourceRequestsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
finished string (date-time) Modified after
modified string (date-time) Modified after
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
started string (date-time) Created after
state array Backend resource request state

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)
created string (date-time)
modified string (date-time)
started string (date-time) Time when request processing started
finished string (date-time) Time when request processing finished
state any
offering string (uuid)
offering_name string
offering_url string (uri)
error_message string
error_traceback string

Retrieve a backend resource request

Returns the details of a specific backend resource request.

1
2
3
4
http \
  GET \
  https://api.example.com/api/backend-resource-requests/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.backend_resource_requests import backend_resource_requests_retrieve # (1)

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

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

try {
  const response = await backendResourceRequestsRetrieve({
  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)
created string (date-time)
modified string (date-time)
started string (date-time) Time when request processing started
finished string (date-time) Time when request processing finished
state any
offering string (uuid)
offering_name string
offering_url string (uri)
error_message string
error_traceback string

Create a backend resource request

Creates a new request to fetch a list of importable resources from a backend. This is typically used by staff to trigger a site agent to report available resources.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/backend-resource-requests/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_request import BackendResourceReqRequest # (1)
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_create # (2)

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

body_data = BackendResourceReqRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = backend_resource_requests_create.sync(
    client=client,
    body=body_data
)

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

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

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
started string (date-time) Time when request processing started
finished string (date-time) Time when request processing finished
state any
offering string (uuid)
offering_name string
offering_url string (uri)
error_message string
error_traceback string

Other Actions

Mark a request as done

Transitions the request state from 'Processing' to 'Done'. This is used by a site agent to signal that it has successfully reported all available resources.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_done/ \
  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.backend_resource_requests import backend_resource_requests_set_done # (1)

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

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

try {
  const response = await backendResourceRequestsSetDone({
  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
status string

Mark a request as erred

Transitions the request state to 'Erred'. This is used by a site agent to report a failure during the resource fetching process. An error message and traceback should be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  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.backend_resource_request_set_erred_request import BackendResourceRequestSetErredRequest # (1)
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_set_erred # (2)

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

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

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

try {
  const response = await backendResourceRequestsSetErred({
  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
error_message string
error_traceback string

200 -

Field Type
status string

Start processing a request

Transitions the request state from 'Sent' to 'Processing'. This is used by a site agent to acknowledge that it has started fetching the resource list.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start_processing/ \
  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.backend_resource_requests import backend_resource_requests_start_processing # (1)

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

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

try {
  const response = await backendResourceRequestsStartProcessing({
  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
status string