Skip to content

Marketplace Offering Usage Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-offering-usage-policies/ List Marketplace Offering Usage Policies
GET /api/marketplace-offering-usage-policies/{uuid}/ Retrieve
POST /api/marketplace-offering-usage-policies/ Create
PUT /api/marketplace-offering-usage-policies/{uuid}/ Update
PATCH /api/marketplace-offering-usage-policies/{uuid}/ Partial Update
DELETE /api/marketplace-offering-usage-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-offering-usage-policies/actions/ Actions

Core CRUD

List Marketplace Offering Usage Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-usage-policies/ \
  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.marketplace_offering_usage_policies import marketplace_offering_usage_policies_list # (1)

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

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

try {
  const response = await marketplaceOfferingUsagePoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  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.
scope string
scope_uuid string (uuid)

200 -

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

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-usage-policies/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.marketplace_offering_usage_policies import marketplace_offering_usage_policies_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsagePoliciesRetrieve({
  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
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/marketplace-offering-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  organization_groups:='[]' \
  component_limits_set:='[]'

 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.offering_usage_policy_request import OfferingUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_create # (2)

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

body_data = OfferingUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    organization_groups=[],
    component_limits_set=[]
)
response = marketplace_offering_usage_policies_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingUsagePoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "organization_groups": [],
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s ✓
component_limits_set array of objects ✓
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/marketplace-offering-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  organization_groups:='[]' \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_usage_policy_request import OfferingUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_update # (2)

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

body_data = OfferingUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    organization_groups=[],
    component_limits_set=[]
)
response = marketplace_offering_usage_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingUsagePoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "organization_groups": [],
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s ✓
component_limits_set array of objects ✓
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-usage-policies/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_offering_usage_policy_request import PatchedOfferingUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_partial_update # (2)

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

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

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

try {
  const response = await marketplaceOfferingUsagePoliciesPartialUpdate({
  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
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-usage-policies/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.marketplace_offering_usage_policies import marketplace_offering_usage_policies_destroy # (1)

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

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

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

Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-usage-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_actions_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsagePoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string