Skip to content

Latest commit

 

History

History
3348 lines (2058 loc) · 114 KB

ExtrasApi.md

File metadata and controls

3348 lines (2058 loc) · 114 KB

\ExtrasApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
extras_config_contexts_bulk_delete DELETE /extras/config-contexts/
extras_config_contexts_bulk_partial_update PATCH /extras/config-contexts/
extras_config_contexts_bulk_update PUT /extras/config-contexts/
extras_config_contexts_create POST /extras/config-contexts/
extras_config_contexts_delete DELETE /extras/config-contexts/{id}/
extras_config_contexts_list GET /extras/config-contexts/
extras_config_contexts_partial_update PATCH /extras/config-contexts/{id}/
extras_config_contexts_read GET /extras/config-contexts/{id}/
extras_config_contexts_update PUT /extras/config-contexts/{id}/
extras_content_types_list GET /extras/content-types/
extras_content_types_read GET /extras/content-types/{id}/
extras_custom_fields_bulk_delete DELETE /extras/custom-fields/
extras_custom_fields_bulk_partial_update PATCH /extras/custom-fields/
extras_custom_fields_bulk_update PUT /extras/custom-fields/
extras_custom_fields_create POST /extras/custom-fields/
extras_custom_fields_delete DELETE /extras/custom-fields/{id}/
extras_custom_fields_list GET /extras/custom-fields/
extras_custom_fields_partial_update PATCH /extras/custom-fields/{id}/
extras_custom_fields_read GET /extras/custom-fields/{id}/
extras_custom_fields_update PUT /extras/custom-fields/{id}/
extras_custom_links_bulk_delete DELETE /extras/custom-links/
extras_custom_links_bulk_partial_update PATCH /extras/custom-links/
extras_custom_links_bulk_update PUT /extras/custom-links/
extras_custom_links_create POST /extras/custom-links/
extras_custom_links_delete DELETE /extras/custom-links/{id}/
extras_custom_links_list GET /extras/custom-links/
extras_custom_links_partial_update PATCH /extras/custom-links/{id}/
extras_custom_links_read GET /extras/custom-links/{id}/
extras_custom_links_update PUT /extras/custom-links/{id}/
extras_export_templates_bulk_delete DELETE /extras/export-templates/
extras_export_templates_bulk_partial_update PATCH /extras/export-templates/
extras_export_templates_bulk_update PUT /extras/export-templates/
extras_export_templates_create POST /extras/export-templates/
extras_export_templates_delete DELETE /extras/export-templates/{id}/
extras_export_templates_list GET /extras/export-templates/
extras_export_templates_partial_update PATCH /extras/export-templates/{id}/
extras_export_templates_read GET /extras/export-templates/{id}/
extras_export_templates_update PUT /extras/export-templates/{id}/
extras_image_attachments_bulk_delete DELETE /extras/image-attachments/
extras_image_attachments_bulk_partial_update PATCH /extras/image-attachments/
extras_image_attachments_bulk_update PUT /extras/image-attachments/
extras_image_attachments_create POST /extras/image-attachments/
extras_image_attachments_delete DELETE /extras/image-attachments/{id}/
extras_image_attachments_list GET /extras/image-attachments/
extras_image_attachments_partial_update PATCH /extras/image-attachments/{id}/
extras_image_attachments_read GET /extras/image-attachments/{id}/
extras_image_attachments_update PUT /extras/image-attachments/{id}/
extras_job_results_list GET /extras/job-results/
extras_job_results_read GET /extras/job-results/{id}/
extras_journal_entries_bulk_delete DELETE /extras/journal-entries/
extras_journal_entries_bulk_partial_update PATCH /extras/journal-entries/
extras_journal_entries_bulk_update PUT /extras/journal-entries/
extras_journal_entries_create POST /extras/journal-entries/
extras_journal_entries_delete DELETE /extras/journal-entries/{id}/
extras_journal_entries_list GET /extras/journal-entries/
extras_journal_entries_partial_update PATCH /extras/journal-entries/{id}/
extras_journal_entries_read GET /extras/journal-entries/{id}/
extras_journal_entries_update PUT /extras/journal-entries/{id}/
extras_object_changes_list GET /extras/object-changes/
extras_object_changes_read GET /extras/object-changes/{id}/
extras_reports_list GET /extras/reports/
extras_reports_read GET /extras/reports/{id}/
extras_reports_run POST /extras/reports/{id}/run/
extras_saved_filters_bulk_delete DELETE /extras/saved-filters/
extras_saved_filters_bulk_partial_update PATCH /extras/saved-filters/
extras_saved_filters_bulk_update PUT /extras/saved-filters/
extras_saved_filters_create POST /extras/saved-filters/
extras_saved_filters_delete DELETE /extras/saved-filters/{id}/
extras_saved_filters_list GET /extras/saved-filters/
extras_saved_filters_partial_update PATCH /extras/saved-filters/{id}/
extras_saved_filters_read GET /extras/saved-filters/{id}/
extras_saved_filters_update PUT /extras/saved-filters/{id}/
extras_scripts_list GET /extras/scripts/
extras_scripts_read GET /extras/scripts/{id}/
extras_tags_bulk_delete DELETE /extras/tags/
extras_tags_bulk_partial_update PATCH /extras/tags/
extras_tags_bulk_update PUT /extras/tags/
extras_tags_create POST /extras/tags/
extras_tags_delete DELETE /extras/tags/{id}/
extras_tags_list GET /extras/tags/
extras_tags_partial_update PATCH /extras/tags/{id}/
extras_tags_read GET /extras/tags/{id}/
extras_tags_update PUT /extras/tags/{id}/
extras_webhooks_bulk_delete DELETE /extras/webhooks/
extras_webhooks_bulk_partial_update PATCH /extras/webhooks/
extras_webhooks_bulk_update PUT /extras/webhooks/
extras_webhooks_create POST /extras/webhooks/
extras_webhooks_delete DELETE /extras/webhooks/{id}/
extras_webhooks_list GET /extras/webhooks/
extras_webhooks_partial_update PATCH /extras/webhooks/{id}/
extras_webhooks_read GET /extras/webhooks/{id}/
extras_webhooks_update PUT /extras/webhooks/{id}/

