Skip to content

Marketplace Offering Roles

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-roles/ List Marketplace Offering Roles
GET /api/marketplace-offering-roles/{uuid}/ Retrieve
POST /api/marketplace-offering-roles/ Create
PUT /api/marketplace-offering-roles/{uuid}/ Update
PATCH /api/marketplace-offering-roles/{uuid}/ Partial Update
DELETE /api/marketplace-offering-roles/{uuid}/ Delete

List Marketplace Offering Roles

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

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

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

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

200 -

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

Field Type
uuid string (uuid)
name string
description string
content_type string
offering_uuid string
offering_name string
is_active boolean
permissions array of strings

Retrieve

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

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

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

try {
  const response = await marketplaceOfferingRolesRetrieve({
  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
uuid string (uuid)
name string
description string
content_type string
offering_uuid string
offering_name string
is_active boolean
permissions array of strings

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-offering-roles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-role"

 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.offering_role_request import OfferingRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_roles import marketplace_offering_roles_create # (2)

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

body_data = OfferingRoleRequest(
    name="my-awesome-marketplace-offering-role"
)
response = marketplace_offering_roles_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingRolesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-offering-role"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
content_type_input any Scope on create: 'resource' or 'resource_project'.
Constraints: write-only
offering string (uuid) Offering UUID — pin role to this single offering.
Constraints: write-only

201 -

Field Type
uuid string (uuid)
name string
description string
content_type string
offering_uuid string
offering_name string
is_active boolean
permissions array of strings

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-offering-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-role"

 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.offering_role_request import OfferingRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_roles import marketplace_offering_roles_update # (2)

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

body_data = OfferingRoleRequest(
    name="my-awesome-marketplace-offering-role"
)
response = marketplace_offering_roles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingRolesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-offering-role"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
content_type_input any Scope on create: 'resource' or 'resource_project'.
Constraints: write-only
offering string (uuid) Offering UUID — pin role to this single offering.
Constraints: write-only

200 -

Field Type
uuid string (uuid)
name string
description string
content_type string
offering_uuid string
offering_name string
is_active boolean
permissions array of strings

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-roles/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_role_request import PatchedOfferingRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_roles import marketplace_offering_roles_partial_update # (2)

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

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

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

try {
  const response = await marketplaceOfferingRolesPartialUpdate({
  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
description string
content_type_input any Scope on create: 'resource' or 'resource_project'.
Constraints: write-only
offering string (uuid) Offering UUID — pin role to this single offering.
Constraints: write-only

200 -

Field Type
uuid string (uuid)
name string
description string
content_type string
offering_uuid string
offering_name string
is_active boolean
permissions array of strings

Delete

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

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

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

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