Marketplace Category Help Articles

Operations Summary

Method	Endpoint	Description
GET	/api/marketplace-category-help-articles/	List Marketplace Category Help Articles
GET	/api/marketplace-category-help-articles/{id}/	Retrieve
POST	/api/marketplace-category-help-articles/	Create
PUT	/api/marketplace-category-help-articles/{id}/	Update
PATCH	/api/marketplace-category-help-articles/{id}/	Partial Update
DELETE	/api/marketplace-category-help-articles/{id}/	Delete

---

List Marketplace Category Help Articles

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-category-help-articles/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_list # (1)

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

for item in response:
    print(item)

1. API Source: marketplace_category_help_articles_list

import { marketplaceCategoryHelpArticlesList } from 'waldur-js-client';

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

200 -

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

Field	Type
title	string
url	string (uri)
categories	array of objects
categories.url	string (uri)
categories.uuid	string (uuid)
categories.title	string

---

Retrieve

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_retrieve # (1)

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

print(response)

1. API Source: marketplace_category_help_articles_retrieve

import { marketplaceCategoryHelpArticlesRetrieve } from 'waldur-js-client';

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

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this category help article.

200 -

Field	Type
title	string
url	string (uri)
categories	array of objects
categories.url	string (uri)
categories.uuid	string (uuid)
categories.title	string

---

Create

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/marketplace-category-help-articles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  categories:='[]'

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_help_articles_request import CategoryHelpArticlesRequest # (1)
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_create # (2)

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

body_data = CategoryHelpArticlesRequest(
    url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    categories=[]
)
response = marketplace_category_help_articles_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CategoryHelpArticlesRequest
2. API Source: marketplace_category_help_articles_create

import { marketplaceCategoryHelpArticlesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "url": "https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "categories": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required
title	string
url	string (uri)	✓
categories	array of objects	✓
categories.title	string	✓

201 -

Field	Type
title	string
url	string (uri)
categories	array of objects
categories.url	string (uri)
categories.uuid	string (uuid)
categories.title	string

---

Update

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  PUT \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  categories:='[]'

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_help_articles_request import CategoryHelpArticlesRequest # (1)
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_update # (2)

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

body_data = CategoryHelpArticlesRequest(
    url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    categories=[]
)
response = marketplace_category_help_articles_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)

1. Model Source: CategoryHelpArticlesRequest
2. API Source: marketplace_category_help_articles_update

import { marketplaceCategoryHelpArticlesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  },
  body: {
    "url": "https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "categories": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this category help article.

Field	Type	Required
title	string
url	string (uri)	✓
categories	array of objects	✓
categories.title	string	✓

200 -

Field	Type
title	string
url	string (uri)
categories	array of objects
categories.url	string (uri)
categories.uuid	string (uuid)
categories.title	string

---

Partial Update

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PATCH \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_category_help_articles_request import PatchedCategoryHelpArticlesRequest # (1)
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_partial_update # (2)

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

body_data = PatchedCategoryHelpArticlesRequest()
response = marketplace_category_help_articles_partial_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)

1. Model Source: PatchedCategoryHelpArticlesRequest
2. API Source: marketplace_category_help_articles_partial_update

import { marketplaceCategoryHelpArticlesPartialUpdate } from 'waldur-js-client';

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

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this category help article.

Field	Type	Required
title	string
url	string (uri)
categories	array of objects
categories.title	string	✓

200 -

Field	Type
title	string
url	string (uri)
categories	array of objects
categories.url	string (uri)
categories.uuid	string (uuid)
categories.title	string

---

Delete

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_destroy # (1)

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

print(response)

1. API Source: marketplace_category_help_articles_destroy

import { marketplaceCategoryHelpArticlesDestroy } from 'waldur-js-client';

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

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this category help article.

204 - No response body

---