extras_config_contexts_bulk_delete

extras_config_contexts_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_bulk_partial_update

crate::models::ConfigContext extras_config_contexts_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableConfigContext [required]

Return type

crate::models::ConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_bulk_update

crate::models::ConfigContext extras_config_contexts_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableConfigContext [required]

Return type

crate::models::ConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_create

crate::models::ConfigContext extras_config_contexts_create(data)

Parameters

Name Type Description Required Notes
data WritableConfigContext [required]

Return type

crate::models::ConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_delete

extras_config_contexts_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this config context. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_list

crate::models::ExtrasConfigContextsList200Response extras_config_contexts_list(id, name, is_active, created, last_updated, q, region_id, region, site_group, site_group_id, site_id, site, location_id, location, device_type_id, role_id, role, platform_id, platform, cluster_type_id, cluster_type, cluster_group_id, cluster_group, cluster_id, tenant_group_id, tenant_group, tenant_id, tenant, tag_id, tag, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, region_id__n, region__n, site_group__n, site_group_id__n, site_id__n, site__n, location_id__n, location__n, device_type_id__n, role_id__n, role__n, platform_id__n, platform__n, cluster_type_id__n, cluster_type__n, cluster_group_id__n, cluster_group__n, cluster_id__n, tenant_group_id__n, tenant_group__n, tenant_id__n, tenant__n, tag_id__n, tag__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
is_active Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
region_id Option<String>
region Option<String>
site_group Option<String>
site_group_id Option<String>
site_id Option<String>
site Option<String>
location_id Option<String>
location Option<String>
device_type_id Option<String>
role_id Option<String>
role Option<String>
platform_id Option<String>
platform Option<String>
cluster_type_id Option<String>
cluster_type Option<String>
cluster_group_id Option<String>
cluster_group Option<String>
cluster_id Option<String>
tenant_group_id Option<String>
tenant_group Option<String>
tenant_id Option<String>
tenant Option<String>
tag_id Option<String>
tag Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
region_id__n Option<String>
region__n Option<String>
site_group__n Option<String>
site_group_id__n Option<String>
site_id__n Option<String>
site__n Option<String>
location_id__n Option<String>
location__n Option<String>
device_type_id__n Option<String>
role_id__n Option<String>
role__n Option<String>
platform_id__n Option<String>
platform__n Option<String>
cluster_type_id__n Option<String>
cluster_type__n Option<String>
cluster_group_id__n Option<String>
cluster_group__n Option<String>
cluster_id__n Option<String>
tenant_group_id__n Option<String>
tenant_group__n Option<String>
tenant_id__n Option<String>
tenant__n Option<String>
tag_id__n Option<String>
tag__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasConfigContextsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_partial_update

crate::models::ConfigContext extras_config_contexts_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this config context. [required]
data WritableConfigContext [required]

Return type

crate::models::ConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_read

crate::models::ConfigContext extras_config_contexts_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this config context. [required]

Return type

crate::models::ConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_config_contexts_update

crate::models::ConfigContext extras_config_contexts_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this config context. [required]
data WritableConfigContext [required]

Return type

crate::models::ConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_content_types_list

crate::models::ExtrasContentTypesList200Response extras_content_types_list(id, app_label, model, q, ordering, limit, offset)

Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.

Parameters

Name Type Description Required Notes
id Option<f32>
app_label Option<String>
model Option<String>
q Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasContentTypesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_content_types_read

crate::models::ContentType extras_content_types_read(id)

Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this content type. [required]

Return type

crate::models::ContentType

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_bulk_delete

extras_custom_fields_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_bulk_partial_update

crate::models::CustomField extras_custom_fields_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableCustomField [required]

Return type

crate::models::CustomField

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_bulk_update

crate::models::CustomField extras_custom_fields_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableCustomField [required]

Return type

crate::models::CustomField

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_create

crate::models::CustomField extras_custom_fields_create(data)

Parameters

Name Type Description Required Notes
data WritableCustomField [required]

Return type

crate::models::CustomField

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_delete

extras_custom_fields_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom field. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_list

crate::models::ExtrasCustomFieldsList200Response extras_custom_fields_list(id, content_types, name, group_name, required, search_weight, filter_logic, ui_visibility, weight, description, q, r#type, content_type_id, id__n, id__lte, id__lt, id__gte, id__gt, content_types__n, content_types__ic, content_types__nic, content_types__iew, content_types__niew, content_types__isw, content_types__nisw, content_types__ie, content_types__nie, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, group_name__n, group_name__ic, group_name__nic, group_name__iew, group_name__niew, group_name__isw, group_name__nisw, group_name__ie, group_name__nie, group_name__empty, search_weight__n, search_weight__lte, search_weight__lt, search_weight__gte, search_weight__gt, filter_logic__n, ui_visibility__n, weight__n, weight__lte, weight__lt, weight__gte, weight__gt, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, type__n, content_type_id__n, content_type_id__lte, content_type_id__lt, content_type_id__gte, content_type_id__gt, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
content_types Option<String>
name Option<String>
group_name Option<String>
required Option<String>
search_weight Option<String>
filter_logic Option<String>
ui_visibility Option<String>
weight Option<String>
description Option<String>
q Option<String>
r#type Option<String>
content_type_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
content_types__n Option<String>
content_types__ic Option<String>
content_types__nic Option<String>
content_types__iew Option<String>
content_types__niew Option<String>
content_types__isw Option<String>
content_types__nisw Option<String>
content_types__ie Option<String>
content_types__nie Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
group_name__n Option<String>
group_name__ic Option<String>
group_name__nic Option<String>
group_name__iew Option<String>
group_name__niew Option<String>
group_name__isw Option<String>
group_name__nisw Option<String>
group_name__ie Option<String>
group_name__nie Option<String>
group_name__empty Option<String>
search_weight__n Option<String>
search_weight__lte Option<String>
search_weight__lt Option<String>
search_weight__gte Option<String>
search_weight__gt Option<String>
filter_logic__n Option<String>
ui_visibility__n Option<String>
weight__n Option<String>
weight__lte Option<String>
weight__lt Option<String>
weight__gte Option<String>
weight__gt Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
type__n Option<String>
content_type_id__n Option<String>
content_type_id__lte Option<String>
content_type_id__lt Option<String>
content_type_id__gte Option<String>
content_type_id__gt Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasCustomFieldsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_partial_update

crate::models::CustomField extras_custom_fields_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom field. [required]
data WritableCustomField [required]

Return type

crate::models::CustomField

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_read

crate::models::CustomField extras_custom_fields_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom field. [required]

Return type

crate::models::CustomField

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_fields_update

crate::models::CustomField extras_custom_fields_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom field. [required]
data WritableCustomField [required]

Return type

crate::models::CustomField

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_bulk_delete

extras_custom_links_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_bulk_partial_update

crate::models::CustomLink extras_custom_links_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data CustomLink [required]

Return type

crate::models::CustomLink

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_bulk_update

crate::models::CustomLink extras_custom_links_bulk_update(data)

Parameters

Name Type Description Required Notes
data CustomLink [required]

Return type

crate::models::CustomLink

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_create

crate::models::CustomLink extras_custom_links_create(data)

Parameters

Name Type Description Required Notes
data CustomLink [required]

Return type

crate::models::CustomLink

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_delete

extras_custom_links_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom link. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_list

crate::models::ExtrasCustomLinksList200Response extras_custom_links_list(id, content_types, name, enabled, link_text, link_url, weight, group_name, new_window, q, content_type_id, id__n, id__lte, id__lt, id__gte, id__gt, content_types__n, content_types__ic, content_types__nic, content_types__iew, content_types__niew, content_types__isw, content_types__nisw, content_types__ie, content_types__nie, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, link_text__n, link_text__ic, link_text__nic, link_text__iew, link_text__niew, link_text__isw, link_text__nisw, link_text__ie, link_text__nie, link_url__n, link_url__ic, link_url__nic, link_url__iew, link_url__niew, link_url__isw, link_url__nisw, link_url__ie, link_url__nie, weight__n, weight__lte, weight__lt, weight__gte, weight__gt, group_name__n, group_name__ic, group_name__nic, group_name__iew, group_name__niew, group_name__isw, group_name__nisw, group_name__ie, group_name__nie, group_name__empty, content_type_id__n, content_type_id__lte, content_type_id__lt, content_type_id__gte, content_type_id__gt, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
content_types Option<String>
name Option<String>
enabled Option<String>
link_text Option<String>
link_url Option<String>
weight Option<String>
group_name Option<String>
new_window Option<String>
q Option<String>
content_type_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
content_types__n Option<String>
content_types__ic Option<String>
content_types__nic Option<String>
content_types__iew Option<String>
content_types__niew Option<String>
content_types__isw Option<String>
content_types__nisw Option<String>
content_types__ie Option<String>
content_types__nie Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
link_text__n Option<String>
link_text__ic Option<String>
link_text__nic Option<String>
link_text__iew Option<String>
link_text__niew Option<String>
link_text__isw Option<String>
link_text__nisw Option<String>
link_text__ie Option<String>
link_text__nie Option<String>
link_url__n Option<String>
link_url__ic Option<String>
link_url__nic Option<String>
link_url__iew Option<String>
link_url__niew Option<String>
link_url__isw Option<String>
link_url__nisw Option<String>
link_url__ie Option<String>
link_url__nie Option<String>
weight__n Option<String>
weight__lte Option<String>
weight__lt Option<String>
weight__gte Option<String>
weight__gt Option<String>
group_name__n Option<String>
group_name__ic Option<String>
group_name__nic Option<String>
group_name__iew Option<String>
group_name__niew Option<String>
group_name__isw Option<String>
group_name__nisw Option<String>
group_name__ie Option<String>
group_name__nie Option<String>
group_name__empty Option<String>
content_type_id__n Option<String>
content_type_id__lte Option<String>
content_type_id__lt Option<String>
content_type_id__gte Option<String>
content_type_id__gt Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasCustomLinksList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_partial_update

crate::models::CustomLink extras_custom_links_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom link. [required]
data CustomLink [required]

Return type

crate::models::CustomLink

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_read

crate::models::CustomLink extras_custom_links_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom link. [required]

Return type

crate::models::CustomLink

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_custom_links_update

crate::models::CustomLink extras_custom_links_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this custom link. [required]
data CustomLink [required]

Return type

crate::models::CustomLink

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_bulk_delete

extras_export_templates_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_bulk_partial_update

crate::models::ExportTemplate extras_export_templates_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data ExportTemplate [required]

Return type

crate::models::ExportTemplate

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_bulk_update

crate::models::ExportTemplate extras_export_templates_bulk_update(data)

Parameters

Name Type Description Required Notes
data ExportTemplate [required]

Return type

crate::models::ExportTemplate

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_create

crate::models::ExportTemplate extras_export_templates_create(data)

Parameters

Name Type Description Required Notes
data ExportTemplate [required]

Return type

crate::models::ExportTemplate

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_delete

extras_export_templates_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this export template. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_list

crate::models::ExtrasExportTemplatesList200Response extras_export_templates_list(id, content_types, name, description, q, content_type_id, id__n, id__lte, id__lt, id__gte, id__gt, content_types__n, content_types__ic, content_types__nic, content_types__iew, content_types__niew, content_types__isw, content_types__nisw, content_types__ie, content_types__nie, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, content_type_id__n, content_type_id__lte, content_type_id__lt, content_type_id__gte, content_type_id__gt, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
content_types Option<String>
name Option<String>
description Option<String>
q Option<String>
content_type_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
content_types__n Option<String>
content_types__ic Option<String>
content_types__nic Option<String>
content_types__iew Option<String>
content_types__niew Option<String>
content_types__isw Option<String>
content_types__nisw Option<String>
content_types__ie Option<String>
content_types__nie Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
content_type_id__n Option<String>
content_type_id__lte Option<String>
content_type_id__lt Option<String>
content_type_id__gte Option<String>
content_type_id__gt Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasExportTemplatesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_partial_update

crate::models::ExportTemplate extras_export_templates_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this export template. [required]
data ExportTemplate [required]

Return type

crate::models::ExportTemplate

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_read

crate::models::ExportTemplate extras_export_templates_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this export template. [required]

Return type

crate::models::ExportTemplate

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_export_templates_update

crate::models::ExportTemplate extras_export_templates_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this export template. [required]
data ExportTemplate [required]

Return type

crate::models::ExportTemplate

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_bulk_delete

extras_image_attachments_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_bulk_partial_update

crate::models::ImageAttachment extras_image_attachments_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data ImageAttachment [required]

Return type

crate::models::ImageAttachment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_bulk_update

crate::models::ImageAttachment extras_image_attachments_bulk_update(data)

Parameters

Name Type Description Required Notes
data ImageAttachment [required]

Return type

crate::models::ImageAttachment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_create

crate::models::ImageAttachment extras_image_attachments_create(data)

Parameters

Name Type Description Required Notes
data ImageAttachment [required]

Return type

crate::models::ImageAttachment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_delete

extras_image_attachments_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this image attachment. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_list

crate::models::ExtrasImageAttachmentsList200Response extras_image_attachments_list(id, content_type_id, object_id, name, q, created, content_type, id__n, id__lte, id__lt, id__gte, id__gt, content_type_id__n, object_id__n, object_id__lte, object_id__lt, object_id__gte, object_id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, content_type__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
content_type_id Option<String>
object_id Option<String>
name Option<String>
q Option<String>
created Option<String>
content_type Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
content_type_id__n Option<String>
object_id__n Option<String>
object_id__lte Option<String>
object_id__lt Option<String>
object_id__gte Option<String>
object_id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
content_type__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasImageAttachmentsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_partial_update

crate::models::ImageAttachment extras_image_attachments_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this image attachment. [required]
data ImageAttachment [required]

Return type

crate::models::ImageAttachment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_read

crate::models::ImageAttachment extras_image_attachments_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this image attachment. [required]

Return type

crate::models::ImageAttachment

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_image_attachments_update

crate::models::ImageAttachment extras_image_attachments_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this image attachment. [required]
data ImageAttachment [required]

Return type

crate::models::ImageAttachment

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_job_results_list

crate::models::ExtrasJobResultsList200Response extras_job_results_list(id, interval, status, user, obj_type, name, q, created, created__before, created__after, scheduled, scheduled__before, scheduled__after, started, started__before, started__after, completed, completed__before, completed__after, id__n, id__lte, id__lt, id__gte, id__gt, interval__n, interval__lte, interval__lt, interval__gte, interval__gt, status__n, user__n, obj_type__n, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, ordering, limit, offset)

Retrieve a list of job results

Parameters

Name Type Description Required Notes
id Option<String>
interval Option<String>
status Option<String>
user Option<String>
obj_type Option<String>
name Option<String>
q Option<String>
created Option<String>
created__before Option<String>
created__after Option<String>
scheduled Option<String>
scheduled__before Option<String>
scheduled__after Option<String>
started Option<String>
started__before Option<String>
started__after Option<String>
completed Option<String>
completed__before Option<String>
completed__after Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
interval__n Option<String>
interval__lte Option<String>
interval__lt Option<String>
interval__gte Option<String>
interval__gt Option<String>
status__n Option<String>
user__n Option<String>
obj_type__n Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasJobResultsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_job_results_read

crate::models::JobResult extras_job_results_read(id)

Retrieve a list of job results

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this job result. [required]

Return type

crate::models::JobResult

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_bulk_delete

extras_journal_entries_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_bulk_partial_update

crate::models::JournalEntry extras_journal_entries_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableJournalEntry [required]

Return type

crate::models::JournalEntry

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_bulk_update

crate::models::JournalEntry extras_journal_entries_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableJournalEntry [required]

Return type

crate::models::JournalEntry

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_create

crate::models::JournalEntry extras_journal_entries_create(data)

Parameters

Name Type Description Required Notes
data WritableJournalEntry [required]

Return type

crate::models::JournalEntry

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_delete

extras_journal_entries_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this journal entry. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_list

crate::models::ExtrasJournalEntriesList200Response extras_journal_entries_list(id, assigned_object_type_id, assigned_object_id, created, kind, last_updated, q, tag, assigned_object_type, created_by_id, created_by, id__n, id__lte, id__lt, id__gte, id__gt, assigned_object_type_id__n, assigned_object_id__n, assigned_object_id__lte, assigned_object_id__lt, assigned_object_id__gte, assigned_object_id__gt, kind__n, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, assigned_object_type__n, created_by_id__n, created_by__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
assigned_object_type_id Option<String>
assigned_object_id Option<String>
created Option<String>
kind Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
assigned_object_type Option<String>
created_by_id Option<String>
created_by Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
assigned_object_type_id__n Option<String>
assigned_object_id__n Option<String>
assigned_object_id__lte Option<String>
assigned_object_id__lt Option<String>
assigned_object_id__gte Option<String>
assigned_object_id__gt Option<String>
kind__n Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
assigned_object_type__n Option<String>
created_by_id__n Option<String>
created_by__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasJournalEntriesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_partial_update

crate::models::JournalEntry extras_journal_entries_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this journal entry. [required]
data WritableJournalEntry [required]

Return type

crate::models::JournalEntry

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_read

crate::models::JournalEntry extras_journal_entries_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this journal entry. [required]

Return type

crate::models::JournalEntry

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_journal_entries_update

crate::models::JournalEntry extras_journal_entries_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this journal entry. [required]
data WritableJournalEntry [required]

Return type

crate::models::JournalEntry

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_object_changes_list

crate::models::ExtrasObjectChangesList200Response extras_object_changes_list(id, user, user_name, request_id, action, changed_object_type_id, changed_object_id, object_repr, q, time, changed_object_type, user_id, id__n, id__lte, id__lt, id__gte, id__gt, user__n, user_name__n, user_name__ic, user_name__nic, user_name__iew, user_name__niew, user_name__isw, user_name__nisw, user_name__ie, user_name__nie, user_name__empty, action__n, changed_object_type_id__n, changed_object_id__n, changed_object_id__lte, changed_object_id__lt, changed_object_id__gte, changed_object_id__gt, object_repr__n, object_repr__ic, object_repr__nic, object_repr__iew, object_repr__niew, object_repr__isw, object_repr__nisw, object_repr__ie, object_repr__nie, object_repr__empty, changed_object_type__n, user_id__n, ordering, limit, offset)

Retrieve a list of recent changes.

Parameters

Name Type Description Required Notes
id Option<String>
user Option<String>
user_name Option<String>
request_id Option<String>
action Option<String>
changed_object_type_id Option<String>
changed_object_id Option<String>
object_repr Option<String>
q Option<String>
time Option<String>
changed_object_type Option<String>
user_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
user__n Option<String>
user_name__n Option<String>
user_name__ic Option<String>
user_name__nic Option<String>
user_name__iew Option<String>
user_name__niew Option<String>
user_name__isw Option<String>
user_name__nisw Option<String>
user_name__ie Option<String>
user_name__nie Option<String>
user_name__empty Option<String>
action__n Option<String>
changed_object_type_id__n Option<String>
changed_object_id__n Option<String>
changed_object_id__lte Option<String>
changed_object_id__lt Option<String>
changed_object_id__gte Option<String>
changed_object_id__gt Option<String>
object_repr__n Option<String>
object_repr__ic Option<String>
object_repr__nic Option<String>
object_repr__iew Option<String>
object_repr__niew Option<String>
object_repr__isw Option<String>
object_repr__nisw Option<String>
object_repr__ie Option<String>
object_repr__nie Option<String>
object_repr__empty Option<String>
changed_object_type__n Option<String>
user_id__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasObjectChangesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_object_changes_read

crate::models::ObjectChange extras_object_changes_read(id)

Retrieve a list of recent changes.

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this object change. [required]

Return type

crate::models::ObjectChange

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_reports_list

extras_reports_list()

Compile all reports and their related results (if any). Result data is deferred in the list view.

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_reports_read

extras_reports_read(id)

Retrieve a single Report identified as ".".

Parameters

Name Type Description Required Notes
id String [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_reports_run

extras_reports_run(id)

Run a Report identified as ".<script>" and return the pending JobResult as the result

Parameters

Name Type Description Required Notes
id String [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_bulk_delete

extras_saved_filters_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_bulk_partial_update

crate::models::SavedFilter extras_saved_filters_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data SavedFilter [required]

Return type

crate::models::SavedFilter

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_bulk_update

crate::models::SavedFilter extras_saved_filters_bulk_update(data)

Parameters

Name Type Description Required Notes
data SavedFilter [required]

Return type

crate::models::SavedFilter

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_create

crate::models::SavedFilter extras_saved_filters_create(data)

Parameters

Name Type Description Required Notes
data SavedFilter [required]

Return type

crate::models::SavedFilter

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_delete

extras_saved_filters_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this saved filter. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_list

crate::models::ExtrasSavedFiltersList200Response extras_saved_filters_list(id, content_types, name, slug, description, enabled, shared, weight, q, content_type_id, user_id, user, usable, id__n, id__lte, id__lt, id__gte, id__gt, content_types__n, content_types__ic, content_types__nic, content_types__iew, content_types__niew, content_types__isw, content_types__nisw, content_types__ie, content_types__nie, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, weight__n, weight__lte, weight__lt, weight__gte, weight__gt, content_type_id__n, content_type_id__lte, content_type_id__lt, content_type_id__gte, content_type_id__gt, user_id__n, user__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
content_types Option<String>
name Option<String>
slug Option<String>
description Option<String>
enabled Option<String>
shared Option<String>
weight Option<String>
q Option<String>
content_type_id Option<String>
user_id Option<String>
user Option<String>
usable Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
content_types__n Option<String>
content_types__ic Option<String>
content_types__nic Option<String>
content_types__iew Option<String>
content_types__niew Option<String>
content_types__isw Option<String>
content_types__nisw Option<String>
content_types__ie Option<String>
content_types__nie Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
weight__n Option<String>
weight__lte Option<String>
weight__lt Option<String>
weight__gte Option<String>
weight__gt Option<String>
content_type_id__n Option<String>
content_type_id__lte Option<String>
content_type_id__lt Option<String>
content_type_id__gte Option<String>
content_type_id__gt Option<String>
user_id__n Option<String>
user__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasSavedFiltersList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_partial_update

crate::models::SavedFilter extras_saved_filters_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this saved filter. [required]
data SavedFilter [required]

Return type

crate::models::SavedFilter

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_read

crate::models::SavedFilter extras_saved_filters_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this saved filter. [required]

Return type

crate::models::SavedFilter

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_saved_filters_update

crate::models::SavedFilter extras_saved_filters_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this saved filter. [required]
data SavedFilter [required]

Return type

crate::models::SavedFilter

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_scripts_list

extras_scripts_list()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_scripts_read

extras_scripts_read(id)

Parameters

Name Type Description Required Notes
id String [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_bulk_delete

extras_tags_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_bulk_partial_update

crate::models::Tag extras_tags_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data Tag [required]

Return type

crate::models::Tag

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_bulk_update

crate::models::Tag extras_tags_bulk_update(data)

Parameters

Name Type Description Required Notes
data Tag [required]

Return type

crate::models::Tag

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_create

crate::models::Tag extras_tags_create(data)

Parameters

Name Type Description Required Notes
data Tag [required]

Return type

crate::models::Tag

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_delete

extras_tags_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tag. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_list

crate::models::ExtrasTagsList200Response extras_tags_list(id, name, slug, color, description, created, last_updated, q, content_type, content_type_id, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, color__n, color__ic, color__nic, color__iew, color__niew, color__isw, color__nisw, color__ie, color__nie, color__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
color Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
content_type Option<String>
content_type_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
color__n Option<String>
color__ic Option<String>
color__nic Option<String>
color__iew Option<String>
color__niew Option<String>
color__isw Option<String>
color__nisw Option<String>
color__ie Option<String>
color__nie Option<String>
color__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasTagsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_partial_update

crate::models::Tag extras_tags_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tag. [required]
data Tag [required]

Return type

crate::models::Tag

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_read

crate::models::Tag extras_tags_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tag. [required]

Return type

crate::models::Tag

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_tags_update

crate::models::Tag extras_tags_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this tag. [required]
data Tag [required]

Return type

crate::models::Tag

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_bulk_delete

extras_webhooks_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_bulk_partial_update

crate::models::Webhook extras_webhooks_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data Webhook [required]

Return type

crate::models::Webhook

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_bulk_update

crate::models::Webhook extras_webhooks_bulk_update(data)

Parameters

Name Type Description Required Notes
data Webhook [required]

Return type

crate::models::Webhook

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_create

crate::models::Webhook extras_webhooks_create(data)

Parameters

Name Type Description Required Notes
data Webhook [required]

Return type

crate::models::Webhook

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_delete

extras_webhooks_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this webhook. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_list

crate::models::ExtrasWebhooksList200Response extras_webhooks_list(id, name, type_create, type_update, type_delete, payload_url, enabled, http_method, http_content_type, secret, ssl_verification, ca_file_path, q, content_type_id, content_types, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, payload_url__n, payload_url__ic, payload_url__nic, payload_url__iew, payload_url__niew, payload_url__isw, payload_url__nisw, payload_url__ie, payload_url__nie, payload_url__empty, http_method__n, http_content_type__n, http_content_type__ic, http_content_type__nic, http_content_type__iew, http_content_type__niew, http_content_type__isw, http_content_type__nisw, http_content_type__ie, http_content_type__nie, http_content_type__empty, secret__n, secret__ic, secret__nic, secret__iew, secret__niew, secret__isw, secret__nisw, secret__ie, secret__nie, secret__empty, ca_file_path__n, ca_file_path__ic, ca_file_path__nic, ca_file_path__iew, ca_file_path__niew, ca_file_path__isw, ca_file_path__nisw, ca_file_path__ie, ca_file_path__nie, ca_file_path__empty, content_type_id__n, content_type_id__lte, content_type_id__lt, content_type_id__gte, content_type_id__gt, content_types__n, content_types__ic, content_types__nic, content_types__iew, content_types__niew, content_types__isw, content_types__nisw, content_types__ie, content_types__nie, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
type_create Option<String>
type_update Option<String>
type_delete Option<String>
payload_url Option<String>
enabled Option<String>
http_method Option<String>
http_content_type Option<String>
secret Option<String>
ssl_verification Option<String>
ca_file_path Option<String>
q Option<String>
content_type_id Option<String>
content_types Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
payload_url__n Option<String>
payload_url__ic Option<String>
payload_url__nic Option<String>
payload_url__iew Option<String>
payload_url__niew Option<String>
payload_url__isw Option<String>
payload_url__nisw Option<String>
payload_url__ie Option<String>
payload_url__nie Option<String>
payload_url__empty Option<String>
http_method__n Option<String>
http_content_type__n Option<String>
http_content_type__ic Option<String>
http_content_type__nic Option<String>
http_content_type__iew Option<String>
http_content_type__niew Option<String>
http_content_type__isw Option<String>
http_content_type__nisw Option<String>
http_content_type__ie Option<String>
http_content_type__nie Option<String>
http_content_type__empty Option<String>
secret__n Option<String>
secret__ic Option<String>
secret__nic Option<String>
secret__iew Option<String>
secret__niew Option<String>
secret__isw Option<String>
secret__nisw Option<String>
secret__ie Option<String>
secret__nie Option<String>
secret__empty Option<String>
ca_file_path__n Option<String>
ca_file_path__ic Option<String>
ca_file_path__nic Option<String>
ca_file_path__iew Option<String>
ca_file_path__niew Option<String>
ca_file_path__isw Option<String>
ca_file_path__nisw Option<String>
ca_file_path__ie Option<String>
ca_file_path__nie Option<String>
ca_file_path__empty Option<String>
content_type_id__n Option<String>
content_type_id__lte Option<String>
content_type_id__lt Option<String>
content_type_id__gte Option<String>
content_type_id__gt Option<String>
content_types__n Option<String>
content_types__ic Option<String>
content_types__nic Option<String>
content_types__iew Option<String>
content_types__niew Option<String>
content_types__isw Option<String>
content_types__nisw Option<String>
content_types__ie Option<String>
content_types__nie Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::ExtrasWebhooksList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_partial_update

crate::models::Webhook extras_webhooks_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this webhook. [required]
data Webhook [required]

Return type

crate::models::Webhook

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_read

crate::models::Webhook extras_webhooks_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this webhook. [required]

Return type

crate::models::Webhook

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extras_webhooks_update

crate::models::Webhook extras_webhooks_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this webhook. [required]
data Webhook [required]

Return type

crate::models::Webhook

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]