Skip to content

Marketplace Screenshots

Operations Summary

Method Endpoint Description
GET /api/marketplace-screenshots/ List Marketplace Screenshots
GET /api/marketplace-screenshots/{uuid}/ Retrieve
POST /api/marketplace-screenshots/ Create
PUT /api/marketplace-screenshots/{uuid}/ Update
PATCH /api/marketplace-screenshots/{uuid}/ Partial Update
DELETE /api/marketplace-screenshots/{uuid}/ Delete

List Marketplace Screenshots

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-screenshots/ \
  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_screenshots import marketplace_screenshots_list # (1)

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

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

try {
  const response = await marketplaceScreenshotsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o array Ordering
offering string
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

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

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-screenshots/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_screenshots import marketplace_screenshots_retrieve # (1)

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

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

try {
  const response = await marketplaceScreenshotsRetrieve({
  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)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-screenshots/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-screenshot" \
  image="string-value" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.screenshot_request import ScreenshotRequest # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_create # (2)

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

body_data = ScreenshotRequest(
    name="my-awesome-marketplace-screenshot",
    image="string-value",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_screenshots_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceScreenshotsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-screenshot",
    "image": "string-value",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
image string (binary) ✓
offering string (uri) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-screenshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-screenshot" \
  image="string-value" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.screenshot_request import ScreenshotRequest # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_update # (2)

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

body_data = ScreenshotRequest(
    name="my-awesome-marketplace-screenshot",
    image="string-value",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_screenshots_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceScreenshotsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-screenshot",
    "image": "string-value",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
image string (binary) ✓
offering string (uri) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-screenshots/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_screenshot_request import PatchedScreenshotRequest # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_partial_update # (2)

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

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

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

try {
  const response = await marketplaceScreenshotsPartialUpdate({
  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
name string
description string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-screenshots/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_screenshots import marketplace_screenshots_destroy # (1)

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

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

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