# \ExtrasApi
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**extras_computed_fields_bulk_destroy**](ExtrasApi.md#extras_computed_fields_bulk_destroy) | **DELETE** /extras/computed-fields/ |
[**extras_computed_fields_bulk_partial_update**](ExtrasApi.md#extras_computed_fields_bulk_partial_update) | **PATCH** /extras/computed-fields/ |
[**extras_computed_fields_bulk_update**](ExtrasApi.md#extras_computed_fields_bulk_update) | **PUT** /extras/computed-fields/ |
[**extras_computed_fields_create**](ExtrasApi.md#extras_computed_fields_create) | **POST** /extras/computed-fields/ |
[**extras_computed_fields_destroy**](ExtrasApi.md#extras_computed_fields_destroy) | **DELETE** /extras/computed-fields/{id}/ |
[**extras_computed_fields_list**](ExtrasApi.md#extras_computed_fields_list) | **GET** /extras/computed-fields/ |
[**extras_computed_fields_notes_create**](ExtrasApi.md#extras_computed_fields_notes_create) | **POST** /extras/computed-fields/{id}/notes/ |
[**extras_computed_fields_notes_list**](ExtrasApi.md#extras_computed_fields_notes_list) | **GET** /extras/computed-fields/{id}/notes/ |
[**extras_computed_fields_partial_update**](ExtrasApi.md#extras_computed_fields_partial_update) | **PATCH** /extras/computed-fields/{id}/ |
[**extras_computed_fields_retrieve**](ExtrasApi.md#extras_computed_fields_retrieve) | **GET** /extras/computed-fields/{id}/ |
[**extras_computed_fields_update**](ExtrasApi.md#extras_computed_fields_update) | **PUT** /extras/computed-fields/{id}/ |
[**extras_config_context_schemas_bulk_destroy**](ExtrasApi.md#extras_config_context_schemas_bulk_destroy) | **DELETE** /extras/config-context-schemas/ |
[**extras_config_context_schemas_bulk_partial_update**](ExtrasApi.md#extras_config_context_schemas_bulk_partial_update) | **PATCH** /extras/config-context-schemas/ |
[**extras_config_context_schemas_bulk_update**](ExtrasApi.md#extras_config_context_schemas_bulk_update) | **PUT** /extras/config-context-schemas/ |
[**extras_config_context_schemas_create**](ExtrasApi.md#extras_config_context_schemas_create) | **POST** /extras/config-context-schemas/ |
[**extras_config_context_schemas_destroy**](ExtrasApi.md#extras_config_context_schemas_destroy) | **DELETE** /extras/config-context-schemas/{id}/ |
[**extras_config_context_schemas_list**](ExtrasApi.md#extras_config_context_schemas_list) | **GET** /extras/config-context-schemas/ |
[**extras_config_context_schemas_notes_create**](ExtrasApi.md#extras_config_context_schemas_notes_create) | **POST** /extras/config-context-schemas/{id}/notes/ |
[**extras_config_context_schemas_notes_list**](ExtrasApi.md#extras_config_context_schemas_notes_list) | **GET** /extras/config-context-schemas/{id}/notes/ |
[**extras_config_context_schemas_partial_update**](ExtrasApi.md#extras_config_context_schemas_partial_update) | **PATCH** /extras/config-context-schemas/{id}/ |
[**extras_config_context_schemas_retrieve**](ExtrasApi.md#extras_config_context_schemas_retrieve) | **GET** /extras/config-context-schemas/{id}/ |
[**extras_config_context_schemas_update**](ExtrasApi.md#extras_config_context_schemas_update) | **PUT** /extras/config-context-schemas/{id}/ |
[**extras_config_contexts_bulk_destroy**](ExtrasApi.md#extras_config_contexts_bulk_destroy) | **DELETE** /extras/config-contexts/ |
[**extras_config_contexts_bulk_partial_update**](ExtrasApi.md#extras_config_contexts_bulk_partial_update) | **PATCH** /extras/config-contexts/ |
[**extras_config_contexts_bulk_update**](ExtrasApi.md#extras_config_contexts_bulk_update) | **PUT** /extras/config-contexts/ |
[**extras_config_contexts_create**](ExtrasApi.md#extras_config_contexts_create) | **POST** /extras/config-contexts/ |
[**extras_config_contexts_destroy**](ExtrasApi.md#extras_config_contexts_destroy) | **DELETE** /extras/config-contexts/{id}/ |
[**extras_config_contexts_list**](ExtrasApi.md#extras_config_contexts_list) | **GET** /extras/config-contexts/ |
[**extras_config_contexts_notes_create**](ExtrasApi.md#extras_config_contexts_notes_create) | **POST** /extras/config-contexts/{id}/notes/ |
[**extras_config_contexts_notes_list**](ExtrasApi.md#extras_config_contexts_notes_list) | **GET** /extras/config-contexts/{id}/notes/ |
[**extras_config_contexts_partial_update**](ExtrasApi.md#extras_config_contexts_partial_update) | **PATCH** /extras/config-contexts/{id}/ |
[**extras_config_contexts_retrieve**](ExtrasApi.md#extras_config_contexts_retrieve) | **GET** /extras/config-contexts/{id}/ |
[**extras_config_contexts_update**](ExtrasApi.md#extras_config_contexts_update) | **PUT** /extras/config-contexts/{id}/ |
[**extras_contact_associations_bulk_destroy**](ExtrasApi.md#extras_contact_associations_bulk_destroy) | **DELETE** /extras/contact-associations/ |
[**extras_contact_associations_bulk_partial_update**](ExtrasApi.md#extras_contact_associations_bulk_partial_update) | **PATCH** /extras/contact-associations/ |
[**extras_contact_associations_bulk_update**](ExtrasApi.md#extras_contact_associations_bulk_update) | **PUT** /extras/contact-associations/ |
[**extras_contact_associations_create**](ExtrasApi.md#extras_contact_associations_create) | **POST** /extras/contact-associations/ |
[**extras_contact_associations_destroy**](ExtrasApi.md#extras_contact_associations_destroy) | **DELETE** /extras/contact-associations/{id}/ |
[**extras_contact_associations_list**](ExtrasApi.md#extras_contact_associations_list) | **GET** /extras/contact-associations/ |
[**extras_contact_associations_notes_create**](ExtrasApi.md#extras_contact_associations_notes_create) | **POST** /extras/contact-associations/{id}/notes/ |
[**extras_contact_associations_notes_list**](ExtrasApi.md#extras_contact_associations_notes_list) | **GET** /extras/contact-associations/{id}/notes/ |
[**extras_contact_associations_partial_update**](ExtrasApi.md#extras_contact_associations_partial_update) | **PATCH** /extras/contact-associations/{id}/ |
[**extras_contact_associations_retrieve**](ExtrasApi.md#extras_contact_associations_retrieve) | **GET** /extras/contact-associations/{id}/ |
[**extras_contact_associations_update**](ExtrasApi.md#extras_contact_associations_update) | **PUT** /extras/contact-associations/{id}/ |
[**extras_contacts_bulk_destroy**](ExtrasApi.md#extras_contacts_bulk_destroy) | **DELETE** /extras/contacts/ |
[**extras_contacts_bulk_partial_update**](ExtrasApi.md#extras_contacts_bulk_partial_update) | **PATCH** /extras/contacts/ |
[**extras_contacts_bulk_update**](ExtrasApi.md#extras_contacts_bulk_update) | **PUT** /extras/contacts/ |
[**extras_contacts_create**](ExtrasApi.md#extras_contacts_create) | **POST** /extras/contacts/ |
[**extras_contacts_destroy**](ExtrasApi.md#extras_contacts_destroy) | **DELETE** /extras/contacts/{id}/ |
[**extras_contacts_list**](ExtrasApi.md#extras_contacts_list) | **GET** /extras/contacts/ |
[**extras_contacts_notes_create**](ExtrasApi.md#extras_contacts_notes_create) | **POST** /extras/contacts/{id}/notes/ |
[**extras_contacts_notes_list**](ExtrasApi.md#extras_contacts_notes_list) | **GET** /extras/contacts/{id}/notes/ |
[**extras_contacts_partial_update**](ExtrasApi.md#extras_contacts_partial_update) | **PATCH** /extras/contacts/{id}/ |
[**extras_contacts_retrieve**](ExtrasApi.md#extras_contacts_retrieve) | **GET** /extras/contacts/{id}/ |
[**extras_contacts_update**](ExtrasApi.md#extras_contacts_update) | **PUT** /extras/contacts/{id}/ |
[**extras_content_types_list**](ExtrasApi.md#extras_content_types_list) | **GET** /extras/content-types/ |
[**extras_content_types_retrieve**](ExtrasApi.md#extras_content_types_retrieve) | **GET** /extras/content-types/{id}/ |
[**extras_custom_field_choices_bulk_destroy**](ExtrasApi.md#extras_custom_field_choices_bulk_destroy) | **DELETE** /extras/custom-field-choices/ |
[**extras_custom_field_choices_bulk_partial_update**](ExtrasApi.md#extras_custom_field_choices_bulk_partial_update) | **PATCH** /extras/custom-field-choices/ |
[**extras_custom_field_choices_bulk_update**](ExtrasApi.md#extras_custom_field_choices_bulk_update) | **PUT** /extras/custom-field-choices/ |
[**extras_custom_field_choices_create**](ExtrasApi.md#extras_custom_field_choices_create) | **POST** /extras/custom-field-choices/ |
[**extras_custom_field_choices_destroy**](ExtrasApi.md#extras_custom_field_choices_destroy) | **DELETE** /extras/custom-field-choices/{id}/ |
[**extras_custom_field_choices_list**](ExtrasApi.md#extras_custom_field_choices_list) | **GET** /extras/custom-field-choices/ |
[**extras_custom_field_choices_partial_update**](ExtrasApi.md#extras_custom_field_choices_partial_update) | **PATCH** /extras/custom-field-choices/{id}/ |
[**extras_custom_field_choices_retrieve**](ExtrasApi.md#extras_custom_field_choices_retrieve) | **GET** /extras/custom-field-choices/{id}/ |
[**extras_custom_field_choices_update**](ExtrasApi.md#extras_custom_field_choices_update) | **PUT** /extras/custom-field-choices/{id}/ |
[**extras_custom_fields_bulk_destroy**](ExtrasApi.md#extras_custom_fields_bulk_destroy) | **DELETE** /extras/custom-fields/ |
[**extras_custom_fields_bulk_partial_update**](ExtrasApi.md#extras_custom_fields_bulk_partial_update) | **PATCH** /extras/custom-fields/ |
[**extras_custom_fields_bulk_update**](ExtrasApi.md#extras_custom_fields_bulk_update) | **PUT** /extras/custom-fields/ |
[**extras_custom_fields_create**](ExtrasApi.md#extras_custom_fields_create) | **POST** /extras/custom-fields/ |
[**extras_custom_fields_destroy**](ExtrasApi.md#extras_custom_fields_destroy) | **DELETE** /extras/custom-fields/{id}/ |
[**extras_custom_fields_list**](ExtrasApi.md#extras_custom_fields_list) | **GET** /extras/custom-fields/ |
[**extras_custom_fields_notes_create**](ExtrasApi.md#extras_custom_fields_notes_create) | **POST** /extras/custom-fields/{id}/notes/ |
[**extras_custom_fields_notes_list**](ExtrasApi.md#extras_custom_fields_notes_list) | **GET** /extras/custom-fields/{id}/notes/ |
[**extras_custom_fields_partial_update**](ExtrasApi.md#extras_custom_fields_partial_update) | **PATCH** /extras/custom-fields/{id}/ |
[**extras_custom_fields_retrieve**](ExtrasApi.md#extras_custom_fields_retrieve) | **GET** /extras/custom-fields/{id}/ |
[**extras_custom_fields_update**](ExtrasApi.md#extras_custom_fields_update) | **PUT** /extras/custom-fields/{id}/ |
[**extras_custom_links_bulk_destroy**](ExtrasApi.md#extras_custom_links_bulk_destroy) | **DELETE** /extras/custom-links/ |
[**extras_custom_links_bulk_partial_update**](ExtrasApi.md#extras_custom_links_bulk_partial_update) | **PATCH** /extras/custom-links/ |
[**extras_custom_links_bulk_update**](ExtrasApi.md#extras_custom_links_bulk_update) | **PUT** /extras/custom-links/ |
[**extras_custom_links_create**](ExtrasApi.md#extras_custom_links_create) | **POST** /extras/custom-links/ |
[**extras_custom_links_destroy**](ExtrasApi.md#extras_custom_links_destroy) | **DELETE** /extras/custom-links/{id}/ |
[**extras_custom_links_list**](ExtrasApi.md#extras_custom_links_list) | **GET** /extras/custom-links/ |
[**extras_custom_links_notes_create**](ExtrasApi.md#extras_custom_links_notes_create) | **POST** /extras/custom-links/{id}/notes/ |
[**extras_custom_links_notes_list**](ExtrasApi.md#extras_custom_links_notes_list) | **GET** /extras/custom-links/{id}/notes/ |
[**extras_custom_links_partial_update**](ExtrasApi.md#extras_custom_links_partial_update) | **PATCH** /extras/custom-links/{id}/ |
[**extras_custom_links_retrieve**](ExtrasApi.md#extras_custom_links_retrieve) | **GET** /extras/custom-links/{id}/ |
[**extras_custom_links_update**](ExtrasApi.md#extras_custom_links_update) | **PUT** /extras/custom-links/{id}/ |
[**extras_dynamic_group_memberships_bulk_destroy**](ExtrasApi.md#extras_dynamic_group_memberships_bulk_destroy) | **DELETE** /extras/dynamic-group-memberships/ |
[**extras_dynamic_group_memberships_bulk_partial_update**](ExtrasApi.md#extras_dynamic_group_memberships_bulk_partial_update) | **PATCH** /extras/dynamic-group-memberships/ |
[**extras_dynamic_group_memberships_bulk_update**](ExtrasApi.md#extras_dynamic_group_memberships_bulk_update) | **PUT** /extras/dynamic-group-memberships/ |
[**extras_dynamic_group_memberships_create**](ExtrasApi.md#extras_dynamic_group_memberships_create) | **POST** /extras/dynamic-group-memberships/ |
[**extras_dynamic_group_memberships_destroy**](ExtrasApi.md#extras_dynamic_group_memberships_destroy) | **DELETE** /extras/dynamic-group-memberships/{id}/ |
[**extras_dynamic_group_memberships_list**](ExtrasApi.md#extras_dynamic_group_memberships_list) | **GET** /extras/dynamic-group-memberships/ |
[**extras_dynamic_group_memberships_partial_update**](ExtrasApi.md#extras_dynamic_group_memberships_partial_update) | **PATCH** /extras/dynamic-group-memberships/{id}/ |
[**extras_dynamic_group_memberships_retrieve**](ExtrasApi.md#extras_dynamic_group_memberships_retrieve) | **GET** /extras/dynamic-group-memberships/{id}/ |
[**extras_dynamic_group_memberships_update**](ExtrasApi.md#extras_dynamic_group_memberships_update) | **PUT** /extras/dynamic-group-memberships/{id}/ |
[**extras_dynamic_groups_bulk_destroy**](ExtrasApi.md#extras_dynamic_groups_bulk_destroy) | **DELETE** /extras/dynamic-groups/ |
[**extras_dynamic_groups_bulk_partial_update**](ExtrasApi.md#extras_dynamic_groups_bulk_partial_update) | **PATCH** /extras/dynamic-groups/ |
[**extras_dynamic_groups_bulk_update**](ExtrasApi.md#extras_dynamic_groups_bulk_update) | **PUT** /extras/dynamic-groups/ |
[**extras_dynamic_groups_create**](ExtrasApi.md#extras_dynamic_groups_create) | **POST** /extras/dynamic-groups/ |
[**extras_dynamic_groups_destroy**](ExtrasApi.md#extras_dynamic_groups_destroy) | **DELETE** /extras/dynamic-groups/{id}/ |
[**extras_dynamic_groups_list**](ExtrasApi.md#extras_dynamic_groups_list) | **GET** /extras/dynamic-groups/ |
[**extras_dynamic_groups_members_retrieve**](ExtrasApi.md#extras_dynamic_groups_members_retrieve) | **GET** /extras/dynamic-groups/{id}/members/ |
[**extras_dynamic_groups_notes_create**](ExtrasApi.md#extras_dynamic_groups_notes_create) | **POST** /extras/dynamic-groups/{id}/notes/ |
[**extras_dynamic_groups_notes_list**](ExtrasApi.md#extras_dynamic_groups_notes_list) | **GET** /extras/dynamic-groups/{id}/notes/ |
[**extras_dynamic_groups_partial_update**](ExtrasApi.md#extras_dynamic_groups_partial_update) | **PATCH** /extras/dynamic-groups/{id}/ |
[**extras_dynamic_groups_retrieve**](ExtrasApi.md#extras_dynamic_groups_retrieve) | **GET** /extras/dynamic-groups/{id}/ |
[**extras_dynamic_groups_update**](ExtrasApi.md#extras_dynamic_groups_update) | **PUT** /extras/dynamic-groups/{id}/ |
[**extras_export_templates_bulk_destroy**](ExtrasApi.md#extras_export_templates_bulk_destroy) | **DELETE** /extras/export-templates/ |
[**extras_export_templates_bulk_partial_update**](ExtrasApi.md#extras_export_templates_bulk_partial_update) | **PATCH** /extras/export-templates/ |
[**extras_export_templates_bulk_update**](ExtrasApi.md#extras_export_templates_bulk_update) | **PUT** /extras/export-templates/ |
[**extras_export_templates_create**](ExtrasApi.md#extras_export_templates_create) | **POST** /extras/export-templates/ |
[**extras_export_templates_destroy**](ExtrasApi.md#extras_export_templates_destroy) | **DELETE** /extras/export-templates/{id}/ |
[**extras_export_templates_list**](ExtrasApi.md#extras_export_templates_list) | **GET** /extras/export-templates/ |
[**extras_export_templates_notes_create**](ExtrasApi.md#extras_export_templates_notes_create) | **POST** /extras/export-templates/{id}/notes/ |
[**extras_export_templates_notes_list**](ExtrasApi.md#extras_export_templates_notes_list) | **GET** /extras/export-templates/{id}/notes/ |
[**extras_export_templates_partial_update**](ExtrasApi.md#extras_export_templates_partial_update) | **PATCH** /extras/export-templates/{id}/ |
[**extras_export_templates_retrieve**](ExtrasApi.md#extras_export_templates_retrieve) | **GET** /extras/export-templates/{id}/ |
[**extras_export_templates_update**](ExtrasApi.md#extras_export_templates_update) | **PUT** /extras/export-templates/{id}/ |
[**extras_external_integrations_bulk_destroy**](ExtrasApi.md#extras_external_integrations_bulk_destroy) | **DELETE** /extras/external-integrations/ |
[**extras_external_integrations_bulk_partial_update**](ExtrasApi.md#extras_external_integrations_bulk_partial_update) | **PATCH** /extras/external-integrations/ |
[**extras_external_integrations_bulk_update**](ExtrasApi.md#extras_external_integrations_bulk_update) | **PUT** /extras/external-integrations/ |
[**extras_external_integrations_create**](ExtrasApi.md#extras_external_integrations_create) | **POST** /extras/external-integrations/ |
[**extras_external_integrations_destroy**](ExtrasApi.md#extras_external_integrations_destroy) | **DELETE** /extras/external-integrations/{id}/ |
[**extras_external_integrations_list**](ExtrasApi.md#extras_external_integrations_list) | **GET** /extras/external-integrations/ |
[**extras_external_integrations_notes_create**](ExtrasApi.md#extras_external_integrations_notes_create) | **POST** /extras/external-integrations/{id}/notes/ |
[**extras_external_integrations_notes_list**](ExtrasApi.md#extras_external_integrations_notes_list) | **GET** /extras/external-integrations/{id}/notes/ |
[**extras_external_integrations_partial_update**](ExtrasApi.md#extras_external_integrations_partial_update) | **PATCH** /extras/external-integrations/{id}/ |
[**extras_external_integrations_retrieve**](ExtrasApi.md#extras_external_integrations_retrieve) | **GET** /extras/external-integrations/{id}/ |
[**extras_external_integrations_update**](ExtrasApi.md#extras_external_integrations_update) | **PUT** /extras/external-integrations/{id}/ |
[**extras_file_proxies_download_retrieve**](ExtrasApi.md#extras_file_proxies_download_retrieve) | **GET** /extras/file-proxies/{id}/download/ |
[**extras_file_proxies_list**](ExtrasApi.md#extras_file_proxies_list) | **GET** /extras/file-proxies/ |
[**extras_file_proxies_retrieve**](ExtrasApi.md#extras_file_proxies_retrieve) | **GET** /extras/file-proxies/{id}/ |
[**extras_git_repositories_bulk_destroy**](ExtrasApi.md#extras_git_repositories_bulk_destroy) | **DELETE** /extras/git-repositories/ |
[**extras_git_repositories_bulk_partial_update**](ExtrasApi.md#extras_git_repositories_bulk_partial_update) | **PATCH** /extras/git-repositories/ |
[**extras_git_repositories_bulk_update**](ExtrasApi.md#extras_git_repositories_bulk_update) | **PUT** /extras/git-repositories/ |
[**extras_git_repositories_create**](ExtrasApi.md#extras_git_repositories_create) | **POST** /extras/git-repositories/ |
[**extras_git_repositories_destroy**](ExtrasApi.md#extras_git_repositories_destroy) | **DELETE** /extras/git-repositories/{id}/ |
[**extras_git_repositories_list**](ExtrasApi.md#extras_git_repositories_list) | **GET** /extras/git-repositories/ |
[**extras_git_repositories_notes_create**](ExtrasApi.md#extras_git_repositories_notes_create) | **POST** /extras/git-repositories/{id}/notes/ |
[**extras_git_repositories_notes_list**](ExtrasApi.md#extras_git_repositories_notes_list) | **GET** /extras/git-repositories/{id}/notes/ |
[**extras_git_repositories_partial_update**](ExtrasApi.md#extras_git_repositories_partial_update) | **PATCH** /extras/git-repositories/{id}/ |
[**extras_git_repositories_retrieve**](ExtrasApi.md#extras_git_repositories_retrieve) | **GET** /extras/git-repositories/{id}/ |
[**extras_git_repositories_sync_create**](ExtrasApi.md#extras_git_repositories_sync_create) | **POST** /extras/git-repositories/{id}/sync/ |
[**extras_git_repositories_update**](ExtrasApi.md#extras_git_repositories_update) | **PUT** /extras/git-repositories/{id}/ |
[**extras_graphql_queries_bulk_destroy**](ExtrasApi.md#extras_graphql_queries_bulk_destroy) | **DELETE** /extras/graphql-queries/ |
[**extras_graphql_queries_bulk_partial_update**](ExtrasApi.md#extras_graphql_queries_bulk_partial_update) | **PATCH** /extras/graphql-queries/ |
[**extras_graphql_queries_bulk_update**](ExtrasApi.md#extras_graphql_queries_bulk_update) | **PUT** /extras/graphql-queries/ |
[**extras_graphql_queries_create**](ExtrasApi.md#extras_graphql_queries_create) | **POST** /extras/graphql-queries/ |
[**extras_graphql_queries_destroy**](ExtrasApi.md#extras_graphql_queries_destroy) | **DELETE** /extras/graphql-queries/{id}/ |
[**extras_graphql_queries_list**](ExtrasApi.md#extras_graphql_queries_list) | **GET** /extras/graphql-queries/ |
[**extras_graphql_queries_notes_create**](ExtrasApi.md#extras_graphql_queries_notes_create) | **POST** /extras/graphql-queries/{id}/notes/ |
[**extras_graphql_queries_notes_list**](ExtrasApi.md#extras_graphql_queries_notes_list) | **GET** /extras/graphql-queries/{id}/notes/ |
[**extras_graphql_queries_partial_update**](ExtrasApi.md#extras_graphql_queries_partial_update) | **PATCH** /extras/graphql-queries/{id}/ |
[**extras_graphql_queries_retrieve**](ExtrasApi.md#extras_graphql_queries_retrieve) | **GET** /extras/graphql-queries/{id}/ |
[**extras_graphql_queries_run_create**](ExtrasApi.md#extras_graphql_queries_run_create) | **POST** /extras/graphql-queries/{id}/run/ |
[**extras_graphql_queries_update**](ExtrasApi.md#extras_graphql_queries_update) | **PUT** /extras/graphql-queries/{id}/ |
[**extras_image_attachments_bulk_destroy**](ExtrasApi.md#extras_image_attachments_bulk_destroy) | **DELETE** /extras/image-attachments/ |
[**extras_image_attachments_bulk_partial_update**](ExtrasApi.md#extras_image_attachments_bulk_partial_update) | **PATCH** /extras/image-attachments/ |
[**extras_image_attachments_bulk_update**](ExtrasApi.md#extras_image_attachments_bulk_update) | **PUT** /extras/image-attachments/ |
[**extras_image_attachments_create**](ExtrasApi.md#extras_image_attachments_create) | **POST** /extras/image-attachments/ |
[**extras_image_attachments_destroy**](ExtrasApi.md#extras_image_attachments_destroy) | **DELETE** /extras/image-attachments/{id}/ |
[**extras_image_attachments_list**](ExtrasApi.md#extras_image_attachments_list) | **GET** /extras/image-attachments/ |
[**extras_image_attachments_partial_update**](ExtrasApi.md#extras_image_attachments_partial_update) | **PATCH** /extras/image-attachments/{id}/ |
[**extras_image_attachments_retrieve**](ExtrasApi.md#extras_image_attachments_retrieve) | **GET** /extras/image-attachments/{id}/ |
[**extras_image_attachments_update**](ExtrasApi.md#extras_image_attachments_update) | **PUT** /extras/image-attachments/{id}/ |
[**extras_job_buttons_bulk_destroy**](ExtrasApi.md#extras_job_buttons_bulk_destroy) | **DELETE** /extras/job-buttons/ |
[**extras_job_buttons_bulk_partial_update**](ExtrasApi.md#extras_job_buttons_bulk_partial_update) | **PATCH** /extras/job-buttons/ |
[**extras_job_buttons_bulk_update**](ExtrasApi.md#extras_job_buttons_bulk_update) | **PUT** /extras/job-buttons/ |
[**extras_job_buttons_create**](ExtrasApi.md#extras_job_buttons_create) | **POST** /extras/job-buttons/ |
[**extras_job_buttons_destroy**](ExtrasApi.md#extras_job_buttons_destroy) | **DELETE** /extras/job-buttons/{id}/ |
[**extras_job_buttons_list**](ExtrasApi.md#extras_job_buttons_list) | **GET** /extras/job-buttons/ |
[**extras_job_buttons_notes_create**](ExtrasApi.md#extras_job_buttons_notes_create) | **POST** /extras/job-buttons/{id}/notes/ |
[**extras_job_buttons_notes_list**](ExtrasApi.md#extras_job_buttons_notes_list) | **GET** /extras/job-buttons/{id}/notes/ |
[**extras_job_buttons_partial_update**](ExtrasApi.md#extras_job_buttons_partial_update) | **PATCH** /extras/job-buttons/{id}/ |
[**extras_job_buttons_retrieve**](ExtrasApi.md#extras_job_buttons_retrieve) | **GET** /extras/job-buttons/{id}/ |
[**extras_job_buttons_update**](ExtrasApi.md#extras_job_buttons_update) | **PUT** /extras/job-buttons/{id}/ |
[**extras_job_hooks_bulk_destroy**](ExtrasApi.md#extras_job_hooks_bulk_destroy) | **DELETE** /extras/job-hooks/ |
[**extras_job_hooks_bulk_partial_update**](ExtrasApi.md#extras_job_hooks_bulk_partial_update) | **PATCH** /extras/job-hooks/ |
[**extras_job_hooks_bulk_update**](ExtrasApi.md#extras_job_hooks_bulk_update) | **PUT** /extras/job-hooks/ |
[**extras_job_hooks_create**](ExtrasApi.md#extras_job_hooks_create) | **POST** /extras/job-hooks/ |
[**extras_job_hooks_destroy**](ExtrasApi.md#extras_job_hooks_destroy) | **DELETE** /extras/job-hooks/{id}/ |
[**extras_job_hooks_list**](ExtrasApi.md#extras_job_hooks_list) | **GET** /extras/job-hooks/ |
[**extras_job_hooks_notes_create**](ExtrasApi.md#extras_job_hooks_notes_create) | **POST** /extras/job-hooks/{id}/notes/ |
[**extras_job_hooks_notes_list**](ExtrasApi.md#extras_job_hooks_notes_list) | **GET** /extras/job-hooks/{id}/notes/ |
[**extras_job_hooks_partial_update**](ExtrasApi.md#extras_job_hooks_partial_update) | **PATCH** /extras/job-hooks/{id}/ |
[**extras_job_hooks_retrieve**](ExtrasApi.md#extras_job_hooks_retrieve) | **GET** /extras/job-hooks/{id}/ |
[**extras_job_hooks_update**](ExtrasApi.md#extras_job_hooks_update) | **PUT** /extras/job-hooks/{id}/ |
[**extras_job_logs_list**](ExtrasApi.md#extras_job_logs_list) | **GET** /extras/job-logs/ |
[**extras_job_logs_retrieve**](ExtrasApi.md#extras_job_logs_retrieve) | **GET** /extras/job-logs/{id}/ |
[**extras_job_queue_assignments_bulk_destroy**](ExtrasApi.md#extras_job_queue_assignments_bulk_destroy) | **DELETE** /extras/job-queue-assignments/ |
[**extras_job_queue_assignments_bulk_partial_update**](ExtrasApi.md#extras_job_queue_assignments_bulk_partial_update) | **PATCH** /extras/job-queue-assignments/ |
[**extras_job_queue_assignments_bulk_update**](ExtrasApi.md#extras_job_queue_assignments_bulk_update) | **PUT** /extras/job-queue-assignments/ |
[**extras_job_queue_assignments_create**](ExtrasApi.md#extras_job_queue_assignments_create) | **POST** /extras/job-queue-assignments/ |
[**extras_job_queue_assignments_destroy**](ExtrasApi.md#extras_job_queue_assignments_destroy) | **DELETE** /extras/job-queue-assignments/{id}/ |
[**extras_job_queue_assignments_list**](ExtrasApi.md#extras_job_queue_assignments_list) | **GET** /extras/job-queue-assignments/ |
[**extras_job_queue_assignments_partial_update**](ExtrasApi.md#extras_job_queue_assignments_partial_update) | **PATCH** /extras/job-queue-assignments/{id}/ |
[**extras_job_queue_assignments_retrieve**](ExtrasApi.md#extras_job_queue_assignments_retrieve) | **GET** /extras/job-queue-assignments/{id}/ |
[**extras_job_queue_assignments_update**](ExtrasApi.md#extras_job_queue_assignments_update) | **PUT** /extras/job-queue-assignments/{id}/ |
[**extras_job_queues_bulk_destroy**](ExtrasApi.md#extras_job_queues_bulk_destroy) | **DELETE** /extras/job-queues/ |
[**extras_job_queues_bulk_partial_update**](ExtrasApi.md#extras_job_queues_bulk_partial_update) | **PATCH** /extras/job-queues/ |
[**extras_job_queues_bulk_update**](ExtrasApi.md#extras_job_queues_bulk_update) | **PUT** /extras/job-queues/ |
[**extras_job_queues_create**](ExtrasApi.md#extras_job_queues_create) | **POST** /extras/job-queues/ |
[**extras_job_queues_destroy**](ExtrasApi.md#extras_job_queues_destroy) | **DELETE** /extras/job-queues/{id}/ |
[**extras_job_queues_list**](ExtrasApi.md#extras_job_queues_list) | **GET** /extras/job-queues/ |
[**extras_job_queues_notes_create**](ExtrasApi.md#extras_job_queues_notes_create) | **POST** /extras/job-queues/{id}/notes/ |
[**extras_job_queues_notes_list**](ExtrasApi.md#extras_job_queues_notes_list) | **GET** /extras/job-queues/{id}/notes/ |
[**extras_job_queues_partial_update**](ExtrasApi.md#extras_job_queues_partial_update) | **PATCH** /extras/job-queues/{id}/ |
[**extras_job_queues_retrieve**](ExtrasApi.md#extras_job_queues_retrieve) | **GET** /extras/job-queues/{id}/ |
[**extras_job_queues_update**](ExtrasApi.md#extras_job_queues_update) | **PUT** /extras/job-queues/{id}/ |
[**extras_job_results_bulk_destroy**](ExtrasApi.md#extras_job_results_bulk_destroy) | **DELETE** /extras/job-results/ |
[**extras_job_results_destroy**](ExtrasApi.md#extras_job_results_destroy) | **DELETE** /extras/job-results/{id}/ |
[**extras_job_results_list**](ExtrasApi.md#extras_job_results_list) | **GET** /extras/job-results/ |
[**extras_job_results_logs_retrieve**](ExtrasApi.md#extras_job_results_logs_retrieve) | **GET** /extras/job-results/{id}/logs/ |
[**extras_job_results_retrieve**](ExtrasApi.md#extras_job_results_retrieve) | **GET** /extras/job-results/{id}/ |
[**extras_jobs_bulk_destroy**](ExtrasApi.md#extras_jobs_bulk_destroy) | **DELETE** /extras/jobs/ |
[**extras_jobs_bulk_partial_update**](ExtrasApi.md#extras_jobs_bulk_partial_update) | **PATCH** /extras/jobs/ |
[**extras_jobs_bulk_update**](ExtrasApi.md#extras_jobs_bulk_update) | **PUT** /extras/jobs/ |
[**extras_jobs_destroy**](ExtrasApi.md#extras_jobs_destroy) | **DELETE** /extras/jobs/{id}/ |
[**extras_jobs_destroy_by_name**](ExtrasApi.md#extras_jobs_destroy_by_name) | **DELETE** /extras/jobs/{name}/ |
[**extras_jobs_list**](ExtrasApi.md#extras_jobs_list) | **GET** /extras/jobs/ |
[**extras_jobs_notes_create**](ExtrasApi.md#extras_jobs_notes_create) | **POST** /extras/jobs/{id}/notes/ |
[**extras_jobs_notes_create_by_name**](ExtrasApi.md#extras_jobs_notes_create_by_name) | **POST** /extras/jobs/{name}/notes/ |
[**extras_jobs_notes_list**](ExtrasApi.md#extras_jobs_notes_list) | **GET** /extras/jobs/{id}/notes/ |
[**extras_jobs_notes_list_by_name**](ExtrasApi.md#extras_jobs_notes_list_by_name) | **GET** /extras/jobs/{name}/notes/ |
[**extras_jobs_partial_update**](ExtrasApi.md#extras_jobs_partial_update) | **PATCH** /extras/jobs/{id}/ |
[**extras_jobs_partial_update_by_name**](ExtrasApi.md#extras_jobs_partial_update_by_name) | **PATCH** /extras/jobs/{name}/ |
[**extras_jobs_retrieve**](ExtrasApi.md#extras_jobs_retrieve) | **GET** /extras/jobs/{id}/ |
[**extras_jobs_retrieve_by_name**](ExtrasApi.md#extras_jobs_retrieve_by_name) | **GET** /extras/jobs/{name}/ |
[**extras_jobs_run_create**](ExtrasApi.md#extras_jobs_run_create) | **POST** /extras/jobs/{id}/run/ |
[**extras_jobs_run_create_by_name**](ExtrasApi.md#extras_jobs_run_create_by_name) | **POST** /extras/jobs/{name}/run/ |
[**extras_jobs_update**](ExtrasApi.md#extras_jobs_update) | **PUT** /extras/jobs/{id}/ |
[**extras_jobs_update_by_name**](ExtrasApi.md#extras_jobs_update_by_name) | **PUT** /extras/jobs/{name}/ |
[**extras_jobs_variables_list**](ExtrasApi.md#extras_jobs_variables_list) | **GET** /extras/jobs/{id}/variables/ |
[**extras_jobs_variables_list_by_name**](ExtrasApi.md#extras_jobs_variables_list_by_name) | **GET** /extras/jobs/{name}/variables/ |
[**extras_metadata_choices_bulk_destroy**](ExtrasApi.md#extras_metadata_choices_bulk_destroy) | **DELETE** /extras/metadata-choices/ |
[**extras_metadata_choices_bulk_partial_update**](ExtrasApi.md#extras_metadata_choices_bulk_partial_update) | **PATCH** /extras/metadata-choices/ |
[**extras_metadata_choices_bulk_update**](ExtrasApi.md#extras_metadata_choices_bulk_update) | **PUT** /extras/metadata-choices/ |
[**extras_metadata_choices_create**](ExtrasApi.md#extras_metadata_choices_create) | **POST** /extras/metadata-choices/ |
[**extras_metadata_choices_destroy**](ExtrasApi.md#extras_metadata_choices_destroy) | **DELETE** /extras/metadata-choices/{id}/ |
[**extras_metadata_choices_list**](ExtrasApi.md#extras_metadata_choices_list) | **GET** /extras/metadata-choices/ |
[**extras_metadata_choices_partial_update**](ExtrasApi.md#extras_metadata_choices_partial_update) | **PATCH** /extras/metadata-choices/{id}/ |
[**extras_metadata_choices_retrieve**](ExtrasApi.md#extras_metadata_choices_retrieve) | **GET** /extras/metadata-choices/{id}/ |
[**extras_metadata_choices_update**](ExtrasApi.md#extras_metadata_choices_update) | **PUT** /extras/metadata-choices/{id}/ |
[**extras_metadata_types_bulk_destroy**](ExtrasApi.md#extras_metadata_types_bulk_destroy) | **DELETE** /extras/metadata-types/ |
[**extras_metadata_types_bulk_partial_update**](ExtrasApi.md#extras_metadata_types_bulk_partial_update) | **PATCH** /extras/metadata-types/ |
[**extras_metadata_types_bulk_update**](ExtrasApi.md#extras_metadata_types_bulk_update) | **PUT** /extras/metadata-types/ |
[**extras_metadata_types_create**](ExtrasApi.md#extras_metadata_types_create) | **POST** /extras/metadata-types/ |
[**extras_metadata_types_destroy**](ExtrasApi.md#extras_metadata_types_destroy) | **DELETE** /extras/metadata-types/{id}/ |
[**extras_metadata_types_list**](ExtrasApi.md#extras_metadata_types_list) | **GET** /extras/metadata-types/ |
[**extras_metadata_types_notes_create**](ExtrasApi.md#extras_metadata_types_notes_create) | **POST** /extras/metadata-types/{id}/notes/ |
[**extras_metadata_types_notes_list**](ExtrasApi.md#extras_metadata_types_notes_list) | **GET** /extras/metadata-types/{id}/notes/ |
[**extras_metadata_types_partial_update**](ExtrasApi.md#extras_metadata_types_partial_update) | **PATCH** /extras/metadata-types/{id}/ |
[**extras_metadata_types_retrieve**](ExtrasApi.md#extras_metadata_types_retrieve) | **GET** /extras/metadata-types/{id}/ |
[**extras_metadata_types_update**](ExtrasApi.md#extras_metadata_types_update) | **PUT** /extras/metadata-types/{id}/ |
[**extras_notes_bulk_destroy**](ExtrasApi.md#extras_notes_bulk_destroy) | **DELETE** /extras/notes/ |
[**extras_notes_bulk_partial_update**](ExtrasApi.md#extras_notes_bulk_partial_update) | **PATCH** /extras/notes/ |
[**extras_notes_bulk_update**](ExtrasApi.md#extras_notes_bulk_update) | **PUT** /extras/notes/ |
[**extras_notes_create**](ExtrasApi.md#extras_notes_create) | **POST** /extras/notes/ |
[**extras_notes_destroy**](ExtrasApi.md#extras_notes_destroy) | **DELETE** /extras/notes/{id}/ |
[**extras_notes_list**](ExtrasApi.md#extras_notes_list) | **GET** /extras/notes/ |
[**extras_notes_partial_update**](ExtrasApi.md#extras_notes_partial_update) | **PATCH** /extras/notes/{id}/ |
[**extras_notes_retrieve**](ExtrasApi.md#extras_notes_retrieve) | **GET** /extras/notes/{id}/ |
[**extras_notes_update**](ExtrasApi.md#extras_notes_update) | **PUT** /extras/notes/{id}/ |
[**extras_object_changes_list**](ExtrasApi.md#extras_object_changes_list) | **GET** /extras/object-changes/ |
[**extras_object_changes_retrieve**](ExtrasApi.md#extras_object_changes_retrieve) | **GET** /extras/object-changes/{id}/ |
[**extras_object_metadata_bulk_destroy**](ExtrasApi.md#extras_object_metadata_bulk_destroy) | **DELETE** /extras/object-metadata/ |
[**extras_object_metadata_bulk_partial_update**](ExtrasApi.md#extras_object_metadata_bulk_partial_update) | **PATCH** /extras/object-metadata/ |
[**extras_object_metadata_bulk_update**](ExtrasApi.md#extras_object_metadata_bulk_update) | **PUT** /extras/object-metadata/ |
[**extras_object_metadata_create**](ExtrasApi.md#extras_object_metadata_create) | **POST** /extras/object-metadata/ |
[**extras_object_metadata_destroy**](ExtrasApi.md#extras_object_metadata_destroy) | **DELETE** /extras/object-metadata/{id}/ |
[**extras_object_metadata_list**](ExtrasApi.md#extras_object_metadata_list) | **GET** /extras/object-metadata/ |
[**extras_object_metadata_partial_update**](ExtrasApi.md#extras_object_metadata_partial_update) | **PATCH** /extras/object-metadata/{id}/ |
[**extras_object_metadata_retrieve**](ExtrasApi.md#extras_object_metadata_retrieve) | **GET** /extras/object-metadata/{id}/ |
[**extras_object_metadata_update**](ExtrasApi.md#extras_object_metadata_update) | **PUT** /extras/object-metadata/{id}/ |
[**extras_relationship_associations_bulk_destroy**](ExtrasApi.md#extras_relationship_associations_bulk_destroy) | **DELETE** /extras/relationship-associations/ |
[**extras_relationship_associations_bulk_partial_update**](ExtrasApi.md#extras_relationship_associations_bulk_partial_update) | **PATCH** /extras/relationship-associations/ |
[**extras_relationship_associations_bulk_update**](ExtrasApi.md#extras_relationship_associations_bulk_update) | **PUT** /extras/relationship-associations/ |
[**extras_relationship_associations_create**](ExtrasApi.md#extras_relationship_associations_create) | **POST** /extras/relationship-associations/ |
[**extras_relationship_associations_destroy**](ExtrasApi.md#extras_relationship_associations_destroy) | **DELETE** /extras/relationship-associations/{id}/ |
[**extras_relationship_associations_list**](ExtrasApi.md#extras_relationship_associations_list) | **GET** /extras/relationship-associations/ |
[**extras_relationship_associations_partial_update**](ExtrasApi.md#extras_relationship_associations_partial_update) | **PATCH** /extras/relationship-associations/{id}/ |
[**extras_relationship_associations_retrieve**](ExtrasApi.md#extras_relationship_associations_retrieve) | **GET** /extras/relationship-associations/{id}/ |
[**extras_relationship_associations_update**](ExtrasApi.md#extras_relationship_associations_update) | **PUT** /extras/relationship-associations/{id}/ |
[**extras_relationships_bulk_destroy**](ExtrasApi.md#extras_relationships_bulk_destroy) | **DELETE** /extras/relationships/ |
[**extras_relationships_bulk_partial_update**](ExtrasApi.md#extras_relationships_bulk_partial_update) | **PATCH** /extras/relationships/ |
[**extras_relationships_bulk_update**](ExtrasApi.md#extras_relationships_bulk_update) | **PUT** /extras/relationships/ |
[**extras_relationships_create**](ExtrasApi.md#extras_relationships_create) | **POST** /extras/relationships/ |
[**extras_relationships_destroy**](ExtrasApi.md#extras_relationships_destroy) | **DELETE** /extras/relationships/{id}/ |
[**extras_relationships_list**](ExtrasApi.md#extras_relationships_list) | **GET** /extras/relationships/ |
[**extras_relationships_notes_create**](ExtrasApi.md#extras_relationships_notes_create) | **POST** /extras/relationships/{id}/notes/ |
[**extras_relationships_notes_list**](ExtrasApi.md#extras_relationships_notes_list) | **GET** /extras/relationships/{id}/notes/ |
[**extras_relationships_partial_update**](ExtrasApi.md#extras_relationships_partial_update) | **PATCH** /extras/relationships/{id}/ |
[**extras_relationships_retrieve**](ExtrasApi.md#extras_relationships_retrieve) | **GET** /extras/relationships/{id}/ |
[**extras_relationships_update**](ExtrasApi.md#extras_relationships_update) | **PUT** /extras/relationships/{id}/ |
[**extras_roles_bulk_destroy**](ExtrasApi.md#extras_roles_bulk_destroy) | **DELETE** /extras/roles/ |
[**extras_roles_bulk_partial_update**](ExtrasApi.md#extras_roles_bulk_partial_update) | **PATCH** /extras/roles/ |
[**extras_roles_bulk_update**](ExtrasApi.md#extras_roles_bulk_update) | **PUT** /extras/roles/ |
[**extras_roles_create**](ExtrasApi.md#extras_roles_create) | **POST** /extras/roles/ |
[**extras_roles_destroy**](ExtrasApi.md#extras_roles_destroy) | **DELETE** /extras/roles/{id}/ |
[**extras_roles_list**](ExtrasApi.md#extras_roles_list) | **GET** /extras/roles/ |
[**extras_roles_notes_create**](ExtrasApi.md#extras_roles_notes_create) | **POST** /extras/roles/{id}/notes/ |
[**extras_roles_notes_list**](ExtrasApi.md#extras_roles_notes_list) | **GET** /extras/roles/{id}/notes/ |
[**extras_roles_partial_update**](ExtrasApi.md#extras_roles_partial_update) | **PATCH** /extras/roles/{id}/ |
[**extras_roles_retrieve**](ExtrasApi.md#extras_roles_retrieve) | **GET** /extras/roles/{id}/ |
[**extras_roles_update**](ExtrasApi.md#extras_roles_update) | **PUT** /extras/roles/{id}/ |
[**extras_saved_views_bulk_destroy**](ExtrasApi.md#extras_saved_views_bulk_destroy) | **DELETE** /extras/saved-views/ |
[**extras_saved_views_bulk_partial_update**](ExtrasApi.md#extras_saved_views_bulk_partial_update) | **PATCH** /extras/saved-views/ |
[**extras_saved_views_bulk_update**](ExtrasApi.md#extras_saved_views_bulk_update) | **PUT** /extras/saved-views/ |
[**extras_saved_views_create**](ExtrasApi.md#extras_saved_views_create) | **POST** /extras/saved-views/ |
[**extras_saved_views_destroy**](ExtrasApi.md#extras_saved_views_destroy) | **DELETE** /extras/saved-views/{id}/ |
[**extras_saved_views_list**](ExtrasApi.md#extras_saved_views_list) | **GET** /extras/saved-views/ |
[**extras_saved_views_partial_update**](ExtrasApi.md#extras_saved_views_partial_update) | **PATCH** /extras/saved-views/{id}/ |
[**extras_saved_views_retrieve**](ExtrasApi.md#extras_saved_views_retrieve) | **GET** /extras/saved-views/{id}/ |
[**extras_saved_views_update**](ExtrasApi.md#extras_saved_views_update) | **PUT** /extras/saved-views/{id}/ |
[**extras_scheduled_jobs_approve_create**](ExtrasApi.md#extras_scheduled_jobs_approve_create) | **POST** /extras/scheduled-jobs/{id}/approve/ |
[**extras_scheduled_jobs_bulk_destroy**](ExtrasApi.md#extras_scheduled_jobs_bulk_destroy) | **DELETE** /extras/scheduled-jobs/ |
[**extras_scheduled_jobs_deny_create**](ExtrasApi.md#extras_scheduled_jobs_deny_create) | **POST** /extras/scheduled-jobs/{id}/deny/ |
[**extras_scheduled_jobs_destroy**](ExtrasApi.md#extras_scheduled_jobs_destroy) | **DELETE** /extras/scheduled-jobs/{id}/ |
[**extras_scheduled_jobs_dry_run_create**](ExtrasApi.md#extras_scheduled_jobs_dry_run_create) | **POST** /extras/scheduled-jobs/{id}/dry-run/ |
[**extras_scheduled_jobs_list**](ExtrasApi.md#extras_scheduled_jobs_list) | **GET** /extras/scheduled-jobs/ |
[**extras_scheduled_jobs_retrieve**](ExtrasApi.md#extras_scheduled_jobs_retrieve) | **GET** /extras/scheduled-jobs/{id}/ |
[**extras_secrets_bulk_destroy**](ExtrasApi.md#extras_secrets_bulk_destroy) | **DELETE** /extras/secrets/ |
[**extras_secrets_bulk_partial_update**](ExtrasApi.md#extras_secrets_bulk_partial_update) | **PATCH** /extras/secrets/ |
[**extras_secrets_bulk_update**](ExtrasApi.md#extras_secrets_bulk_update) | **PUT** /extras/secrets/ |
[**extras_secrets_check_retrieve**](ExtrasApi.md#extras_secrets_check_retrieve) | **GET** /extras/secrets/{id}/check/ |
[**extras_secrets_create**](ExtrasApi.md#extras_secrets_create) | **POST** /extras/secrets/ |
[**extras_secrets_destroy**](ExtrasApi.md#extras_secrets_destroy) | **DELETE** /extras/secrets/{id}/ |
[**extras_secrets_groups_associations_bulk_destroy**](ExtrasApi.md#extras_secrets_groups_associations_bulk_destroy) | **DELETE** /extras/secrets-groups-associations/ |
[**extras_secrets_groups_associations_bulk_partial_update**](ExtrasApi.md#extras_secrets_groups_associations_bulk_partial_update) | **PATCH** /extras/secrets-groups-associations/ |
[**extras_secrets_groups_associations_bulk_update**](ExtrasApi.md#extras_secrets_groups_associations_bulk_update) | **PUT** /extras/secrets-groups-associations/ |
[**extras_secrets_groups_associations_create**](ExtrasApi.md#extras_secrets_groups_associations_create) | **POST** /extras/secrets-groups-associations/ |
[**extras_secrets_groups_associations_destroy**](ExtrasApi.md#extras_secrets_groups_associations_destroy) | **DELETE** /extras/secrets-groups-associations/{id}/ |
[**extras_secrets_groups_associations_list**](ExtrasApi.md#extras_secrets_groups_associations_list) | **GET** /extras/secrets-groups-associations/ |
[**extras_secrets_groups_associations_partial_update**](ExtrasApi.md#extras_secrets_groups_associations_partial_update) | **PATCH** /extras/secrets-groups-associations/{id}/ |
[**extras_secrets_groups_associations_retrieve**](ExtrasApi.md#extras_secrets_groups_associations_retrieve) | **GET** /extras/secrets-groups-associations/{id}/ |
[**extras_secrets_groups_associations_update**](ExtrasApi.md#extras_secrets_groups_associations_update) | **PUT** /extras/secrets-groups-associations/{id}/ |
[**extras_secrets_groups_bulk_destroy**](ExtrasApi.md#extras_secrets_groups_bulk_destroy) | **DELETE** /extras/secrets-groups/ |
[**extras_secrets_groups_bulk_partial_update**](ExtrasApi.md#extras_secrets_groups_bulk_partial_update) | **PATCH** /extras/secrets-groups/ |
[**extras_secrets_groups_bulk_update**](ExtrasApi.md#extras_secrets_groups_bulk_update) | **PUT** /extras/secrets-groups/ |
[**extras_secrets_groups_create**](ExtrasApi.md#extras_secrets_groups_create) | **POST** /extras/secrets-groups/ |
[**extras_secrets_groups_destroy**](ExtrasApi.md#extras_secrets_groups_destroy) | **DELETE** /extras/secrets-groups/{id}/ |
[**extras_secrets_groups_list**](ExtrasApi.md#extras_secrets_groups_list) | **GET** /extras/secrets-groups/ |
[**extras_secrets_groups_notes_create**](ExtrasApi.md#extras_secrets_groups_notes_create) | **POST** /extras/secrets-groups/{id}/notes/ |
[**extras_secrets_groups_notes_list**](ExtrasApi.md#extras_secrets_groups_notes_list) | **GET** /extras/secrets-groups/{id}/notes/ |
[**extras_secrets_groups_partial_update**](ExtrasApi.md#extras_secrets_groups_partial_update) | **PATCH** /extras/secrets-groups/{id}/ |
[**extras_secrets_groups_retrieve**](ExtrasApi.md#extras_secrets_groups_retrieve) | **GET** /extras/secrets-groups/{id}/ |
[**extras_secrets_groups_update**](ExtrasApi.md#extras_secrets_groups_update) | **PUT** /extras/secrets-groups/{id}/ |
[**extras_secrets_list**](ExtrasApi.md#extras_secrets_list) | **GET** /extras/secrets/ |
[**extras_secrets_notes_create**](ExtrasApi.md#extras_secrets_notes_create) | **POST** /extras/secrets/{id}/notes/ |
[**extras_secrets_notes_list**](ExtrasApi.md#extras_secrets_notes_list) | **GET** /extras/secrets/{id}/notes/ |
[**extras_secrets_partial_update**](ExtrasApi.md#extras_secrets_partial_update) | **PATCH** /extras/secrets/{id}/ |
[**extras_secrets_retrieve**](ExtrasApi.md#extras_secrets_retrieve) | **GET** /extras/secrets/{id}/ |
[**extras_secrets_update**](ExtrasApi.md#extras_secrets_update) | **PUT** /extras/secrets/{id}/ |
[**extras_static_group_associations_bulk_destroy**](ExtrasApi.md#extras_static_group_associations_bulk_destroy) | **DELETE** /extras/static-group-associations/ |
[**extras_static_group_associations_bulk_partial_update**](ExtrasApi.md#extras_static_group_associations_bulk_partial_update) | **PATCH** /extras/static-group-associations/ |
[**extras_static_group_associations_bulk_update**](ExtrasApi.md#extras_static_group_associations_bulk_update) | **PUT** /extras/static-group-associations/ |
[**extras_static_group_associations_create**](ExtrasApi.md#extras_static_group_associations_create) | **POST** /extras/static-group-associations/ |
[**extras_static_group_associations_destroy**](ExtrasApi.md#extras_static_group_associations_destroy) | **DELETE** /extras/static-group-associations/{id}/ |
[**extras_static_group_associations_list**](ExtrasApi.md#extras_static_group_associations_list) | **GET** /extras/static-group-associations/ |
[**extras_static_group_associations_notes_create**](ExtrasApi.md#extras_static_group_associations_notes_create) | **POST** /extras/static-group-associations/{id}/notes/ |
[**extras_static_group_associations_notes_list**](ExtrasApi.md#extras_static_group_associations_notes_list) | **GET** /extras/static-group-associations/{id}/notes/ |
[**extras_static_group_associations_partial_update**](ExtrasApi.md#extras_static_group_associations_partial_update) | **PATCH** /extras/static-group-associations/{id}/ |
[**extras_static_group_associations_retrieve**](ExtrasApi.md#extras_static_group_associations_retrieve) | **GET** /extras/static-group-associations/{id}/ |
[**extras_static_group_associations_update**](ExtrasApi.md#extras_static_group_associations_update) | **PUT** /extras/static-group-associations/{id}/ |
[**extras_statuses_bulk_destroy**](ExtrasApi.md#extras_statuses_bulk_destroy) | **DELETE** /extras/statuses/ |
[**extras_statuses_bulk_partial_update**](ExtrasApi.md#extras_statuses_bulk_partial_update) | **PATCH** /extras/statuses/ |
[**extras_statuses_bulk_update**](ExtrasApi.md#extras_statuses_bulk_update) | **PUT** /extras/statuses/ |
[**extras_statuses_create**](ExtrasApi.md#extras_statuses_create) | **POST** /extras/statuses/ |
[**extras_statuses_destroy**](ExtrasApi.md#extras_statuses_destroy) | **DELETE** /extras/statuses/{id}/ |
[**extras_statuses_list**](ExtrasApi.md#extras_statuses_list) | **GET** /extras/statuses/ |
[**extras_statuses_notes_create**](ExtrasApi.md#extras_statuses_notes_create) | **POST** /extras/statuses/{id}/notes/ |
[**extras_statuses_notes_list**](ExtrasApi.md#extras_statuses_notes_list) | **GET** /extras/statuses/{id}/notes/ |
[**extras_statuses_partial_update**](ExtrasApi.md#extras_statuses_partial_update) | **PATCH** /extras/statuses/{id}/ |
[**extras_statuses_retrieve**](ExtrasApi.md#extras_statuses_retrieve) | **GET** /extras/statuses/{id}/ |
[**extras_statuses_update**](ExtrasApi.md#extras_statuses_update) | **PUT** /extras/statuses/{id}/ |
[**extras_tags_bulk_destroy**](ExtrasApi.md#extras_tags_bulk_destroy) | **DELETE** /extras/tags/ |
[**extras_tags_bulk_partial_update**](ExtrasApi.md#extras_tags_bulk_partial_update) | **PATCH** /extras/tags/ |
[**extras_tags_bulk_update**](ExtrasApi.md#extras_tags_bulk_update) | **PUT** /extras/tags/ |
[**extras_tags_create**](ExtrasApi.md#extras_tags_create) | **POST** /extras/tags/ |
[**extras_tags_destroy**](ExtrasApi.md#extras_tags_destroy) | **DELETE** /extras/tags/{id}/ |
[**extras_tags_list**](ExtrasApi.md#extras_tags_list) | **GET** /extras/tags/ |
[**extras_tags_notes_create**](ExtrasApi.md#extras_tags_notes_create) | **POST** /extras/tags/{id}/notes/ |
[**extras_tags_notes_list**](ExtrasApi.md#extras_tags_notes_list) | **GET** /extras/tags/{id}/notes/ |
[**extras_tags_partial_update**](ExtrasApi.md#extras_tags_partial_update) | **PATCH** /extras/tags/{id}/ |
[**extras_tags_retrieve**](ExtrasApi.md#extras_tags_retrieve) | **GET** /extras/tags/{id}/ |
[**extras_tags_update**](ExtrasApi.md#extras_tags_update) | **PUT** /extras/tags/{id}/ |
[**extras_teams_bulk_destroy**](ExtrasApi.md#extras_teams_bulk_destroy) | **DELETE** /extras/teams/ |
[**extras_teams_bulk_partial_update**](ExtrasApi.md#extras_teams_bulk_partial_update) | **PATCH** /extras/teams/ |
[**extras_teams_bulk_update**](ExtrasApi.md#extras_teams_bulk_update) | **PUT** /extras/teams/ |
[**extras_teams_create**](ExtrasApi.md#extras_teams_create) | **POST** /extras/teams/ |
[**extras_teams_destroy**](ExtrasApi.md#extras_teams_destroy) | **DELETE** /extras/teams/{id}/ |
[**extras_teams_list**](ExtrasApi.md#extras_teams_list) | **GET** /extras/teams/ |
[**extras_teams_notes_create**](ExtrasApi.md#extras_teams_notes_create) | **POST** /extras/teams/{id}/notes/ |
[**extras_teams_notes_list**](ExtrasApi.md#extras_teams_notes_list) | **GET** /extras/teams/{id}/notes/ |
[**extras_teams_partial_update**](ExtrasApi.md#extras_teams_partial_update) | **PATCH** /extras/teams/{id}/ |
[**extras_teams_retrieve**](ExtrasApi.md#extras_teams_retrieve) | **GET** /extras/teams/{id}/ |
[**extras_teams_update**](ExtrasApi.md#extras_teams_update) | **PUT** /extras/teams/{id}/ |
[**extras_user_saved_view_associations_bulk_destroy**](ExtrasApi.md#extras_user_saved_view_associations_bulk_destroy) | **DELETE** /extras/user-saved-view-associations/ |
[**extras_user_saved_view_associations_bulk_partial_update**](ExtrasApi.md#extras_user_saved_view_associations_bulk_partial_update) | **PATCH** /extras/user-saved-view-associations/ |
[**extras_user_saved_view_associations_bulk_update**](ExtrasApi.md#extras_user_saved_view_associations_bulk_update) | **PUT** /extras/user-saved-view-associations/ |
[**extras_user_saved_view_associations_create**](ExtrasApi.md#extras_user_saved_view_associations_create) | **POST** /extras/user-saved-view-associations/ |
[**extras_user_saved_view_associations_destroy**](ExtrasApi.md#extras_user_saved_view_associations_destroy) | **DELETE** /extras/user-saved-view-associations/{id}/ |
[**extras_user_saved_view_associations_list**](ExtrasApi.md#extras_user_saved_view_associations_list) | **GET** /extras/user-saved-view-associations/ |
[**extras_user_saved_view_associations_partial_update**](ExtrasApi.md#extras_user_saved_view_associations_partial_update) | **PATCH** /extras/user-saved-view-associations/{id}/ |
[**extras_user_saved_view_associations_retrieve**](ExtrasApi.md#extras_user_saved_view_associations_retrieve) | **GET** /extras/user-saved-view-associations/{id}/ |
[**extras_user_saved_view_associations_update**](ExtrasApi.md#extras_user_saved_view_associations_update) | **PUT** /extras/user-saved-view-associations/{id}/ |
[**extras_webhooks_bulk_destroy**](ExtrasApi.md#extras_webhooks_bulk_destroy) | **DELETE** /extras/webhooks/ |
[**extras_webhooks_bulk_partial_update**](ExtrasApi.md#extras_webhooks_bulk_partial_update) | **PATCH** /extras/webhooks/ |
[**extras_webhooks_bulk_update**](ExtrasApi.md#extras_webhooks_bulk_update) | **PUT** /extras/webhooks/ |
[**extras_webhooks_create**](ExtrasApi.md#extras_webhooks_create) | **POST** /extras/webhooks/ |
[**extras_webhooks_destroy**](ExtrasApi.md#extras_webhooks_destroy) | **DELETE** /extras/webhooks/{id}/ |
[**extras_webhooks_list**](ExtrasApi.md#extras_webhooks_list) | **GET** /extras/webhooks/ |
[**extras_webhooks_notes_create**](ExtrasApi.md#extras_webhooks_notes_create) | **POST** /extras/webhooks/{id}/notes/ |
[**extras_webhooks_notes_list**](ExtrasApi.md#extras_webhooks_notes_list) | **GET** /extras/webhooks/{id}/notes/ |
[**extras_webhooks_partial_update**](ExtrasApi.md#extras_webhooks_partial_update) | **PATCH** /extras/webhooks/{id}/ |
[**extras_webhooks_retrieve**](ExtrasApi.md#extras_webhooks_retrieve) | **GET** /extras/webhooks/{id}/ |
[**extras_webhooks_update**](ExtrasApi.md#extras_webhooks_update) | **PUT** /extras/webhooks/{id}/ |
## extras_computed_fields_bulk_destroy
> extras_computed_fields_bulk_destroy(bulk_operation_request, format)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_bulk_partial_update
> Vec<crate::models::ComputedField> extras_computed_fields_bulk_partial_update(patched_bulk_writable_computed_field_request, format)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_computed_field_request** | [**Vec<crate::models::PatchedBulkWritableComputedFieldRequest>**](PatchedBulkWritableComputedFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ComputedField>**](ComputedField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_bulk_update
> Vec<crate::models::ComputedField> extras_computed_fields_bulk_update(bulk_writable_computed_field_request, format)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_computed_field_request** | [**Vec<crate::models::BulkWritableComputedFieldRequest>**](BulkWritableComputedFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ComputedField>**](ComputedField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_create
> crate::models::ComputedField extras_computed_fields_create(computed_field_request, format)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**computed_field_request** | [**ComputedFieldRequest**](ComputedFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ComputedField**](ComputedField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_destroy
> extras_computed_fields_destroy(id, format)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this computed field. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_list
> crate::models::PaginatedComputedFieldList extras_computed_fields_list(contacts, contacts__isnull, contacts__n, content_type, content_type__n, dynamic_groups, dynamic_groups__n, fallback_value, fallback_value__ic, fallback_value__ie, fallback_value__iew, fallback_value__ire, fallback_value__isw, fallback_value__n, fallback_value__nic, fallback_value__nie, fallback_value__niew, fallback_value__nire, fallback_value__nisw, fallback_value__nre, fallback_value__re, format, grouping, grouping__ic, grouping__ie, grouping__iew, grouping__ire, grouping__isw, grouping__n, grouping__nic, grouping__nie, grouping__niew, grouping__nire, grouping__nisw, grouping__nre, grouping__re, id, id__n, key, key__ic, key__ie, key__iew, key__ire, key__isw, key__n, key__nic, key__nie, key__niew, key__nire, key__nisw, key__nre, key__re, limit, offset, q, sort, teams, teams__isnull, teams__n, template, template__ic, template__ie, template__iew, template__ire, template__isw, template__n, template__nic, template__nie, template__niew, template__nire, template__nisw, template__nre, template__re, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_type** | Option<**String**> | | |
**content_type__n** | Option<**String**> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__ic** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__ie** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__iew** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__ire** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__isw** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__n** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__nic** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__nie** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__niew** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__nire** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__nisw** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__nre** | Option<[**Vec<String>**](String.md)> | | |
**fallback_value__re** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**grouping** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__iew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__isw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__n** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__niew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nisw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nre** | Option<[**Vec<String>**](String.md)> | | |
**grouping__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**key** | Option<[**Vec<String>**](String.md)> | | |
**key__ic** | Option<[**Vec<String>**](String.md)> | | |
**key__ie** | Option<[**Vec<String>**](String.md)> | | |
**key__iew** | Option<[**Vec<String>**](String.md)> | | |
**key__ire** | Option<[**Vec<String>**](String.md)> | | |
**key__isw** | Option<[**Vec<String>**](String.md)> | | |
**key__n** | Option<[**Vec<String>**](String.md)> | | |
**key__nic** | Option<[**Vec<String>**](String.md)> | | |
**key__nie** | Option<[**Vec<String>**](String.md)> | | |
**key__niew** | Option<[**Vec<String>**](String.md)> | | |
**key__nire** | Option<[**Vec<String>**](String.md)> | | |
**key__nisw** | Option<[**Vec<String>**](String.md)> | | |
**key__nre** | Option<[**Vec<String>**](String.md)> | | |
**key__re** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**template** | Option<[**Vec<String>**](String.md)> | | |
**template__ic** | Option<[**Vec<String>**](String.md)> | | |
**template__ie** | Option<[**Vec<String>**](String.md)> | | |
**template__iew** | Option<[**Vec<String>**](String.md)> | | |
**template__ire** | Option<[**Vec<String>**](String.md)> | | |
**template__isw** | Option<[**Vec<String>**](String.md)> | | |
**template__n** | Option<[**Vec<String>**](String.md)> | | |
**template__nic** | Option<[**Vec<String>**](String.md)> | | |
**template__nie** | Option<[**Vec<String>**](String.md)> | | |
**template__niew** | Option<[**Vec<String>**](String.md)> | | |
**template__nire** | Option<[**Vec<String>**](String.md)> | | |
**template__nisw** | Option<[**Vec<String>**](String.md)> | | |
**template__nre** | Option<[**Vec<String>**](String.md)> | | |
**template__re** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedComputedFieldList**](PaginatedComputedFieldList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_notes_create
> crate::models::Note extras_computed_fields_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this computed field. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_notes_list
> crate::models::PaginatedNoteList extras_computed_fields_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this computed field. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_partial_update
> crate::models::ComputedField extras_computed_fields_partial_update(id, format, patched_computed_field_request)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this computed field. | [required] |
**format** | Option<**String**> | | |
**patched_computed_field_request** | Option<[**PatchedComputedFieldRequest**](PatchedComputedFieldRequest.md)> | | |
### Return type
[**crate::models::ComputedField**](ComputedField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_retrieve
> crate::models::ComputedField extras_computed_fields_retrieve(id, format, depth, exclude_m2m)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this computed field. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ComputedField**](ComputedField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_computed_fields_update
> crate::models::ComputedField extras_computed_fields_update(id, computed_field_request, format)
Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this computed field. | [required] |
**computed_field_request** | [**ComputedFieldRequest**](ComputedFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ComputedField**](ComputedField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_bulk_destroy
> extras_config_context_schemas_bulk_destroy(bulk_operation_request, format)
Destroy a list of config context schema objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_bulk_partial_update
> Vec<crate::models::ConfigContextSchema> extras_config_context_schemas_bulk_partial_update(patched_bulk_writable_config_context_schema_request, format)
Partial update a list of config context schema objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_config_context_schema_request** | [**Vec<crate::models::PatchedBulkWritableConfigContextSchemaRequest>**](PatchedBulkWritableConfigContextSchemaRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ConfigContextSchema>**](ConfigContextSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_bulk_update
> Vec<crate::models::ConfigContextSchema> extras_config_context_schemas_bulk_update(bulk_writable_config_context_schema_request, format)
Update a list of config context schema objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_config_context_schema_request** | [**Vec<crate::models::BulkWritableConfigContextSchemaRequest>**](BulkWritableConfigContextSchemaRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ConfigContextSchema>**](ConfigContextSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_create
> crate::models::ConfigContextSchema extras_config_context_schemas_create(config_context_schema_request, format)
Create one or more config context schema objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**config_context_schema_request** | [**ConfigContextSchemaRequest**](ConfigContextSchemaRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ConfigContextSchema**](ConfigContextSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_destroy
> extras_config_context_schemas_destroy(id, format)
Destroy a config context schema object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context schema. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_list
> crate::models::PaginatedConfigContextSchemaList extras_config_context_schemas_list(contacts, contacts__isnull, contacts__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, id, id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, owner_content_type, owner_content_type__isnull, owner_content_type__n, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)
Retrieve a list of config context schema objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**description** | Option<[**Vec<String>**](String.md)> | | |
**description__ic** | Option<[**Vec<String>**](String.md)> | | |
**description__ie** | Option<[**Vec<String>**](String.md)> | | |
**description__iew** | Option<[**Vec<String>**](String.md)> | | |
**description__ire** | Option<[**Vec<String>**](String.md)> | | |
**description__isw** | Option<[**Vec<String>**](String.md)> | | |
**description__n** | Option<[**Vec<String>**](String.md)> | | |
**description__nic** | Option<[**Vec<String>**](String.md)> | | |
**description__nie** | Option<[**Vec<String>**](String.md)> | | |
**description__niew** | Option<[**Vec<String>**](String.md)> | | |
**description__nire** | Option<[**Vec<String>**](String.md)> | | |
**description__nisw** | Option<[**Vec<String>**](String.md)> | | |
**description__nre** | Option<[**Vec<String>**](String.md)> | | |
**description__re** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**owner_content_type** | Option<**String**> | | |
**owner_content_type__isnull** | Option<**bool**> | | |
**owner_content_type__n** | Option<**String**> | | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedConfigContextSchemaList**](PaginatedConfigContextSchemaList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_notes_create
> crate::models::Note extras_config_context_schemas_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context schema. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_notes_list
> crate::models::PaginatedNoteList extras_config_context_schemas_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context schema. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_partial_update
> crate::models::ConfigContextSchema extras_config_context_schemas_partial_update(id, format, patched_config_context_schema_request)
Partial update a config context schema object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context schema. | [required] |
**format** | Option<**String**> | | |
**patched_config_context_schema_request** | Option<[**PatchedConfigContextSchemaRequest**](PatchedConfigContextSchemaRequest.md)> | | |
### Return type
[**crate::models::ConfigContextSchema**](ConfigContextSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_retrieve
> crate::models::ConfigContextSchema extras_config_context_schemas_retrieve(id, format, depth, exclude_m2m)
Retrieve a config context schema object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context schema. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ConfigContextSchema**](ConfigContextSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_context_schemas_update
> crate::models::ConfigContextSchema extras_config_context_schemas_update(id, config_context_schema_request, format)
Update a config context schema object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context schema. | [required] |
**config_context_schema_request** | [**ConfigContextSchemaRequest**](ConfigContextSchemaRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ConfigContextSchema**](ConfigContextSchema.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_bulk_destroy
> extras_config_contexts_bulk_destroy(bulk_operation_request, format)
Destroy a list of config context objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_bulk_partial_update
> Vec<crate::models::ConfigContext> extras_config_contexts_bulk_partial_update(patched_bulk_writable_config_context_request, format)
Partial update a list of config context objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_config_context_request** | [**Vec<crate::models::PatchedBulkWritableConfigContextRequest>**](PatchedBulkWritableConfigContextRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ConfigContext>**](ConfigContext.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_bulk_update
> Vec<crate::models::ConfigContext> extras_config_contexts_bulk_update(bulk_writable_config_context_request, format)
Update a list of config context objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_config_context_request** | [**Vec<crate::models::BulkWritableConfigContextRequest>**](BulkWritableConfigContextRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ConfigContext>**](ConfigContext.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_create
> crate::models::ConfigContext extras_config_contexts_create(config_context_request, format)
Create one or more config context objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**config_context_request** | [**ConfigContextRequest**](ConfigContextRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ConfigContext**](ConfigContext.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_destroy
> extras_config_contexts_destroy(id, format)
Destroy a config context object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_list
> crate::models::PaginatedConfigContextList extras_config_contexts_list(cluster_group, cluster_group__n, cluster_group_id, cluster_group_id__n, cluster_id, cluster_id__n, contacts, contacts__isnull, contacts__n, device_redundancy_group, device_redundancy_group__n, device_type, device_type__n, device_type_id, device_type_id__n, format, id, id__n, is_active, limit, location, location__n, location_id, location_id__n, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, owner_content_type, owner_content_type__isnull, owner_content_type__n, owner_object_id, owner_object_id__isnull, owner_object_id__n, platform, platform__n, platform_id, platform_id__n, q, role, role__n, schema, schema__isnull, schema__n, sort, tag, tag__n, teams, teams__isnull, teams__n, tenant, tenant__n, tenant_group, tenant_group__n, tenant_group_id, tenant_group_id__n, tenant_id, tenant_id__n, depth, exclude_m2m)
Retrieve a list of config context objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cluster_group** | Option<[**Vec<String>**](String.md)> | | |
**cluster_group__n** | Option<[**Vec<String>**](String.md)> | | |
**cluster_group_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster group (ID) - Deprecated (use cluster_group filter) | |
**cluster_group_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster group (ID) - Deprecated (use cluster_group filter) | |
**cluster_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster (ID) | |
**cluster_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster (ID) | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**device_redundancy_group** | Option<[**Vec<String>**](String.md)> | | |
**device_redundancy_group__n** | Option<[**Vec<String>**](String.md)> | | |
**device_type** | Option<[**Vec<String>**](String.md)> | | |
**device_type__n** | Option<[**Vec<String>**](String.md)> | | |
**device_type_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Device Type (ID) - Deprecated (use device_type filter) | |
**device_type_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Device Type (ID) - Deprecated (use device_type filter) | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**is_active** | Option<**bool**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**location** | Option<[**Vec<String>**](String.md)> | | |
**location__n** | Option<[**Vec<String>**](String.md)> | | |
**location_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Location (ID) - Deprecated (use location filter) | |
**location_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Location (ID) - Deprecated (use location filter) | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**owner_content_type** | Option<**String**> | | |
**owner_content_type__isnull** | Option<**bool**> | | |
**owner_content_type__n** | Option<**String**> | | |
**owner_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**owner_object_id__isnull** | Option<**bool**> | | |
**owner_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**platform** | Option<[**Vec<String>**](String.md)> | | |
**platform__n** | Option<[**Vec<String>**](String.md)> | | |
**platform_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Platform (ID) - Deprecated (use platform filter) | |
**platform_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Platform (ID) - Deprecated (use platform filter) | |
**q** | Option<**String**> | Search | |
**role** | Option<[**Vec<String>**](String.md)> | | |
**role__n** | Option<[**Vec<String>**](String.md)> | | |
**schema** | Option<[**Vec<String>**](String.md)> | | |
**schema__isnull** | Option<**bool**> | Schema (name or PK) is null | |
**schema__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tag** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tag (name) | |
**tag__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tag (name) | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant** | Option<[**Vec<String>**](String.md)> | | |
**tenant__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant group (ID) - Deprecated (use tenant_group filter) | |
**tenant_group_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant group (ID) - Deprecated (use tenant_group filter) | |
**tenant_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant (ID) - Deprecated (use tenant filter) | |
**tenant_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant (ID) - Deprecated (use tenant filter) | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedConfigContextList**](PaginatedConfigContextList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_notes_create
> crate::models::Note extras_config_contexts_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_notes_list
> crate::models::PaginatedNoteList extras_config_contexts_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_partial_update
> crate::models::ConfigContext extras_config_contexts_partial_update(id, format, patched_config_context_request)
Partial update a config context object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context. | [required] |
**format** | Option<**String**> | | |
**patched_config_context_request** | Option<[**PatchedConfigContextRequest**](PatchedConfigContextRequest.md)> | | |
### Return type
[**crate::models::ConfigContext**](ConfigContext.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_retrieve
> crate::models::ConfigContext extras_config_contexts_retrieve(id, format, depth, exclude_m2m)
Retrieve a config context object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ConfigContext**](ConfigContext.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_config_contexts_update
> crate::models::ConfigContext extras_config_contexts_update(id, config_context_request, format)
Update a config context object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this config context. | [required] |
**config_context_request** | [**ConfigContextRequest**](ConfigContextRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ConfigContext**](ConfigContext.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_bulk_destroy
> extras_contact_associations_bulk_destroy(bulk_operation_request, format)
Destroy a list of contact association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_bulk_partial_update
> Vec<crate::models::ContactAssociation> extras_contact_associations_bulk_partial_update(patched_bulk_writable_contact_association_request, format)
Partial update a list of contact association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_contact_association_request** | [**Vec<crate::models::PatchedBulkWritableContactAssociationRequest>**](PatchedBulkWritableContactAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ContactAssociation>**](ContactAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_bulk_update
> Vec<crate::models::ContactAssociation> extras_contact_associations_bulk_update(bulk_writable_contact_association_request, format)
Update a list of contact association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_contact_association_request** | [**Vec<crate::models::BulkWritableContactAssociationRequest>**](BulkWritableContactAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ContactAssociation>**](ContactAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_create
> crate::models::ContactAssociation extras_contact_associations_create(contact_association_request, format)
Create one or more contact association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contact_association_request** | [**ContactAssociationRequest**](ContactAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ContactAssociation**](ContactAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_destroy
> extras_contact_associations_destroy(id, format)
Destroy a contact association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact association. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_list
> crate::models::PaginatedContactAssociationList extras_contact_associations_list(associated_object_id, associated_object_id__n, associated_object_type, associated_object_type__isnull, associated_object_type__n, contact, contact__isnull, contact__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, offset, q, role, role__n, sort, status, status__n, team, team__isnull, team__n, depth, exclude_m2m)
Retrieve a list of contact association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**associated_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**associated_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**associated_object_type** | Option<**String**> | | |
**associated_object_type__isnull** | Option<**bool**> | | |
**associated_object_type__n** | Option<**String**> | | |
**contact** | Option<[**Vec<String>**](String.md)> | | |
**contact__isnull** | Option<**bool**> | Contact (name or ID) is null | |
**contact__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**role** | Option<[**Vec<String>**](String.md)> | | |
**role__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**status** | Option<[**Vec<String>**](String.md)> | | |
**status__n** | Option<[**Vec<String>**](String.md)> | | |
**team** | Option<[**Vec<String>**](String.md)> | | |
**team__isnull** | Option<**bool**> | Team (name or ID) is null | |
**team__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedContactAssociationList**](PaginatedContactAssociationList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_notes_create
> crate::models::Note extras_contact_associations_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact association. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_notes_list
> crate::models::PaginatedNoteList extras_contact_associations_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact association. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_partial_update
> crate::models::ContactAssociation extras_contact_associations_partial_update(id, format, patched_contact_association_request)
Partial update a contact association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact association. | [required] |
**format** | Option<**String**> | | |
**patched_contact_association_request** | Option<[**PatchedContactAssociationRequest**](PatchedContactAssociationRequest.md)> | | |
### Return type
[**crate::models::ContactAssociation**](ContactAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_retrieve
> crate::models::ContactAssociation extras_contact_associations_retrieve(id, format, depth, exclude_m2m)
Retrieve a contact association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact association. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ContactAssociation**](ContactAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contact_associations_update
> crate::models::ContactAssociation extras_contact_associations_update(id, contact_association_request, format)
Update a contact association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact association. | [required] |
**contact_association_request** | [**ContactAssociationRequest**](ContactAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ContactAssociation**](ContactAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_bulk_destroy
> extras_contacts_bulk_destroy(bulk_operation_request, format)
Destroy a list of contact objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_bulk_partial_update
> Vec<crate::models::Contact> extras_contacts_bulk_partial_update(patched_bulk_writable_contact_request, format)
Partial update a list of contact objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_contact_request** | [**Vec<crate::models::PatchedBulkWritableContactRequest>**](PatchedBulkWritableContactRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Contact>**](Contact.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_bulk_update
> Vec<crate::models::Contact> extras_contacts_bulk_update(bulk_writable_contact_request, format)
Update a list of contact objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_contact_request** | [**Vec<crate::models::BulkWritableContactRequest>**](BulkWritableContactRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Contact>**](Contact.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_create
> crate::models::Contact extras_contacts_create(contact_request, format)
Create one or more contact objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contact_request** | [**ContactRequest**](ContactRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Contact**](Contact.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_destroy
> extras_contacts_destroy(id, format)
Destroy a contact object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_list
> crate::models::PaginatedContactList extras_contacts_list(address, address__ic, address__ie, address__iew, address__ire, address__isw, address__n, address__nic, address__nie, address__niew, address__nire, address__nisw, address__nre, address__re, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, email, email__ic, email__ie, email__iew, email__ire, email__isw, email__n, email__nic, email__nie, email__niew, email__nire, email__nisw, email__nre, email__re, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, phone, phone__ic, phone__ie, phone__iew, phone__ire, phone__isw, phone__n, phone__nic, phone__nie, phone__niew, phone__nire, phone__nisw, phone__nre, phone__re, q, similar_to_location_data, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, depth, exclude_m2m)
Retrieve a list of contact objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**address** | Option<[**Vec<String>**](String.md)> | | |
**address__ic** | Option<[**Vec<String>**](String.md)> | | |
**address__ie** | Option<[**Vec<String>**](String.md)> | | |
**address__iew** | Option<[**Vec<String>**](String.md)> | | |
**address__ire** | Option<[**Vec<String>**](String.md)> | | |
**address__isw** | Option<[**Vec<String>**](String.md)> | | |
**address__n** | Option<[**Vec<String>**](String.md)> | | |
**address__nic** | Option<[**Vec<String>**](String.md)> | | |
**address__nie** | Option<[**Vec<String>**](String.md)> | | |
**address__niew** | Option<[**Vec<String>**](String.md)> | | |
**address__nire** | Option<[**Vec<String>**](String.md)> | | |
**address__nisw** | Option<[**Vec<String>**](String.md)> | | |
**address__nre** | Option<[**Vec<String>**](String.md)> | | |
**address__re** | Option<[**Vec<String>**](String.md)> | | |
**comments** | Option<[**Vec<String>**](String.md)> | | |
**comments__ic** | Option<[**Vec<String>**](String.md)> | | |
**comments__ie** | Option<[**Vec<String>**](String.md)> | | |
**comments__iew** | Option<[**Vec<String>**](String.md)> | | |
**comments__ire** | Option<[**Vec<String>**](String.md)> | | |
**comments__isw** | Option<[**Vec<String>**](String.md)> | | |
**comments__n** | Option<[**Vec<String>**](String.md)> | | |
**comments__nic** | Option<[**Vec<String>**](String.md)> | | |
**comments__nie** | Option<[**Vec<String>**](String.md)> | | |
**comments__niew** | Option<[**Vec<String>**](String.md)> | | |
**comments__nire** | Option<[**Vec<String>**](String.md)> | | |
**comments__nisw** | Option<[**Vec<String>**](String.md)> | | |
**comments__nre** | Option<[**Vec<String>**](String.md)> | | |
**comments__re** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**email** | Option<[**Vec<String>**](String.md)> | | |
**email__ic** | Option<[**Vec<String>**](String.md)> | | |
**email__ie** | Option<[**Vec<String>**](String.md)> | | |
**email__iew** | Option<[**Vec<String>**](String.md)> | | |
**email__ire** | Option<[**Vec<String>**](String.md)> | | |
**email__isw** | Option<[**Vec<String>**](String.md)> | | |
**email__n** | Option<[**Vec<String>**](String.md)> | | |
**email__nic** | Option<[**Vec<String>**](String.md)> | | |
**email__nie** | Option<[**Vec<String>**](String.md)> | | |
**email__niew** | Option<[**Vec<String>**](String.md)> | | |
**email__nire** | Option<[**Vec<String>**](String.md)> | | |
**email__nisw** | Option<[**Vec<String>**](String.md)> | | |
**email__nre** | Option<[**Vec<String>**](String.md)> | | |
**email__re** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**phone** | Option<[**Vec<String>**](String.md)> | | |
**phone__ic** | Option<[**Vec<String>**](String.md)> | | |
**phone__ie** | Option<[**Vec<String>**](String.md)> | | |
**phone__iew** | Option<[**Vec<String>**](String.md)> | | |
**phone__ire** | Option<[**Vec<String>**](String.md)> | | |
**phone__isw** | Option<[**Vec<String>**](String.md)> | | |
**phone__n** | Option<[**Vec<String>**](String.md)> | | |
**phone__nic** | Option<[**Vec<String>**](String.md)> | | |
**phone__nie** | Option<[**Vec<String>**](String.md)> | | |
**phone__niew** | Option<[**Vec<String>**](String.md)> | | |
**phone__nire** | Option<[**Vec<String>**](String.md)> | | |
**phone__nisw** | Option<[**Vec<String>**](String.md)> | | |
**phone__nre** | Option<[**Vec<String>**](String.md)> | | |
**phone__re** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**similar_to_location_data** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Team (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedContactList**](PaginatedContactList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_notes_create
> crate::models::Note extras_contacts_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_notes_list
> crate::models::PaginatedNoteList extras_contacts_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_partial_update
> crate::models::Contact extras_contacts_partial_update(id, format, patched_contact_request)
Partial update a contact object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact. | [required] |
**format** | Option<**String**> | | |
**patched_contact_request** | Option<[**PatchedContactRequest**](PatchedContactRequest.md)> | | |
### Return type
[**crate::models::Contact**](Contact.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_retrieve
> crate::models::Contact extras_contacts_retrieve(id, format, depth, exclude_m2m)
Retrieve a contact object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Contact**](Contact.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_contacts_update
> crate::models::Contact extras_contacts_update(id, contact_request, format)
Update a contact object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this contact. | [required] |
**contact_request** | [**ContactRequest**](ContactRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Contact**](Contact.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_content_types_list
> crate::models::PaginatedContentTypeList extras_content_types_list(app_label, app_label__ic, app_label__ie, app_label__iew, app_label__ire, app_label__isw, app_label__n, app_label__nic, app_label__nie, app_label__niew, app_label__nire, app_label__nisw, app_label__nre, app_label__re, can_add, can_change, can_delete, can_view, feature, format, has_serializer, id, id__gt, id__gte, id__lt, id__lte, id__n, limit, model, model__ic, model__ie, model__iew, model__ire, model__isw, model__n, model__nic, model__nie, model__niew, model__nire, model__nisw, model__nre, model__re, offset, q, sort, depth, exclude_m2m)
Read-only list of ContentTypes. Limit results to ContentTypes pertinent to Nautobot objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_label** | Option<[**Vec<String>**](String.md)> | | |
**app_label__ic** | Option<[**Vec<String>**](String.md)> | | |
**app_label__ie** | Option<[**Vec<String>**](String.md)> | | |
**app_label__iew** | Option<[**Vec<String>**](String.md)> | | |
**app_label__ire** | Option<[**Vec<String>**](String.md)> | | |
**app_label__isw** | Option<[**Vec<String>**](String.md)> | | |
**app_label__n** | Option<[**Vec<String>**](String.md)> | | |
**app_label__nic** | Option<[**Vec<String>**](String.md)> | | |
**app_label__nie** | Option<[**Vec<String>**](String.md)> | | |
**app_label__niew** | Option<[**Vec<String>**](String.md)> | | |
**app_label__nire** | Option<[**Vec<String>**](String.md)> | | |
**app_label__nisw** | Option<[**Vec<String>**](String.md)> | | |
**app_label__nre** | Option<[**Vec<String>**](String.md)> | | |
**app_label__re** | Option<[**Vec<String>**](String.md)> | | |
**can_add** | Option<**bool**> | User can add objects of this type | |
**can_change** | Option<**bool**> | User can change objects of this type | |
**can_delete** | Option<**bool**> | User can delete objects of this type | |
**can_view** | Option<**bool**> | User can view objects of this type | |
**feature** | Option<**String**> | Objects of this type support the named feature | |
**format** | Option<**String**> | | |
**has_serializer** | Option<**bool**> | A REST API serializer exists for this type | |
**id** | Option<[**Vec<i32>**](i32.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**id__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**id__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**id__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**id__n** | Option<[**Vec<i32>**](i32.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**model** | Option<[**Vec<String>**](String.md)> | | |
**model__ic** | Option<[**Vec<String>**](String.md)> | | |
**model__ie** | Option<[**Vec<String>**](String.md)> | | |
**model__iew** | Option<[**Vec<String>**](String.md)> | | |
**model__ire** | Option<[**Vec<String>**](String.md)> | | |
**model__isw** | Option<[**Vec<String>**](String.md)> | | |
**model__n** | Option<[**Vec<String>**](String.md)> | | |
**model__nic** | Option<[**Vec<String>**](String.md)> | | |
**model__nie** | Option<[**Vec<String>**](String.md)> | | |
**model__niew** | Option<[**Vec<String>**](String.md)> | | |
**model__nire** | Option<[**Vec<String>**](String.md)> | | |
**model__nisw** | Option<[**Vec<String>**](String.md)> | | |
**model__nre** | Option<[**Vec<String>**](String.md)> | | |
**model__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedContentTypeList**](PaginatedContentTypeList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_content_types_retrieve
> crate::models::ContentType extras_content_types_retrieve(id, format, depth, exclude_m2m)
Read-only list of ContentTypes. Limit results to ContentTypes pertinent to Nautobot objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | A unique integer value identifying this content type. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ContentType**](ContentType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_bulk_destroy
> extras_custom_field_choices_bulk_destroy(bulk_operation_request, format)
Destroy a list of custom field choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_bulk_partial_update
> Vec<crate::models::CustomFieldChoice> extras_custom_field_choices_bulk_partial_update(patched_bulk_writable_custom_field_choice_request, format)
Partial update a list of custom field choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_custom_field_choice_request** | [**Vec<crate::models::PatchedBulkWritableCustomFieldChoiceRequest>**](PatchedBulkWritableCustomFieldChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::CustomFieldChoice>**](CustomFieldChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_bulk_update
> Vec<crate::models::CustomFieldChoice> extras_custom_field_choices_bulk_update(bulk_writable_custom_field_choice_request, format)
Update a list of custom field choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_custom_field_choice_request** | [**Vec<crate::models::BulkWritableCustomFieldChoiceRequest>**](BulkWritableCustomFieldChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::CustomFieldChoice>**](CustomFieldChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_create
> crate::models::CustomFieldChoice extras_custom_field_choices_create(custom_field_choice_request, format)
Create one or more custom field choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**custom_field_choice_request** | [**CustomFieldChoiceRequest**](CustomFieldChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::CustomFieldChoice**](CustomFieldChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_destroy
> extras_custom_field_choices_destroy(id, format)
Destroy a custom field choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field choice. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_list
> crate::models::PaginatedCustomFieldChoiceList extras_custom_field_choices_list(custom_field, custom_field__n, format, id, id__n, limit, offset, q, sort, value, value__ic, value__ie, value__iew, value__ire, value__isw, value__n, value__nic, value__nie, value__niew, value__nire, value__nisw, value__nre, value__re, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Retrieve a list of custom field choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**custom_field** | Option<[**Vec<String>**](String.md)> | | |
**custom_field__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**value** | Option<[**Vec<String>**](String.md)> | | |
**value__ic** | Option<[**Vec<String>**](String.md)> | | |
**value__ie** | Option<[**Vec<String>**](String.md)> | | |
**value__iew** | Option<[**Vec<String>**](String.md)> | | |
**value__ire** | Option<[**Vec<String>**](String.md)> | | |
**value__isw** | Option<[**Vec<String>**](String.md)> | | |
**value__n** | Option<[**Vec<String>**](String.md)> | | |
**value__nic** | Option<[**Vec<String>**](String.md)> | | |
**value__nie** | Option<[**Vec<String>**](String.md)> | | |
**value__niew** | Option<[**Vec<String>**](String.md)> | | |
**value__nire** | Option<[**Vec<String>**](String.md)> | | |
**value__nisw** | Option<[**Vec<String>**](String.md)> | | |
**value__nre** | Option<[**Vec<String>**](String.md)> | | |
**value__re** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedCustomFieldChoiceList**](PaginatedCustomFieldChoiceList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_partial_update
> crate::models::CustomFieldChoice extras_custom_field_choices_partial_update(id, format, patched_custom_field_choice_request)
Partial update a custom field choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field choice. | [required] |
**format** | Option<**String**> | | |
**patched_custom_field_choice_request** | Option<[**PatchedCustomFieldChoiceRequest**](PatchedCustomFieldChoiceRequest.md)> | | |
### Return type
[**crate::models::CustomFieldChoice**](CustomFieldChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_retrieve
> crate::models::CustomFieldChoice extras_custom_field_choices_retrieve(id, format, depth, exclude_m2m)
Retrieve a custom field choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field choice. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::CustomFieldChoice**](CustomFieldChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_field_choices_update
> crate::models::CustomFieldChoice extras_custom_field_choices_update(id, custom_field_choice_request, format)
Update a custom field choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field choice. | [required] |
**custom_field_choice_request** | [**CustomFieldChoiceRequest**](CustomFieldChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::CustomFieldChoice**](CustomFieldChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_bulk_destroy
> extras_custom_fields_bulk_destroy(bulk_operation_request, format)
Destroy a list of custom field objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_bulk_partial_update
> Vec<crate::models::CustomField> extras_custom_fields_bulk_partial_update(patched_bulk_writable_custom_field_request, format)
Partial update a list of custom field objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_custom_field_request** | [**Vec<crate::models::PatchedBulkWritableCustomFieldRequest>**](PatchedBulkWritableCustomFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::CustomField>**](CustomField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_bulk_update
> Vec<crate::models::CustomField> extras_custom_fields_bulk_update(bulk_writable_custom_field_request, format)
Update a list of custom field objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_custom_field_request** | [**Vec<crate::models::BulkWritableCustomFieldRequest>**](BulkWritableCustomFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::CustomField>**](CustomField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_create
> crate::models::CustomField extras_custom_fields_create(writable_custom_field_request, format)
Create one or more custom field objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**writable_custom_field_request** | [**WritableCustomFieldRequest**](WritableCustomFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::CustomField**](CustomField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_destroy
> extras_custom_fields_destroy(id, format)
Destroy a custom field object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_list
> crate::models::PaginatedCustomFieldList extras_custom_fields_list(contacts, contacts__isnull, contacts__n, content_types, content_types__n, dynamic_groups, dynamic_groups__n, filter_logic, filter_logic__ic, filter_logic__ie, filter_logic__iew, filter_logic__ire, filter_logic__isw, filter_logic__n, filter_logic__nic, filter_logic__nie, filter_logic__niew, filter_logic__nire, filter_logic__nisw, filter_logic__nre, filter_logic__re, format, grouping, grouping__ic, grouping__ie, grouping__iew, grouping__ire, grouping__isw, grouping__n, grouping__nic, grouping__nie, grouping__niew, grouping__nire, grouping__nisw, grouping__nre, grouping__re, id, id__n, label, label__ic, label__ie, label__iew, label__ire, label__isw, label__n, label__nic, label__nie, label__niew, label__nire, label__nisw, label__nre, label__re, limit, offset, q, required, sort, teams, teams__isnull, teams__n, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Retrieve a list of custom field objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic** | Option<[**Vec<String>**](String.md)> | Loose matches any instance of a given string; Exact matches the entire field. | |
**filter_logic__ic** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__ie** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__iew** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__ire** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__isw** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__n** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__nic** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__nie** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__niew** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__nire** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__nisw** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__nre** | Option<[**Vec<String>**](String.md)> | | |
**filter_logic__re** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**grouping** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__iew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__isw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__n** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__niew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nisw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nre** | Option<[**Vec<String>**](String.md)> | | |
**grouping__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**label** | Option<[**Vec<String>**](String.md)> | | |
**label__ic** | Option<[**Vec<String>**](String.md)> | | |
**label__ie** | Option<[**Vec<String>**](String.md)> | | |
**label__iew** | Option<[**Vec<String>**](String.md)> | | |
**label__ire** | Option<[**Vec<String>**](String.md)> | | |
**label__isw** | Option<[**Vec<String>**](String.md)> | | |
**label__n** | Option<[**Vec<String>**](String.md)> | | |
**label__nic** | Option<[**Vec<String>**](String.md)> | | |
**label__nie** | Option<[**Vec<String>**](String.md)> | | |
**label__niew** | Option<[**Vec<String>**](String.md)> | | |
**label__nire** | Option<[**Vec<String>**](String.md)> | | |
**label__nisw** | Option<[**Vec<String>**](String.md)> | | |
**label__nre** | Option<[**Vec<String>**](String.md)> | | |
**label__re** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**required** | Option<**bool**> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedCustomFieldList**](PaginatedCustomFieldList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_notes_create
> crate::models::Note extras_custom_fields_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_notes_list
> crate::models::PaginatedNoteList extras_custom_fields_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_partial_update
> crate::models::CustomField extras_custom_fields_partial_update(id, format, patched_writable_custom_field_request)
Partial update a custom field object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field. | [required] |
**format** | Option<**String**> | | |
**patched_writable_custom_field_request** | Option<[**PatchedWritableCustomFieldRequest**](PatchedWritableCustomFieldRequest.md)> | | |
### Return type
[**crate::models::CustomField**](CustomField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_retrieve
> crate::models::CustomField extras_custom_fields_retrieve(id, format, depth, exclude_m2m)
Retrieve a custom field object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::CustomField**](CustomField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_fields_update
> crate::models::CustomField extras_custom_fields_update(id, writable_custom_field_request, format)
Update a custom field object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom field. | [required] |
**writable_custom_field_request** | [**WritableCustomFieldRequest**](WritableCustomFieldRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::CustomField**](CustomField.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_bulk_destroy
> extras_custom_links_bulk_destroy(bulk_operation_request, format)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_bulk_partial_update
> Vec<crate::models::CustomLink> extras_custom_links_bulk_partial_update(patched_bulk_writable_custom_link_request, format)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_custom_link_request** | [**Vec<crate::models::PatchedBulkWritableCustomLinkRequest>**](PatchedBulkWritableCustomLinkRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::CustomLink>**](CustomLink.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_bulk_update
> Vec<crate::models::CustomLink> extras_custom_links_bulk_update(bulk_writable_custom_link_request, format)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_custom_link_request** | [**Vec<crate::models::BulkWritableCustomLinkRequest>**](BulkWritableCustomLinkRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::CustomLink>**](CustomLink.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_create
> crate::models::CustomLink extras_custom_links_create(custom_link_request, format)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**custom_link_request** | [**CustomLinkRequest**](CustomLinkRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::CustomLink**](CustomLink.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_destroy
> extras_custom_links_destroy(id, format)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom link. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_list
> crate::models::PaginatedCustomLinkList extras_custom_links_list(button_class, button_class__ic, button_class__ie, button_class__iew, button_class__ire, button_class__isw, button_class__n, button_class__nic, button_class__nie, button_class__niew, button_class__nire, button_class__nisw, button_class__nre, button_class__re, contacts, contacts__isnull, contacts__n, content_type, content_type__n, dynamic_groups, dynamic_groups__n, format, group_name, group_name__ic, group_name__ie, group_name__iew, group_name__ire, group_name__isw, group_name__n, group_name__nic, group_name__nie, group_name__niew, group_name__nire, group_name__nisw, group_name__nre, group_name__re, id, id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, new_window, offset, q, sort, target_url, target_url__ic, target_url__ie, target_url__iew, target_url__ire, target_url__isw, target_url__n, target_url__nic, target_url__nie, target_url__niew, target_url__nire, target_url__nisw, target_url__nre, target_url__re, teams, teams__isnull, teams__n, text, text__ic, text__ie, text__iew, text__ire, text__isw, text__n, text__nic, text__nie, text__niew, text__nire, text__nisw, text__nre, text__re, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**button_class** | Option<[**Vec<String>**](String.md)> | The class of the first link in a group will be used for the dropdown button | |
**button_class__ic** | Option<[**Vec<String>**](String.md)> | | |
**button_class__ie** | Option<[**Vec<String>**](String.md)> | | |
**button_class__iew** | Option<[**Vec<String>**](String.md)> | | |
**button_class__ire** | Option<[**Vec<String>**](String.md)> | | |
**button_class__isw** | Option<[**Vec<String>**](String.md)> | | |
**button_class__n** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nic** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nie** | Option<[**Vec<String>**](String.md)> | | |
**button_class__niew** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nire** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nisw** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nre** | Option<[**Vec<String>**](String.md)> | | |
**button_class__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_type** | Option<**String**> | | |
**content_type__n** | Option<**String**> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**group_name** | Option<[**Vec<String>**](String.md)> | | |
**group_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**group_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**group_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**group_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**group_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**group_name__n** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**group_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**group_name__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**new_window** | Option<**bool**> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**target_url** | Option<[**Vec<String>**](String.md)> | | |
**target_url__ic** | Option<[**Vec<String>**](String.md)> | | |
**target_url__ie** | Option<[**Vec<String>**](String.md)> | | |
**target_url__iew** | Option<[**Vec<String>**](String.md)> | | |
**target_url__ire** | Option<[**Vec<String>**](String.md)> | | |
**target_url__isw** | Option<[**Vec<String>**](String.md)> | | |
**target_url__n** | Option<[**Vec<String>**](String.md)> | | |
**target_url__nic** | Option<[**Vec<String>**](String.md)> | | |
**target_url__nie** | Option<[**Vec<String>**](String.md)> | | |
**target_url__niew** | Option<[**Vec<String>**](String.md)> | | |
**target_url__nire** | Option<[**Vec<String>**](String.md)> | | |
**target_url__nisw** | Option<[**Vec<String>**](String.md)> | | |
**target_url__nre** | Option<[**Vec<String>**](String.md)> | | |
**target_url__re** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**text** | Option<[**Vec<String>**](String.md)> | | |
**text__ic** | Option<[**Vec<String>**](String.md)> | | |
**text__ie** | Option<[**Vec<String>**](String.md)> | | |
**text__iew** | Option<[**Vec<String>**](String.md)> | | |
**text__ire** | Option<[**Vec<String>**](String.md)> | | |
**text__isw** | Option<[**Vec<String>**](String.md)> | | |
**text__n** | Option<[**Vec<String>**](String.md)> | | |
**text__nic** | Option<[**Vec<String>**](String.md)> | | |
**text__nie** | Option<[**Vec<String>**](String.md)> | | |
**text__niew** | Option<[**Vec<String>**](String.md)> | | |
**text__nire** | Option<[**Vec<String>**](String.md)> | | |
**text__nisw** | Option<[**Vec<String>**](String.md)> | | |
**text__nre** | Option<[**Vec<String>**](String.md)> | | |
**text__re** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedCustomLinkList**](PaginatedCustomLinkList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_notes_create
> crate::models::Note extras_custom_links_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom link. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_notes_list
> crate::models::PaginatedNoteList extras_custom_links_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom link. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_partial_update
> crate::models::CustomLink extras_custom_links_partial_update(id, format, patched_custom_link_request)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom link. | [required] |
**format** | Option<**String**> | | |
**patched_custom_link_request** | Option<[**PatchedCustomLinkRequest**](PatchedCustomLinkRequest.md)> | | |
### Return type
[**crate::models::CustomLink**](CustomLink.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_retrieve
> crate::models::CustomLink extras_custom_links_retrieve(id, format, depth, exclude_m2m)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom link. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::CustomLink**](CustomLink.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_custom_links_update
> crate::models::CustomLink extras_custom_links_update(id, custom_link_request, format)
Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this custom link. | [required] |
**custom_link_request** | [**CustomLinkRequest**](CustomLinkRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::CustomLink**](CustomLink.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_bulk_destroy
> extras_dynamic_group_memberships_bulk_destroy(bulk_operation_request, format)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_bulk_partial_update
> Vec<crate::models::DynamicGroupMembership> extras_dynamic_group_memberships_bulk_partial_update(patched_bulk_writable_dynamic_group_membership_request, format)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_dynamic_group_membership_request** | [**Vec<crate::models::PatchedBulkWritableDynamicGroupMembershipRequest>**](PatchedBulkWritableDynamicGroupMembershipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::DynamicGroupMembership>**](DynamicGroupMembership.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_bulk_update
> Vec<crate::models::DynamicGroupMembership> extras_dynamic_group_memberships_bulk_update(bulk_writable_dynamic_group_membership_request, format)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_dynamic_group_membership_request** | [**Vec<crate::models::BulkWritableDynamicGroupMembershipRequest>**](BulkWritableDynamicGroupMembershipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::DynamicGroupMembership>**](DynamicGroupMembership.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_create
> crate::models::DynamicGroupMembership extras_dynamic_group_memberships_create(dynamic_group_membership_request, format)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**dynamic_group_membership_request** | [**DynamicGroupMembershipRequest**](DynamicGroupMembershipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::DynamicGroupMembership**](DynamicGroupMembership.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_destroy
> extras_dynamic_group_memberships_destroy(id, format)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group membership. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_list
> crate::models::PaginatedDynamicGroupMembershipList extras_dynamic_group_memberships_list(created, format, group, group__n, id, id__n, last_updated, limit, offset, operator, operator__ic, operator__ie, operator__iew, operator__ire, operator__isw, operator__n, operator__nic, operator__nie, operator__niew, operator__nire, operator__nisw, operator__nre, operator__re, parent_group, parent_group__n, q, sort, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**created** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**group** | Option<[**Vec<String>**](String.md)> | | |
**group__n** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**operator** | Option<[**Vec<String>**](String.md)> | | |
**operator__ic** | Option<[**Vec<String>**](String.md)> | | |
**operator__ie** | Option<[**Vec<String>**](String.md)> | | |
**operator__iew** | Option<[**Vec<String>**](String.md)> | | |
**operator__ire** | Option<[**Vec<String>**](String.md)> | | |
**operator__isw** | Option<[**Vec<String>**](String.md)> | | |
**operator__n** | Option<[**Vec<String>**](String.md)> | | |
**operator__nic** | Option<[**Vec<String>**](String.md)> | | |
**operator__nie** | Option<[**Vec<String>**](String.md)> | | |
**operator__niew** | Option<[**Vec<String>**](String.md)> | | |
**operator__nire** | Option<[**Vec<String>**](String.md)> | | |
**operator__nisw** | Option<[**Vec<String>**](String.md)> | | |
**operator__nre** | Option<[**Vec<String>**](String.md)> | | |
**operator__re** | Option<[**Vec<String>**](String.md)> | | |
**parent_group** | Option<[**Vec<String>**](String.md)> | | |
**parent_group__n** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedDynamicGroupMembershipList**](PaginatedDynamicGroupMembershipList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_partial_update
> crate::models::DynamicGroupMembership extras_dynamic_group_memberships_partial_update(id, format, patched_dynamic_group_membership_request)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group membership. | [required] |
**format** | Option<**String**> | | |
**patched_dynamic_group_membership_request** | Option<[**PatchedDynamicGroupMembershipRequest**](PatchedDynamicGroupMembershipRequest.md)> | | |
### Return type
[**crate::models::DynamicGroupMembership**](DynamicGroupMembership.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_retrieve
> crate::models::DynamicGroupMembership extras_dynamic_group_memberships_retrieve(id, format, depth, exclude_m2m)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group membership. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::DynamicGroupMembership**](DynamicGroupMembership.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_group_memberships_update
> crate::models::DynamicGroupMembership extras_dynamic_group_memberships_update(id, dynamic_group_membership_request, format)
Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group membership. | [required] |
**dynamic_group_membership_request** | [**DynamicGroupMembershipRequest**](DynamicGroupMembershipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::DynamicGroupMembership**](DynamicGroupMembership.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_bulk_destroy
> extras_dynamic_groups_bulk_destroy(bulk_operation_request, format)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_bulk_partial_update
> Vec<crate::models::DynamicGroup> extras_dynamic_groups_bulk_partial_update(patched_bulk_writable_dynamic_group_request, format)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_dynamic_group_request** | [**Vec<crate::models::PatchedBulkWritableDynamicGroupRequest>**](PatchedBulkWritableDynamicGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::DynamicGroup>**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_bulk_update
> Vec<crate::models::DynamicGroup> extras_dynamic_groups_bulk_update(bulk_writable_dynamic_group_request, format)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_dynamic_group_request** | [**Vec<crate::models::BulkWritableDynamicGroupRequest>**](BulkWritableDynamicGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::DynamicGroup>**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_create
> crate::models::DynamicGroup extras_dynamic_groups_create(dynamic_group_request, format)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**dynamic_group_request** | [**DynamicGroupRequest**](DynamicGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::DynamicGroup**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_destroy
> extras_dynamic_groups_destroy(id, format)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_list
> crate::models::PaginatedDynamicGroupList extras_dynamic_groups_list(contacts, contacts__isnull, contacts__n, content_type, content_type__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, format, group_type, group_type__ic, group_type__ie, group_type__iew, group_type__ire, group_type__isw, group_type__n, group_type__nic, group_type__nie, group_type__niew, group_type__nire, group_type__nisw, group_type__nre, group_type__re, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, member_id, member_id__n, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, tenant, tenant__isnull, tenant__n, tenant_group, tenant_group__isnull, tenant_group__n, tenant_id, tenant_id__isnull, tenant_id__n, depth, exclude_m2m)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_type** | Option<[**Vec<i32>**](i32.md)> | | |
**content_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**description** | Option<[**Vec<String>**](String.md)> | | |
**description__ic** | Option<[**Vec<String>**](String.md)> | | |
**description__ie** | Option<[**Vec<String>**](String.md)> | | |
**description__iew** | Option<[**Vec<String>**](String.md)> | | |
**description__ire** | Option<[**Vec<String>**](String.md)> | | |
**description__isw** | Option<[**Vec<String>**](String.md)> | | |
**description__n** | Option<[**Vec<String>**](String.md)> | | |
**description__nic** | Option<[**Vec<String>**](String.md)> | | |
**description__nie** | Option<[**Vec<String>**](String.md)> | | |
**description__niew** | Option<[**Vec<String>**](String.md)> | | |
**description__nire** | Option<[**Vec<String>**](String.md)> | | |
**description__nisw** | Option<[**Vec<String>**](String.md)> | | |
**description__nre** | Option<[**Vec<String>**](String.md)> | | |
**description__re** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**group_type** | Option<[**Vec<String>**](String.md)> | | |
**group_type__ic** | Option<[**Vec<String>**](String.md)> | | |
**group_type__ie** | Option<[**Vec<String>**](String.md)> | | |
**group_type__iew** | Option<[**Vec<String>**](String.md)> | | |
**group_type__ire** | Option<[**Vec<String>**](String.md)> | | |
**group_type__isw** | Option<[**Vec<String>**](String.md)> | | |
**group_type__n** | Option<[**Vec<String>**](String.md)> | | |
**group_type__nic** | Option<[**Vec<String>**](String.md)> | | |
**group_type__nie** | Option<[**Vec<String>**](String.md)> | | |
**group_type__niew** | Option<[**Vec<String>**](String.md)> | | |
**group_type__nire** | Option<[**Vec<String>**](String.md)> | | |
**group_type__nisw** | Option<[**Vec<String>**](String.md)> | | |
**group_type__nre** | Option<[**Vec<String>**](String.md)> | | |
**group_type__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**member_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Group member ID | |
**member_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Group member ID | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant** | Option<[**Vec<String>**](String.md)> | | |
**tenant__isnull** | Option<**bool**> | Tenant (name or ID) is null | |
**tenant__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group__isnull** | Option<**bool**> | Tenant Group (name or ID) is null | |
**tenant_group__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant (ID) (deprecated, use \"tenant\" filter instead) | |
**tenant_id__isnull** | Option<**bool**> | Tenant (ID) (deprecated, use \"tenant\" filter instead) is null | |
**tenant_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant (ID) (deprecated, use \"tenant\" filter instead) | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedDynamicGroupList**](PaginatedDynamicGroupList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_members_retrieve
> crate::models::DynamicGroup extras_dynamic_groups_members_retrieve(id, format, depth, exclude_m2m)
List the member objects of this dynamic group.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::DynamicGroup**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_notes_create
> crate::models::Note extras_dynamic_groups_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_notes_list
> crate::models::PaginatedNoteList extras_dynamic_groups_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_partial_update
> crate::models::DynamicGroup extras_dynamic_groups_partial_update(id, format, patched_dynamic_group_request)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**format** | Option<**String**> | | |
**patched_dynamic_group_request** | Option<[**PatchedDynamicGroupRequest**](PatchedDynamicGroupRequest.md)> | | |
### Return type
[**crate::models::DynamicGroup**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_retrieve
> crate::models::DynamicGroup extras_dynamic_groups_retrieve(id, format, depth, exclude_m2m)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::DynamicGroup**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_dynamic_groups_update
> crate::models::DynamicGroup extras_dynamic_groups_update(id, dynamic_group_request, format)
Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this dynamic group. | [required] |
**dynamic_group_request** | [**DynamicGroupRequest**](DynamicGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::DynamicGroup**](DynamicGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_bulk_destroy
> extras_export_templates_bulk_destroy(bulk_operation_request, format)
Destroy a list of export template objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_bulk_partial_update
> Vec<crate::models::ExportTemplate> extras_export_templates_bulk_partial_update(patched_bulk_writable_export_template_request, format)
Partial update a list of export template objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_export_template_request** | [**Vec<crate::models::PatchedBulkWritableExportTemplateRequest>**](PatchedBulkWritableExportTemplateRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ExportTemplate>**](ExportTemplate.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_bulk_update
> Vec<crate::models::ExportTemplate> extras_export_templates_bulk_update(bulk_writable_export_template_request, format)
Update a list of export template objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_export_template_request** | [**Vec<crate::models::BulkWritableExportTemplateRequest>**](BulkWritableExportTemplateRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ExportTemplate>**](ExportTemplate.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_create
> crate::models::ExportTemplate extras_export_templates_create(export_template_request, format)
Create one or more export template objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**export_template_request** | [**ExportTemplateRequest**](ExportTemplateRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ExportTemplate**](ExportTemplate.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_destroy
> extras_export_templates_destroy(id, format)
Destroy a export template object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this export template. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_list
> crate::models::PaginatedExportTemplateList extras_export_templates_list(contacts, contacts__isnull, contacts__n, content_type, content_type__n, dynamic_groups, dynamic_groups__n, format, id, id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, owner_content_type, owner_content_type__isnull, owner_content_type__n, owner_object_id, owner_object_id__isnull, owner_object_id__n, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)
Retrieve a list of export template objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_type** | Option<**String**> | | |
**content_type__n** | Option<**String**> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**owner_content_type** | Option<**String**> | | |
**owner_content_type__isnull** | Option<**bool**> | | |
**owner_content_type__n** | Option<**String**> | | |
**owner_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**owner_object_id__isnull** | Option<**bool**> | | |
**owner_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedExportTemplateList**](PaginatedExportTemplateList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_notes_create
> crate::models::Note extras_export_templates_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this export template. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_notes_list
> crate::models::PaginatedNoteList extras_export_templates_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this export template. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_partial_update
> crate::models::ExportTemplate extras_export_templates_partial_update(id, format, patched_export_template_request)
Partial update a export template object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this export template. | [required] |
**format** | Option<**String**> | | |
**patched_export_template_request** | Option<[**PatchedExportTemplateRequest**](PatchedExportTemplateRequest.md)> | | |
### Return type
[**crate::models::ExportTemplate**](ExportTemplate.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_retrieve
> crate::models::ExportTemplate extras_export_templates_retrieve(id, format, depth, exclude_m2m)
Retrieve a export template object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this export template. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ExportTemplate**](ExportTemplate.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_export_templates_update
> crate::models::ExportTemplate extras_export_templates_update(id, export_template_request, format)
Update a export template object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this export template. | [required] |
**export_template_request** | [**ExportTemplateRequest**](ExportTemplateRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ExportTemplate**](ExportTemplate.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_bulk_destroy
> extras_external_integrations_bulk_destroy(bulk_operation_request, format)
Destroy a list of external integration objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_bulk_partial_update
> Vec<crate::models::ExternalIntegration> extras_external_integrations_bulk_partial_update(patched_bulk_writable_external_integration_request, format)
Partial update a list of external integration objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_external_integration_request** | [**Vec<crate::models::PatchedBulkWritableExternalIntegrationRequest>**](PatchedBulkWritableExternalIntegrationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ExternalIntegration>**](ExternalIntegration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_bulk_update
> Vec<crate::models::ExternalIntegration> extras_external_integrations_bulk_update(bulk_writable_external_integration_request, format)
Update a list of external integration objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_external_integration_request** | [**Vec<crate::models::BulkWritableExternalIntegrationRequest>**](BulkWritableExternalIntegrationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ExternalIntegration>**](ExternalIntegration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_create
> crate::models::ExternalIntegration extras_external_integrations_create(external_integration_request, format)
Create one or more external integration objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**external_integration_request** | [**ExternalIntegrationRequest**](ExternalIntegrationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ExternalIntegration**](ExternalIntegration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_destroy
> extras_external_integrations_destroy(id, format)
Destroy a external integration object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this external integration. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_list
> crate::models::PaginatedExternalIntegrationList extras_external_integrations_list(ca_file_path, ca_file_path__ic, ca_file_path__ie, ca_file_path__iew, ca_file_path__ire, ca_file_path__isw, ca_file_path__n, ca_file_path__nic, ca_file_path__nie, ca_file_path__niew, ca_file_path__nire, ca_file_path__nisw, ca_file_path__nre, ca_file_path__re, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, extra_config, format, has_secrets_group, headers, http_method, http_method__ic, http_method__ie, http_method__iew, http_method__ire, http_method__isw, http_method__n, http_method__nic, http_method__nie, http_method__niew, http_method__nire, http_method__nisw, http_method__nre, http_method__re, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, remote_url, remote_url__ic, remote_url__ie, remote_url__iew, remote_url__ire, remote_url__isw, remote_url__n, remote_url__nic, remote_url__nie, remote_url__niew, remote_url__nire, remote_url__nisw, remote_url__nre, remote_url__re, secrets_group, secrets_group__isnull, secrets_group__n, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, timeout, timeout__gt, timeout__gte, timeout__lt, timeout__lte, timeout__n, verify_ssl, depth, exclude_m2m)
Retrieve a list of external integration objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ca_file_path** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__ic** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__ie** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__iew** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__ire** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__isw** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__n** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__nic** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__nie** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__niew** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__nire** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__nisw** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__nre** | Option<[**Vec<String>**](String.md)> | | |
**ca_file_path__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**extra_config** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**has_secrets_group** | Option<**bool**> | Has secrets group | |
**headers** | Option<[**Vec<String>**](String.md)> | | |
**http_method** | Option<[**Vec<String>**](String.md)> | | |
**http_method__ic** | Option<[**Vec<String>**](String.md)> | | |
**http_method__ie** | Option<[**Vec<String>**](String.md)> | | |
**http_method__iew** | Option<[**Vec<String>**](String.md)> | | |
**http_method__ire** | Option<[**Vec<String>**](String.md)> | | |
**http_method__isw** | Option<[**Vec<String>**](String.md)> | | |
**http_method__n** | Option<[**Vec<String>**](String.md)> | | |
**http_method__nic** | Option<[**Vec<String>**](String.md)> | | |
**http_method__nie** | Option<[**Vec<String>**](String.md)> | | |
**http_method__niew** | Option<[**Vec<String>**](String.md)> | | |
**http_method__nire** | Option<[**Vec<String>**](String.md)> | | |
**http_method__nisw** | Option<[**Vec<String>**](String.md)> | | |
**http_method__nre** | Option<[**Vec<String>**](String.md)> | | |
**http_method__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**remote_url** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__ic** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__ie** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__iew** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__ire** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__isw** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__n** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nic** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nie** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__niew** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nire** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nisw** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nre** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__re** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group__isnull** | Option<**bool**> | Secrets group (ID or name) is null | |
**secrets_group__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**timeout** | Option<[**Vec<i32>**](i32.md)> | | |
**timeout__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**timeout__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**timeout__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**timeout__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**timeout__n** | Option<[**Vec<i32>**](i32.md)> | | |
**verify_ssl** | Option<**bool**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedExternalIntegrationList**](PaginatedExternalIntegrationList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_notes_create
> crate::models::Note extras_external_integrations_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this external integration. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_notes_list
> crate::models::PaginatedNoteList extras_external_integrations_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this external integration. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_partial_update
> crate::models::ExternalIntegration extras_external_integrations_partial_update(id, format, patched_external_integration_request)
Partial update a external integration object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this external integration. | [required] |
**format** | Option<**String**> | | |
**patched_external_integration_request** | Option<[**PatchedExternalIntegrationRequest**](PatchedExternalIntegrationRequest.md)> | | |
### Return type
[**crate::models::ExternalIntegration**](ExternalIntegration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_retrieve
> crate::models::ExternalIntegration extras_external_integrations_retrieve(id, format, depth, exclude_m2m)
Retrieve a external integration object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this external integration. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ExternalIntegration**](ExternalIntegration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_external_integrations_update
> crate::models::ExternalIntegration extras_external_integrations_update(id, external_integration_request, format)
Update a external integration object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this external integration. | [required] |
**external_integration_request** | [**ExternalIntegrationRequest**](ExternalIntegrationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ExternalIntegration**](ExternalIntegration.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_file_proxies_download_retrieve
> std::path::PathBuf extras_file_proxies_download_retrieve(id, format, depth, exclude_m2m)
Download the specified FileProxy.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this file proxy. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**std::path::PathBuf**](std::path::PathBuf.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_file_proxies_list
> crate::models::PaginatedFileProxyList extras_file_proxies_list(format, id, id__n, job, job__isnull, job__n, job_result_id, job_result_id__isnull, job_result_id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, uploaded_at, uploaded_at__gt, uploaded_at__gte, uploaded_at__lt, uploaded_at__lte, uploaded_at__n, depth, exclude_m2m)
Retrieve a list of file proxy objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job** | Option<[**Vec<String>**](String.md)> | | |
**job__isnull** | Option<**bool**> | Job (name or ID) is null | |
**job__n** | Option<[**Vec<String>**](String.md)> | | |
**job_result_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Job Result (ID) | |
**job_result_id__isnull** | Option<**bool**> | Job Result (ID) is null | |
**job_result_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Job Result (ID) | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**uploaded_at** | Option<[**Vec<String>**](String.md)> | | |
**uploaded_at__gt** | Option<[**Vec<String>**](String.md)> | | |
**uploaded_at__gte** | Option<[**Vec<String>**](String.md)> | | |
**uploaded_at__lt** | Option<[**Vec<String>**](String.md)> | | |
**uploaded_at__lte** | Option<[**Vec<String>**](String.md)> | | |
**uploaded_at__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedFileProxyList**](PaginatedFileProxyList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_file_proxies_retrieve
> crate::models::FileProxy extras_file_proxies_retrieve(id, format, depth, exclude_m2m)
Retrieve a file proxy object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this file proxy. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::FileProxy**](FileProxy.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_bulk_destroy
> extras_git_repositories_bulk_destroy(bulk_operation_request, format)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_bulk_partial_update
> Vec<crate::models::GitRepository> extras_git_repositories_bulk_partial_update(patched_bulk_writable_git_repository_request, format)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_git_repository_request** | [**Vec<crate::models::PatchedBulkWritableGitRepositoryRequest>**](PatchedBulkWritableGitRepositoryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::GitRepository>**](GitRepository.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_bulk_update
> Vec<crate::models::GitRepository> extras_git_repositories_bulk_update(bulk_writable_git_repository_request, format)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_git_repository_request** | [**Vec<crate::models::BulkWritableGitRepositoryRequest>**](BulkWritableGitRepositoryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::GitRepository>**](GitRepository.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_create
> crate::models::GitRepository extras_git_repositories_create(git_repository_request, format)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**git_repository_request** | [**GitRepositoryRequest**](GitRepositoryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::GitRepository**](GitRepository.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_destroy
> extras_git_repositories_destroy(id, format)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_list
> crate::models::PaginatedGitRepositoryList extras_git_repositories_list(branch, branch__ic, branch__ie, branch__iew, branch__ire, branch__isw, branch__n, branch__nic, branch__nie, branch__niew, branch__nire, branch__nisw, branch__nre, branch__re, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, provided_contents, q, remote_url, remote_url__ic, remote_url__ie, remote_url__iew, remote_url__ire, remote_url__isw, remote_url__n, remote_url__nic, remote_url__nie, remote_url__niew, remote_url__nire, remote_url__nisw, remote_url__nre, remote_url__re, secrets_group, secrets_group__isnull, secrets_group__n, secrets_group_id, secrets_group_id__isnull, secrets_group_id__n, slug, slug__ic, slug__ie, slug__iew, slug__ire, slug__isw, slug__n, slug__nic, slug__nie, slug__niew, slug__nire, slug__nisw, slug__nre, slug__re, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, depth, exclude_m2m)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**branch** | Option<[**Vec<String>**](String.md)> | | |
**branch__ic** | Option<[**Vec<String>**](String.md)> | | |
**branch__ie** | Option<[**Vec<String>**](String.md)> | | |
**branch__iew** | Option<[**Vec<String>**](String.md)> | | |
**branch__ire** | Option<[**Vec<String>**](String.md)> | | |
**branch__isw** | Option<[**Vec<String>**](String.md)> | | |
**branch__n** | Option<[**Vec<String>**](String.md)> | | |
**branch__nic** | Option<[**Vec<String>**](String.md)> | | |
**branch__nie** | Option<[**Vec<String>**](String.md)> | | |
**branch__niew** | Option<[**Vec<String>**](String.md)> | | |
**branch__nire** | Option<[**Vec<String>**](String.md)> | | |
**branch__nisw** | Option<[**Vec<String>**](String.md)> | | |
**branch__nre** | Option<[**Vec<String>**](String.md)> | | |
**branch__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**provided_contents** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**remote_url** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__ic** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__ie** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__iew** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__ire** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__isw** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__n** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nic** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nie** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__niew** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nire** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nisw** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__nre** | Option<[**Vec<String>**](String.md)> | | |
**remote_url__re** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group__isnull** | Option<**bool**> | Secrets group (ID or name) is null | |
**secrets_group__n** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Secrets group (ID) - Deprecated (use secrets_group filter) | |
**secrets_group_id__isnull** | Option<**bool**> | Secrets group (ID) - Deprecated (use secrets_group filter) is null | |
**secrets_group_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Secrets group (ID) - Deprecated (use secrets_group filter) | |
**slug** | Option<[**Vec<String>**](String.md)> | | |
**slug__ic** | Option<[**Vec<String>**](String.md)> | | |
**slug__ie** | Option<[**Vec<String>**](String.md)> | | |
**slug__iew** | Option<[**Vec<String>**](String.md)> | | |
**slug__ire** | Option<[**Vec<String>**](String.md)> | | |
**slug__isw** | Option<[**Vec<String>**](String.md)> | | |
**slug__n** | Option<[**Vec<String>**](String.md)> | | |
**slug__nic** | Option<[**Vec<String>**](String.md)> | | |
**slug__nie** | Option<[**Vec<String>**](String.md)> | | |
**slug__niew** | Option<[**Vec<String>**](String.md)> | | |
**slug__nire** | Option<[**Vec<String>**](String.md)> | | |
**slug__nisw** | Option<[**Vec<String>**](String.md)> | | |
**slug__nre** | Option<[**Vec<String>**](String.md)> | | |
**slug__re** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedGitRepositoryList**](PaginatedGitRepositoryList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_notes_create
> crate::models::Note extras_git_repositories_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_notes_list
> crate::models::PaginatedNoteList extras_git_repositories_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_partial_update
> crate::models::GitRepository extras_git_repositories_partial_update(id, format, patched_git_repository_request)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**format** | Option<**String**> | | |
**patched_git_repository_request** | Option<[**PatchedGitRepositoryRequest**](PatchedGitRepositoryRequest.md)> | | |
### Return type
[**crate::models::GitRepository**](GitRepository.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_retrieve
> crate::models::GitRepository extras_git_repositories_retrieve(id, format, depth, exclude_m2m)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::GitRepository**](GitRepository.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_sync_create
> crate::models::GitRepositorySyncResponse extras_git_repositories_sync_create(id, format)
Enqueue pull git repository and refresh data.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::GitRepositorySyncResponse**](GitRepositorySyncResponse.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_git_repositories_update
> crate::models::GitRepository extras_git_repositories_update(id, git_repository_request, format)
Manage the use of Git repositories as external data sources.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this Git repository. | [required] |
**git_repository_request** | [**GitRepositoryRequest**](GitRepositoryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::GitRepository**](GitRepository.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_bulk_destroy
> extras_graphql_queries_bulk_destroy(bulk_operation_request, format)
Destroy a list of GraphQL query objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_bulk_partial_update
> Vec<crate::models::GraphQlQuery> extras_graphql_queries_bulk_partial_update(patched_bulk_writable_graph_ql_query_request, format)
Partial update a list of GraphQL query objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_graph_ql_query_request** | [**Vec<crate::models::PatchedBulkWritableGraphQlQueryRequest>**](PatchedBulkWritableGraphQLQueryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::GraphQlQuery>**](GraphQLQuery.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_bulk_update
> Vec<crate::models::GraphQlQuery> extras_graphql_queries_bulk_update(bulk_writable_graph_ql_query_request, format)
Update a list of GraphQL query objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_graph_ql_query_request** | [**Vec<crate::models::BulkWritableGraphQlQueryRequest>**](BulkWritableGraphQLQueryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::GraphQlQuery>**](GraphQLQuery.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_create
> crate::models::GraphQlQuery extras_graphql_queries_create(graph_ql_query_request, format)
Create one or more GraphQL query objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**graph_ql_query_request** | [**GraphQlQueryRequest**](GraphQlQueryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::GraphQlQuery**](GraphQLQuery.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_destroy
> extras_graphql_queries_destroy(id, format)
Destroy a GraphQL query object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_list
> crate::models::PaginatedGraphQlQueryList extras_graphql_queries_list(contacts, contacts__isnull, contacts__n, dynamic_groups, dynamic_groups__n, format, id, id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)
Retrieve a list of GraphQL query objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedGraphQlQueryList**](PaginatedGraphQLQueryList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_notes_create
> crate::models::Note extras_graphql_queries_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_notes_list
> crate::models::PaginatedNoteList extras_graphql_queries_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_partial_update
> crate::models::GraphQlQuery extras_graphql_queries_partial_update(id, format, patched_graph_ql_query_request)
Partial update a GraphQL query object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**format** | Option<**String**> | | |
**patched_graph_ql_query_request** | Option<[**PatchedGraphQlQueryRequest**](PatchedGraphQlQueryRequest.md)> | | |
### Return type
[**crate::models::GraphQlQuery**](GraphQLQuery.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_retrieve
> crate::models::GraphQlQuery extras_graphql_queries_retrieve(id, format, depth, exclude_m2m)
Retrieve a GraphQL query object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::GraphQlQuery**](GraphQLQuery.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_run_create
> crate::models::GraphQlQueryOutput extras_graphql_queries_run_create(id, format, graph_ql_query_input_request)
Create one or more GraphQL query objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**format** | Option<**String**> | | |
**graph_ql_query_input_request** | Option<[**GraphQlQueryInputRequest**](GraphQlQueryInputRequest.md)> | | |
### Return type
[**crate::models::GraphQlQueryOutput**](GraphQLQueryOutput.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_graphql_queries_update
> crate::models::GraphQlQuery extras_graphql_queries_update(id, graph_ql_query_request, format)
Update a GraphQL query object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this GraphQL query. | [required] |
**graph_ql_query_request** | [**GraphQlQueryRequest**](GraphQlQueryRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::GraphQlQuery**](GraphQLQuery.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_bulk_destroy
> extras_image_attachments_bulk_destroy(bulk_operation_request, format)
Destroy a list of image attachment objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv, multipart/form-data
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_bulk_partial_update
> Vec<crate::models::ImageAttachment> extras_image_attachments_bulk_partial_update(patched_bulk_writable_image_attachment_request, format)
Partial update a list of image attachment objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_image_attachment_request** | [**Vec<crate::models::PatchedBulkWritableImageAttachmentRequest>**](PatchedBulkWritableImageAttachmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ImageAttachment>**](ImageAttachment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_bulk_update
> Vec<crate::models::ImageAttachment> extras_image_attachments_bulk_update(bulk_writable_image_attachment_request, format)
Update a list of image attachment objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_image_attachment_request** | [**Vec<crate::models::BulkWritableImageAttachmentRequest>**](BulkWritableImageAttachmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ImageAttachment>**](ImageAttachment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_create
> crate::models::ImageAttachment extras_image_attachments_create(image_attachment_request, format)
Create one or more image attachment objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**image_attachment_request** | [**ImageAttachmentRequest**](ImageAttachmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ImageAttachment**](ImageAttachment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_destroy
> extras_image_attachments_destroy(id, format)
Destroy a image attachment object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this image attachment. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_list
> crate::models::PaginatedImageAttachmentList extras_image_attachments_list(content_type, content_type__n, content_type_id, content_type_id__n, format, id, id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, object_id, object_id__n, offset, q, sort, depth, exclude_m2m)
Retrieve a list of image attachment objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**content_type** | Option<**String**> | | |
**content_type__n** | Option<**String**> | | |
**content_type_id** | Option<**i32**> | | |
**content_type_id__n** | Option<**i32**> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedImageAttachmentList**](PaginatedImageAttachmentList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_partial_update
> crate::models::ImageAttachment extras_image_attachments_partial_update(id, format, patched_image_attachment_request)
Partial update a image attachment object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this image attachment. | [required] |
**format** | Option<**String**> | | |
**patched_image_attachment_request** | Option<[**PatchedImageAttachmentRequest**](PatchedImageAttachmentRequest.md)> | | |
### Return type
[**crate::models::ImageAttachment**](ImageAttachment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_retrieve
> crate::models::ImageAttachment extras_image_attachments_retrieve(id, format, depth, exclude_m2m)
Retrieve a image attachment object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this image attachment. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ImageAttachment**](ImageAttachment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_image_attachments_update
> crate::models::ImageAttachment extras_image_attachments_update(id, image_attachment_request, format)
Update a image attachment object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this image attachment. | [required] |
**image_attachment_request** | [**ImageAttachmentRequest**](ImageAttachmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ImageAttachment**](ImageAttachment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_bulk_destroy
> extras_job_buttons_bulk_destroy(bulk_operation_request, format)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_bulk_partial_update
> Vec<crate::models::JobButton> extras_job_buttons_bulk_partial_update(patched_bulk_writable_job_button_request, format)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_job_button_request** | [**Vec<crate::models::PatchedBulkWritableJobButtonRequest>**](PatchedBulkWritableJobButtonRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobButton>**](JobButton.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_bulk_update
> Vec<crate::models::JobButton> extras_job_buttons_bulk_update(bulk_writable_job_button_request, format)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_job_button_request** | [**Vec<crate::models::BulkWritableJobButtonRequest>**](BulkWritableJobButtonRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobButton>**](JobButton.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_create
> crate::models::JobButton extras_job_buttons_create(job_button_request, format)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_button_request** | [**JobButtonRequest**](JobButtonRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobButton**](JobButton.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_destroy
> extras_job_buttons_destroy(id, format)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job button. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_list
> crate::models::PaginatedJobButtonList extras_job_buttons_list(button_class, button_class__ic, button_class__ie, button_class__iew, button_class__ire, button_class__isw, button_class__n, button_class__nic, button_class__nie, button_class__niew, button_class__nire, button_class__nisw, button_class__nre, button_class__re, confirmation, contacts, contacts__isnull, contacts__n, content_types, content_types__n, dynamic_groups, dynamic_groups__n, enabled, format, group_name, group_name__ic, group_name__ie, group_name__iew, group_name__ire, group_name__isw, group_name__n, group_name__nic, group_name__nie, group_name__niew, group_name__nire, group_name__nisw, group_name__nre, group_name__re, id, id__n, job, job__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, text, text__ic, text__ie, text__iew, text__ire, text__isw, text__n, text__nic, text__nie, text__niew, text__nire, text__nisw, text__nre, text__re, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**button_class** | Option<[**Vec<String>**](String.md)> | | |
**button_class__ic** | Option<[**Vec<String>**](String.md)> | | |
**button_class__ie** | Option<[**Vec<String>**](String.md)> | | |
**button_class__iew** | Option<[**Vec<String>**](String.md)> | | |
**button_class__ire** | Option<[**Vec<String>**](String.md)> | | |
**button_class__isw** | Option<[**Vec<String>**](String.md)> | | |
**button_class__n** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nic** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nie** | Option<[**Vec<String>**](String.md)> | | |
**button_class__niew** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nire** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nisw** | Option<[**Vec<String>**](String.md)> | | |
**button_class__nre** | Option<[**Vec<String>**](String.md)> | | |
**button_class__re** | Option<[**Vec<String>**](String.md)> | | |
**confirmation** | Option<**bool**> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<**String**> | | |
**content_types__n** | Option<**String**> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**enabled** | Option<**bool**> | | |
**format** | Option<**String**> | | |
**group_name** | Option<[**Vec<String>**](String.md)> | | |
**group_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**group_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**group_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**group_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**group_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**group_name__n** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**group_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**group_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**group_name__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job** | Option<[**Vec<String>**](String.md)> | | |
**job__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**text** | Option<[**Vec<String>**](String.md)> | | |
**text__ic** | Option<[**Vec<String>**](String.md)> | | |
**text__ie** | Option<[**Vec<String>**](String.md)> | | |
**text__iew** | Option<[**Vec<String>**](String.md)> | | |
**text__ire** | Option<[**Vec<String>**](String.md)> | | |
**text__isw** | Option<[**Vec<String>**](String.md)> | | |
**text__n** | Option<[**Vec<String>**](String.md)> | | |
**text__nic** | Option<[**Vec<String>**](String.md)> | | |
**text__nie** | Option<[**Vec<String>**](String.md)> | | |
**text__niew** | Option<[**Vec<String>**](String.md)> | | |
**text__nire** | Option<[**Vec<String>**](String.md)> | | |
**text__nisw** | Option<[**Vec<String>**](String.md)> | | |
**text__nre** | Option<[**Vec<String>**](String.md)> | | |
**text__re** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobButtonList**](PaginatedJobButtonList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_notes_create
> crate::models::Note extras_job_buttons_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job button. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_notes_list
> crate::models::PaginatedNoteList extras_job_buttons_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job button. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_partial_update
> crate::models::JobButton extras_job_buttons_partial_update(id, format, patched_job_button_request)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job button. | [required] |
**format** | Option<**String**> | | |
**patched_job_button_request** | Option<[**PatchedJobButtonRequest**](PatchedJobButtonRequest.md)> | | |
### Return type
[**crate::models::JobButton**](JobButton.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_retrieve
> crate::models::JobButton extras_job_buttons_retrieve(id, format, depth, exclude_m2m)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job button. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobButton**](JobButton.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_buttons_update
> crate::models::JobButton extras_job_buttons_update(id, job_button_request, format)
Manage Job Buttons through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job button. | [required] |
**job_button_request** | [**JobButtonRequest**](JobButtonRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobButton**](JobButton.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_bulk_destroy
> extras_job_hooks_bulk_destroy(bulk_operation_request, format)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_bulk_partial_update
> Vec<crate::models::JobHook> extras_job_hooks_bulk_partial_update(patched_bulk_writable_job_hook_request, format)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_job_hook_request** | [**Vec<crate::models::PatchedBulkWritableJobHookRequest>**](PatchedBulkWritableJobHookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobHook>**](JobHook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_bulk_update
> Vec<crate::models::JobHook> extras_job_hooks_bulk_update(bulk_writable_job_hook_request, format)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_job_hook_request** | [**Vec<crate::models::BulkWritableJobHookRequest>**](BulkWritableJobHookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobHook>**](JobHook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_create
> crate::models::JobHook extras_job_hooks_create(job_hook_request, format)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_hook_request** | [**JobHookRequest**](JobHookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobHook**](JobHook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_destroy
> extras_job_hooks_destroy(id, format)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job hook. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_list
> crate::models::PaginatedJobHookList extras_job_hooks_list(contacts, contacts__isnull, contacts__n, content_types, content_types__n, dynamic_groups, dynamic_groups__n, enabled, format, id, id__n, job, job__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, type_create, type_delete, type_update, depth, exclude_m2m)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**enabled** | Option<**bool**> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job** | Option<[**Vec<String>**](String.md)> | | |
**job__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**type_create** | Option<**bool**> | | |
**type_delete** | Option<**bool**> | | |
**type_update** | Option<**bool**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobHookList**](PaginatedJobHookList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_notes_create
> crate::models::Note extras_job_hooks_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job hook. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_notes_list
> crate::models::PaginatedNoteList extras_job_hooks_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job hook. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_partial_update
> crate::models::JobHook extras_job_hooks_partial_update(id, format, patched_job_hook_request)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job hook. | [required] |
**format** | Option<**String**> | | |
**patched_job_hook_request** | Option<[**PatchedJobHookRequest**](PatchedJobHookRequest.md)> | | |
### Return type
[**crate::models::JobHook**](JobHook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_retrieve
> crate::models::JobHook extras_job_hooks_retrieve(id, format, depth, exclude_m2m)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job hook. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobHook**](JobHook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_hooks_update
> crate::models::JobHook extras_job_hooks_update(id, job_hook_request, format)
Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job hook. | [required] |
**job_hook_request** | [**JobHookRequest**](JobHookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobHook**](JobHook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_logs_list
> crate::models::PaginatedJobLogEntryList extras_job_logs_list(absolute_url, absolute_url__ic, absolute_url__ie, absolute_url__iew, absolute_url__ire, absolute_url__isw, absolute_url__n, absolute_url__nic, absolute_url__nie, absolute_url__niew, absolute_url__nire, absolute_url__nisw, absolute_url__nre, absolute_url__re, created, created__gt, created__gte, created__lt, created__lte, created__n, format, grouping, grouping__ic, grouping__ie, grouping__iew, grouping__ire, grouping__isw, grouping__n, grouping__nic, grouping__nie, grouping__niew, grouping__nire, grouping__nisw, grouping__nre, grouping__re, id, id__n, job_result, job_result__n, limit, log_level, log_level__ic, log_level__ie, log_level__iew, log_level__ire, log_level__isw, log_level__n, log_level__nic, log_level__nie, log_level__niew, log_level__nire, log_level__nisw, log_level__nre, log_level__re, log_object, log_object__ic, log_object__ie, log_object__iew, log_object__ire, log_object__isw, log_object__n, log_object__nic, log_object__nie, log_object__niew, log_object__nire, log_object__nisw, log_object__nre, log_object__re, message, message__ic, message__ie, message__iew, message__ire, message__isw, message__n, message__nic, message__nie, message__niew, message__nire, message__nisw, message__nre, message__re, offset, q, sort, depth, exclude_m2m)
Retrieve a list of job log entries.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**absolute_url** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__ic** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__ie** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__iew** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__ire** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__isw** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__n** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__nic** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__nie** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__niew** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__nire** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__nisw** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__nre** | Option<[**Vec<String>**](String.md)> | | |
**absolute_url__re** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**grouping** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__iew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__isw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__n** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__niew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nisw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nre** | Option<[**Vec<String>**](String.md)> | | |
**grouping__re** | Option<[**Vec<String>**](String.md)> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job_result** | Option<**uuid::Uuid**> | | |
**job_result__n** | Option<**uuid::Uuid**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**log_level** | Option<[**Vec<String>**](String.md)> | | |
**log_level__ic** | Option<[**Vec<String>**](String.md)> | | |
**log_level__ie** | Option<[**Vec<String>**](String.md)> | | |
**log_level__iew** | Option<[**Vec<String>**](String.md)> | | |
**log_level__ire** | Option<[**Vec<String>**](String.md)> | | |
**log_level__isw** | Option<[**Vec<String>**](String.md)> | | |
**log_level__n** | Option<[**Vec<String>**](String.md)> | | |
**log_level__nic** | Option<[**Vec<String>**](String.md)> | | |
**log_level__nie** | Option<[**Vec<String>**](String.md)> | | |
**log_level__niew** | Option<[**Vec<String>**](String.md)> | | |
**log_level__nire** | Option<[**Vec<String>**](String.md)> | | |
**log_level__nisw** | Option<[**Vec<String>**](String.md)> | | |
**log_level__nre** | Option<[**Vec<String>**](String.md)> | | |
**log_level__re** | Option<[**Vec<String>**](String.md)> | | |
**log_object** | Option<[**Vec<String>**](String.md)> | | |
**log_object__ic** | Option<[**Vec<String>**](String.md)> | | |
**log_object__ie** | Option<[**Vec<String>**](String.md)> | | |
**log_object__iew** | Option<[**Vec<String>**](String.md)> | | |
**log_object__ire** | Option<[**Vec<String>**](String.md)> | | |
**log_object__isw** | Option<[**Vec<String>**](String.md)> | | |
**log_object__n** | Option<[**Vec<String>**](String.md)> | | |
**log_object__nic** | Option<[**Vec<String>**](String.md)> | | |
**log_object__nie** | Option<[**Vec<String>**](String.md)> | | |
**log_object__niew** | Option<[**Vec<String>**](String.md)> | | |
**log_object__nire** | Option<[**Vec<String>**](String.md)> | | |
**log_object__nisw** | Option<[**Vec<String>**](String.md)> | | |
**log_object__nre** | Option<[**Vec<String>**](String.md)> | | |
**log_object__re** | Option<[**Vec<String>**](String.md)> | | |
**message** | Option<[**Vec<String>**](String.md)> | | |
**message__ic** | Option<[**Vec<String>**](String.md)> | | |
**message__ie** | Option<[**Vec<String>**](String.md)> | | |
**message__iew** | Option<[**Vec<String>**](String.md)> | | |
**message__ire** | Option<[**Vec<String>**](String.md)> | | |
**message__isw** | Option<[**Vec<String>**](String.md)> | | |
**message__n** | Option<[**Vec<String>**](String.md)> | | |
**message__nic** | Option<[**Vec<String>**](String.md)> | | |
**message__nie** | Option<[**Vec<String>**](String.md)> | | |
**message__niew** | Option<[**Vec<String>**](String.md)> | | |
**message__nire** | Option<[**Vec<String>**](String.md)> | | |
**message__nisw** | Option<[**Vec<String>**](String.md)> | | |
**message__nre** | Option<[**Vec<String>**](String.md)> | | |
**message__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobLogEntryList**](PaginatedJobLogEntryList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_logs_retrieve
> crate::models::JobLogEntry extras_job_logs_retrieve(id, format, depth, exclude_m2m)
Retrieve a list of job log entries.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job log entry. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobLogEntry**](JobLogEntry.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_bulk_destroy
> extras_job_queue_assignments_bulk_destroy(bulk_operation_request, format)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_bulk_partial_update
> Vec<crate::models::JobQueueAssignment> extras_job_queue_assignments_bulk_partial_update(patched_bulk_writable_job_queue_assignment_request, format)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_job_queue_assignment_request** | [**Vec<crate::models::PatchedBulkWritableJobQueueAssignmentRequest>**](PatchedBulkWritableJobQueueAssignmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobQueueAssignment>**](JobQueueAssignment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_bulk_update
> Vec<crate::models::JobQueueAssignment> extras_job_queue_assignments_bulk_update(bulk_writable_job_queue_assignment_request, format)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_job_queue_assignment_request** | [**Vec<crate::models::BulkWritableJobQueueAssignmentRequest>**](BulkWritableJobQueueAssignmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobQueueAssignment>**](JobQueueAssignment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_create
> crate::models::JobQueueAssignment extras_job_queue_assignments_create(job_queue_assignment_request, format)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_queue_assignment_request** | [**JobQueueAssignmentRequest**](JobQueueAssignmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobQueueAssignment**](JobQueueAssignment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_destroy
> extras_job_queue_assignments_destroy(id, format)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue assignment. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_list
> crate::models::PaginatedJobQueueAssignmentList extras_job_queue_assignments_list(format, id, id__n, job, job__n, job_queue, job_queue__n, limit, offset, q, sort, depth, exclude_m2m)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job** | Option<[**Vec<String>**](String.md)> | | |
**job__n** | Option<[**Vec<String>**](String.md)> | | |
**job_queue** | Option<[**Vec<String>**](String.md)> | | |
**job_queue__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobQueueAssignmentList**](PaginatedJobQueueAssignmentList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_partial_update
> crate::models::JobQueueAssignment extras_job_queue_assignments_partial_update(id, format, patched_job_queue_assignment_request)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue assignment. | [required] |
**format** | Option<**String**> | | |
**patched_job_queue_assignment_request** | Option<[**PatchedJobQueueAssignmentRequest**](PatchedJobQueueAssignmentRequest.md)> | | |
### Return type
[**crate::models::JobQueueAssignment**](JobQueueAssignment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_retrieve
> crate::models::JobQueueAssignment extras_job_queue_assignments_retrieve(id, format, depth, exclude_m2m)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue assignment. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobQueueAssignment**](JobQueueAssignment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queue_assignments_update
> crate::models::JobQueueAssignment extras_job_queue_assignments_update(id, job_queue_assignment_request, format)
Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue assignment. | [required] |
**job_queue_assignment_request** | [**JobQueueAssignmentRequest**](JobQueueAssignmentRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobQueueAssignment**](JobQueueAssignment.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_bulk_destroy
> extras_job_queues_bulk_destroy(bulk_operation_request, format)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_bulk_partial_update
> Vec<crate::models::JobQueue> extras_job_queues_bulk_partial_update(patched_bulk_writable_job_queue_request, format)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_job_queue_request** | [**Vec<crate::models::PatchedBulkWritableJobQueueRequest>**](PatchedBulkWritableJobQueueRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobQueue>**](JobQueue.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_bulk_update
> Vec<crate::models::JobQueue> extras_job_queues_bulk_update(bulk_writable_job_queue_request, format)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_job_queue_request** | [**Vec<crate::models::BulkWritableJobQueueRequest>**](BulkWritableJobQueueRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::JobQueue>**](JobQueue.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_create
> crate::models::JobQueue extras_job_queues_create(job_queue_request, format)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_queue_request** | [**JobQueueRequest**](JobQueueRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobQueue**](JobQueue.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_destroy
> extras_job_queues_destroy(id, format)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_list
> crate::models::PaginatedJobQueueList extras_job_queues_list(contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, has_jobs, id, id__n, jobs, jobs__isnull, jobs__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, queue_type, queue_type__ic, queue_type__ie, queue_type__iew, queue_type__ire, queue_type__isw, queue_type__n, queue_type__nic, queue_type__nie, queue_type__niew, queue_type__nire, queue_type__nisw, queue_type__nre, queue_type__re, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, tenant, tenant__isnull, tenant__n, tenant_group, tenant_group__isnull, tenant_group__n, tenant_id, tenant_id__isnull, tenant_id__n, depth, exclude_m2m)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**description** | Option<[**Vec<String>**](String.md)> | | |
**description__ic** | Option<[**Vec<String>**](String.md)> | | |
**description__ie** | Option<[**Vec<String>**](String.md)> | | |
**description__iew** | Option<[**Vec<String>**](String.md)> | | |
**description__ire** | Option<[**Vec<String>**](String.md)> | | |
**description__isw** | Option<[**Vec<String>**](String.md)> | | |
**description__n** | Option<[**Vec<String>**](String.md)> | | |
**description__nic** | Option<[**Vec<String>**](String.md)> | | |
**description__nie** | Option<[**Vec<String>**](String.md)> | | |
**description__niew** | Option<[**Vec<String>**](String.md)> | | |
**description__nire** | Option<[**Vec<String>**](String.md)> | | |
**description__nisw** | Option<[**Vec<String>**](String.md)> | | |
**description__nre** | Option<[**Vec<String>**](String.md)> | | |
**description__re** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**has_jobs** | Option<**bool**> | Has jobs | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**jobs** | Option<[**Vec<String>**](String.md)> | | |
**jobs__isnull** | Option<**bool**> | Job (name or ID) is null | |
**jobs__n** | Option<[**Vec<String>**](String.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**queue_type** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__ic** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__ie** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__iew** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__ire** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__isw** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__n** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__nic** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__nie** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__niew** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__nire** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__nisw** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__nre** | Option<[**Vec<String>**](String.md)> | | |
**queue_type__re** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant** | Option<[**Vec<String>**](String.md)> | | |
**tenant__isnull** | Option<**bool**> | Tenant (name or ID) is null | |
**tenant__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group** | Option<[**Vec<String>**](String.md)> | | |
**tenant_group__isnull** | Option<**bool**> | Tenant Group (name or ID) is null | |
**tenant_group__n** | Option<[**Vec<String>**](String.md)> | | |
**tenant_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant (ID) (deprecated, use \"tenant\" filter instead) | |
**tenant_id__isnull** | Option<**bool**> | Tenant (ID) (deprecated, use \"tenant\" filter instead) is null | |
**tenant_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant (ID) (deprecated, use \"tenant\" filter instead) | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobQueueList**](PaginatedJobQueueList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_notes_create
> crate::models::Note extras_job_queues_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_notes_list
> crate::models::PaginatedNoteList extras_job_queues_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_partial_update
> crate::models::JobQueue extras_job_queues_partial_update(id, format, patched_job_queue_request)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue. | [required] |
**format** | Option<**String**> | | |
**patched_job_queue_request** | Option<[**PatchedJobQueueRequest**](PatchedJobQueueRequest.md)> | | |
### Return type
[**crate::models::JobQueue**](JobQueue.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_retrieve
> crate::models::JobQueue extras_job_queues_retrieve(id, format, depth, exclude_m2m)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobQueue**](JobQueue.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_queues_update
> crate::models::JobQueue extras_job_queues_update(id, job_queue_request, format)
Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job queue. | [required] |
**job_queue_request** | [**JobQueueRequest**](JobQueueRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobQueue**](JobQueue.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_results_bulk_destroy
> extras_job_results_bulk_destroy(bulk_operation_request, format)
Retrieve a list of job results
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_results_destroy
> extras_job_results_destroy(id, format)
Retrieve a list of job results
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job result. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_results_list
> crate::models::PaginatedJobResultList extras_job_results_list(date_created, date_created__gt, date_created__gte, date_created__lt, date_created__lte, date_created__n, date_done, date_done__gt, date_done__gte, date_done__isnull, date_done__lt, date_done__lte, date_done__n, date_started, date_started__gt, date_started__gte, date_started__isnull, date_started__lt, date_started__lte, date_started__n, format, id, id__n, job_model, job_model__isnull, job_model__n, job_model_id, job_model_id__isnull, job_model_id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, scheduled_job, scheduled_job__isnull, scheduled_job__n, sort, status, status__ic, status__ie, status__iew, status__ire, status__isw, status__n, status__nic, status__nie, status__niew, status__nire, status__nisw, status__nre, status__re, user, user__isnull, user__n, depth, exclude_m2m)
Retrieve a list of job results
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**date_created** | Option<[**Vec<String>**](String.md)> | | |
**date_created__gt** | Option<[**Vec<String>**](String.md)> | | |
**date_created__gte** | Option<[**Vec<String>**](String.md)> | | |
**date_created__lt** | Option<[**Vec<String>**](String.md)> | | |
**date_created__lte** | Option<[**Vec<String>**](String.md)> | | |
**date_created__n** | Option<[**Vec<String>**](String.md)> | | |
**date_done** | Option<[**Vec<String>**](String.md)> | | |
**date_done__gt** | Option<[**Vec<String>**](String.md)> | | |
**date_done__gte** | Option<[**Vec<String>**](String.md)> | | |
**date_done__isnull** | Option<**bool**> | | |
**date_done__lt** | Option<[**Vec<String>**](String.md)> | | |
**date_done__lte** | Option<[**Vec<String>**](String.md)> | | |
**date_done__n** | Option<[**Vec<String>**](String.md)> | | |
**date_started** | Option<[**Vec<String>**](String.md)> | | |
**date_started__gt** | Option<[**Vec<String>**](String.md)> | | |
**date_started__gte** | Option<[**Vec<String>**](String.md)> | | |
**date_started__isnull** | Option<**bool**> | | |
**date_started__lt** | Option<[**Vec<String>**](String.md)> | | |
**date_started__lte** | Option<[**Vec<String>**](String.md)> | | |
**date_started__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job_model** | Option<[**Vec<String>**](String.md)> | | |
**job_model__isnull** | Option<**bool**> | Job (name or ID) is null | |
**job_model__n** | Option<[**Vec<String>**](String.md)> | | |
**job_model_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Job (ID) - Deprecated (use job_model filter) | |
**job_model_id__isnull** | Option<**bool**> | Job (ID) - Deprecated (use job_model filter) is null | |
**job_model_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Job (ID) - Deprecated (use job_model filter) | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**scheduled_job** | Option<[**Vec<String>**](String.md)> | | |
**scheduled_job__isnull** | Option<**bool**> | Scheduled Job (name or ID) is null | |
**scheduled_job__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**status** | Option<[**Vec<String>**](String.md)> | Current state of the Job being run | |
**status__ic** | Option<[**Vec<String>**](String.md)> | | |
**status__ie** | Option<[**Vec<String>**](String.md)> | | |
**status__iew** | Option<[**Vec<String>**](String.md)> | | |
**status__ire** | Option<[**Vec<String>**](String.md)> | | |
**status__isw** | Option<[**Vec<String>**](String.md)> | | |
**status__n** | Option<[**Vec<String>**](String.md)> | | |
**status__nic** | Option<[**Vec<String>**](String.md)> | | |
**status__nie** | Option<[**Vec<String>**](String.md)> | | |
**status__niew** | Option<[**Vec<String>**](String.md)> | | |
**status__nire** | Option<[**Vec<String>**](String.md)> | | |
**status__nisw** | Option<[**Vec<String>**](String.md)> | | |
**status__nre** | Option<[**Vec<String>**](String.md)> | | |
**status__re** | Option<[**Vec<String>**](String.md)> | | |
**user** | Option<**uuid::Uuid**> | | |
**user__isnull** | Option<**bool**> | | |
**user__n** | Option<**uuid::Uuid**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobResultList**](PaginatedJobResultList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_results_logs_retrieve
> crate::models::JobResult extras_job_results_logs_retrieve(id, format, depth, exclude_m2m)
Retrieve a list of job results
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job result. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobResult**](JobResult.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_job_results_retrieve
> crate::models::JobResult extras_job_results_retrieve(id, format, depth, exclude_m2m)
Retrieve a list of job results
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this job result. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::JobResult**](JobResult.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_bulk_destroy
> extras_jobs_bulk_destroy(bulk_operation_request, format)
Destroy a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_bulk_partial_update
> Vec<crate::models::Job> extras_jobs_bulk_partial_update(patched_bulk_writable_job_request, format)
Partial update a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_job_request** | [**Vec<crate::models::PatchedBulkWritableJobRequest>**](PatchedBulkWritableJobRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Job>**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_bulk_update
> Vec<crate::models::Job> extras_jobs_bulk_update(bulk_writable_job_request, format)
Update a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_job_request** | [**Vec<crate::models::BulkWritableJobRequest>**](BulkWritableJobRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Job>**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_destroy
> extras_jobs_destroy(id, format)
Destroy a job object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_destroy_by_name
> extras_jobs_destroy_by_name(name, format)
Destroy a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_list
> crate::models::PaginatedJobList extras_jobs_list(approval_required, approval_required_override, contacts, contacts__isnull, contacts__n, description_override, dryrun_default, dryrun_default_override, dynamic_groups, dynamic_groups__n, enabled, format, grouping, grouping__ic, grouping__ie, grouping__iew, grouping__ire, grouping__isw, grouping__n, grouping__nic, grouping__nie, grouping__niew, grouping__nire, grouping__nisw, grouping__nre, grouping__re, grouping_override, has_sensitive_variables, has_sensitive_variables_override, hidden, hidden_override, id, id__n, installed, is_job_button_receiver, is_job_hook_receiver, is_singleton, is_singleton_override, job_class_name, job_class_name__ic, job_class_name__ie, job_class_name__iew, job_class_name__ire, job_class_name__isw, job_class_name__n, job_class_name__nic, job_class_name__nie, job_class_name__niew, job_class_name__nire, job_class_name__nisw, job_class_name__nre, job_class_name__re, job_queues, job_queues__n, limit, module_name, module_name__ic, module_name__ie, module_name__iew, module_name__ire, module_name__isw, module_name__n, module_name__nic, module_name__nie, module_name__niew, module_name__nire, module_name__nisw, module_name__nre, module_name__re, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, name_override, offset, q, read_only, soft_time_limit, soft_time_limit__gt, soft_time_limit__gte, soft_time_limit__lt, soft_time_limit__lte, soft_time_limit__n, soft_time_limit_override, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, time_limit, time_limit__gt, time_limit__gte, time_limit__lt, time_limit__lte, time_limit__n, time_limit_override, depth, exclude_m2m)
Retrieve a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**approval_required** | Option<**bool**> | | |
**approval_required_override** | Option<**bool**> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**description_override** | Option<**bool**> | | |
**dryrun_default** | Option<**bool**> | | |
**dryrun_default_override** | Option<**bool**> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**enabled** | Option<**bool**> | | |
**format** | Option<**String**> | | |
**grouping** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__iew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__ire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__isw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__n** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nic** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nie** | Option<[**Vec<String>**](String.md)> | | |
**grouping__niew** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nire** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nisw** | Option<[**Vec<String>**](String.md)> | | |
**grouping__nre** | Option<[**Vec<String>**](String.md)> | | |
**grouping__re** | Option<[**Vec<String>**](String.md)> | | |
**grouping_override** | Option<**bool**> | | |
**has_sensitive_variables** | Option<**bool**> | | |
**has_sensitive_variables_override** | Option<**bool**> | | |
**hidden** | Option<**bool**> | | |
**hidden_override** | Option<**bool**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**installed** | Option<**bool**> | | |
**is_job_button_receiver** | Option<**bool**> | | |
**is_job_hook_receiver** | Option<**bool**> | | |
**is_singleton** | Option<**bool**> | | |
**is_singleton_override** | Option<**bool**> | | |
**job_class_name** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__n** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**job_class_name__re** | Option<[**Vec<String>**](String.md)> | | |
**job_queues** | Option<[**Vec<String>**](String.md)> | | |
**job_queues__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**module_name** | Option<[**Vec<String>**](String.md)> | | |
**module_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**module_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**module_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**module_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**module_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**module_name__n** | Option<[**Vec<String>**](String.md)> | | |
**module_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**module_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**module_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**module_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**module_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**module_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**module_name__re** | Option<[**Vec<String>**](String.md)> | | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**name_override** | Option<**bool**> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**read_only** | Option<**bool**> | | |
**soft_time_limit** | Option<[**Vec<f32>**](f32.md)> | | |
**soft_time_limit__gt** | Option<[**Vec<f32>**](f32.md)> | | |
**soft_time_limit__gte** | Option<[**Vec<f32>**](f32.md)> | | |
**soft_time_limit__lt** | Option<[**Vec<f32>**](f32.md)> | | |
**soft_time_limit__lte** | Option<[**Vec<f32>**](f32.md)> | | |
**soft_time_limit__n** | Option<[**Vec<f32>**](f32.md)> | | |
**soft_time_limit_override** | Option<**bool**> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**time_limit** | Option<[**Vec<f32>**](f32.md)> | | |
**time_limit__gt** | Option<[**Vec<f32>**](f32.md)> | | |
**time_limit__gte** | Option<[**Vec<f32>**](f32.md)> | | |
**time_limit__lt** | Option<[**Vec<f32>**](f32.md)> | | |
**time_limit__lte** | Option<[**Vec<f32>**](f32.md)> | | |
**time_limit__n** | Option<[**Vec<f32>**](f32.md)> | | |
**time_limit_override** | Option<**bool**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobList**](PaginatedJobList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_notes_create
> crate::models::Note extras_jobs_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_notes_create_by_name
> crate::models::Note extras_jobs_notes_create_by_name(name, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_notes_list
> crate::models::PaginatedNoteList extras_jobs_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_notes_list_by_name
> crate::models::PaginatedNoteList extras_jobs_notes_list_by_name(name, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_partial_update
> crate::models::Job extras_jobs_partial_update(id, format, patched_job_request)
Partial update a job object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**format** | Option<**String**> | | |
**patched_job_request** | Option<[**PatchedJobRequest**](PatchedJobRequest.md)> | | |
### Return type
[**crate::models::Job**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_partial_update_by_name
> crate::models::Job extras_jobs_partial_update_by_name(name, format, patched_job_request)
Partial update a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**format** | Option<**String**> | | |
**patched_job_request** | Option<[**PatchedJobRequest**](PatchedJobRequest.md)> | | |
### Return type
[**crate::models::Job**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_retrieve
> crate::models::Job extras_jobs_retrieve(id, format, depth, exclude_m2m)
Retrieve a job object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Job**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_retrieve_by_name
> crate::models::Job extras_jobs_retrieve_by_name(name, format, depth, exclude_m2m)
Retrieve a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Job**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_run_create
> crate::models::JobRunResponse extras_jobs_run_create(id, format, job_input_request)
Run the specified Job.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**format** | Option<**String**> | | |
**job_input_request** | Option<[**JobInputRequest**](JobInputRequest.md)> | | |
### Return type
[**crate::models::JobRunResponse**](JobRunResponse.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_run_create_by_name
> crate::models::JobRunResponse extras_jobs_run_create_by_name(name, format, job_input_request)
Run the specified Job.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**format** | Option<**String**> | | |
**job_input_request** | Option<[**JobInputRequest**](JobInputRequest.md)> | | |
### Return type
[**crate::models::JobRunResponse**](JobRunResponse.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_update
> crate::models::Job extras_jobs_update(id, job_request, format)
Update a job object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**job_request** | [**JobRequest**](JobRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Job**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_update_by_name
> crate::models::Job extras_jobs_update_by_name(name, job_request, format)
Update a list of job objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**job_request** | [**JobRequest**](JobRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Job**](Job.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_variables_list
> crate::models::PaginatedJobVariableList extras_jobs_variables_list(id, format, limit, offset, sort, depth, exclude_m2m)
Get details of the input variables that may/must be specified to run a particular Job.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Unique object identifier, either a UUID primary key or a composite key. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobVariableList**](PaginatedJobVariableList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_jobs_variables_list_by_name
> crate::models::PaginatedJobVariableList extras_jobs_variables_list_by_name(name, format, limit, offset, sort, depth, exclude_m2m)
Get details of the input variables that may/must be specified to run a particular Job.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedJobVariableList**](PaginatedJobVariableList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_bulk_destroy
> extras_metadata_choices_bulk_destroy(bulk_operation_request, format)
Destroy a list of metadata choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_bulk_partial_update
> Vec<crate::models::MetadataChoice> extras_metadata_choices_bulk_partial_update(patched_bulk_writable_metadata_choice_request, format)
Partial update a list of metadata choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_metadata_choice_request** | [**Vec<crate::models::PatchedBulkWritableMetadataChoiceRequest>**](PatchedBulkWritableMetadataChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::MetadataChoice>**](MetadataChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_bulk_update
> Vec<crate::models::MetadataChoice> extras_metadata_choices_bulk_update(bulk_writable_metadata_choice_request, format)
Update a list of metadata choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_metadata_choice_request** | [**Vec<crate::models::BulkWritableMetadataChoiceRequest>**](BulkWritableMetadataChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::MetadataChoice>**](MetadataChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_create
> crate::models::MetadataChoice extras_metadata_choices_create(metadata_choice_request, format)
Create one or more metadata choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**metadata_choice_request** | [**MetadataChoiceRequest**](MetadataChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::MetadataChoice**](MetadataChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_destroy
> extras_metadata_choices_destroy(id, format)
Destroy a metadata choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata choice. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_list
> crate::models::PaginatedMetadataChoiceList extras_metadata_choices_list(created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, metadata_type, metadata_type__n, offset, q, sort, value, value__ic, value__ie, value__iew, value__ire, value__isw, value__n, value__nic, value__nie, value__niew, value__nire, value__nisw, value__nre, value__re, weight, weight__gt, weight__gte, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Retrieve a list of metadata choice objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**metadata_type** | Option<[**Vec<String>**](String.md)> | | |
**metadata_type__n** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**value** | Option<[**Vec<String>**](String.md)> | | |
**value__ic** | Option<[**Vec<String>**](String.md)> | | |
**value__ie** | Option<[**Vec<String>**](String.md)> | | |
**value__iew** | Option<[**Vec<String>**](String.md)> | | |
**value__ire** | Option<[**Vec<String>**](String.md)> | | |
**value__isw** | Option<[**Vec<String>**](String.md)> | | |
**value__n** | Option<[**Vec<String>**](String.md)> | | |
**value__nic** | Option<[**Vec<String>**](String.md)> | | |
**value__nie** | Option<[**Vec<String>**](String.md)> | | |
**value__niew** | Option<[**Vec<String>**](String.md)> | | |
**value__nire** | Option<[**Vec<String>**](String.md)> | | |
**value__nisw** | Option<[**Vec<String>**](String.md)> | | |
**value__nre** | Option<[**Vec<String>**](String.md)> | | |
**value__re** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedMetadataChoiceList**](PaginatedMetadataChoiceList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_partial_update
> crate::models::MetadataChoice extras_metadata_choices_partial_update(id, format, patched_metadata_choice_request)
Partial update a metadata choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata choice. | [required] |
**format** | Option<**String**> | | |
**patched_metadata_choice_request** | Option<[**PatchedMetadataChoiceRequest**](PatchedMetadataChoiceRequest.md)> | | |
### Return type
[**crate::models::MetadataChoice**](MetadataChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_retrieve
> crate::models::MetadataChoice extras_metadata_choices_retrieve(id, format, depth, exclude_m2m)
Retrieve a metadata choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata choice. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::MetadataChoice**](MetadataChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_choices_update
> crate::models::MetadataChoice extras_metadata_choices_update(id, metadata_choice_request, format)
Update a metadata choice object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata choice. | [required] |
**metadata_choice_request** | [**MetadataChoiceRequest**](MetadataChoiceRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::MetadataChoice**](MetadataChoice.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_bulk_destroy
> extras_metadata_types_bulk_destroy(bulk_operation_request, format)
Destroy a list of metadata type objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_bulk_partial_update
> Vec<crate::models::MetadataType> extras_metadata_types_bulk_partial_update(patched_bulk_writable_metadata_type_request, format)
Partial update a list of metadata type objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_metadata_type_request** | [**Vec<crate::models::PatchedBulkWritableMetadataTypeRequest>**](PatchedBulkWritableMetadataTypeRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::MetadataType>**](MetadataType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_bulk_update
> Vec<crate::models::MetadataType> extras_metadata_types_bulk_update(bulk_writable_metadata_type_request, format)
Update a list of metadata type objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_metadata_type_request** | [**Vec<crate::models::BulkWritableMetadataTypeRequest>**](BulkWritableMetadataTypeRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::MetadataType>**](MetadataType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_create
> crate::models::MetadataType extras_metadata_types_create(metadata_type_request, format)
Create one or more metadata type objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**metadata_type_request** | [**MetadataTypeRequest**](MetadataTypeRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::MetadataType**](MetadataType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_destroy
> extras_metadata_types_destroy(id, format)
Destroy a metadata type object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata type. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_list
> crate::models::PaginatedMetadataTypeList extras_metadata_types_list(contacts, contacts__isnull, contacts__n, content_types, content_types__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, data_type, data_type__ic, data_type__ie, data_type__iew, data_type__ire, data_type__isw, data_type__n, data_type__nic, data_type__nie, data_type__niew, data_type__nire, data_type__nisw, data_type__nre, data_type__re, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, depth, exclude_m2m)
Retrieve a list of metadata type objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**data_type** | Option<[**Vec<String>**](String.md)> | The type of data allowed for any Metadata of this type. | |
**data_type__ic** | Option<[**Vec<String>**](String.md)> | | |
**data_type__ie** | Option<[**Vec<String>**](String.md)> | | |
**data_type__iew** | Option<[**Vec<String>**](String.md)> | | |
**data_type__ire** | Option<[**Vec<String>**](String.md)> | | |
**data_type__isw** | Option<[**Vec<String>**](String.md)> | | |
**data_type__n** | Option<[**Vec<String>**](String.md)> | | |
**data_type__nic** | Option<[**Vec<String>**](String.md)> | | |
**data_type__nie** | Option<[**Vec<String>**](String.md)> | | |
**data_type__niew** | Option<[**Vec<String>**](String.md)> | | |
**data_type__nire** | Option<[**Vec<String>**](String.md)> | | |
**data_type__nisw** | Option<[**Vec<String>**](String.md)> | | |
**data_type__nre** | Option<[**Vec<String>**](String.md)> | | |
**data_type__re** | Option<[**Vec<String>**](String.md)> | | |
**description** | Option<[**Vec<String>**](String.md)> | | |
**description__ic** | Option<[**Vec<String>**](String.md)> | | |
**description__ie** | Option<[**Vec<String>**](String.md)> | | |
**description__iew** | Option<[**Vec<String>**](String.md)> | | |
**description__ire** | Option<[**Vec<String>**](String.md)> | | |
**description__isw** | Option<[**Vec<String>**](String.md)> | | |
**description__n** | Option<[**Vec<String>**](String.md)> | | |
**description__nic** | Option<[**Vec<String>**](String.md)> | | |
**description__nie** | Option<[**Vec<String>**](String.md)> | | |
**description__niew** | Option<[**Vec<String>**](String.md)> | | |
**description__nire** | Option<[**Vec<String>**](String.md)> | | |
**description__nisw** | Option<[**Vec<String>**](String.md)> | | |
**description__nre** | Option<[**Vec<String>**](String.md)> | | |
**description__re** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedMetadataTypeList**](PaginatedMetadataTypeList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_notes_create
> crate::models::Note extras_metadata_types_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata type. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_notes_list
> crate::models::PaginatedNoteList extras_metadata_types_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata type. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_partial_update
> crate::models::MetadataType extras_metadata_types_partial_update(id, format, patched_metadata_type_request)
Partial update a metadata type object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata type. | [required] |
**format** | Option<**String**> | | |
**patched_metadata_type_request** | Option<[**PatchedMetadataTypeRequest**](PatchedMetadataTypeRequest.md)> | | |
### Return type
[**crate::models::MetadataType**](MetadataType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_retrieve
> crate::models::MetadataType extras_metadata_types_retrieve(id, format, depth, exclude_m2m)
Retrieve a metadata type object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata type. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::MetadataType**](MetadataType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_metadata_types_update
> crate::models::MetadataType extras_metadata_types_update(id, metadata_type_request, format)
Update a metadata type object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this metadata type. | [required] |
**metadata_type_request** | [**MetadataTypeRequest**](MetadataTypeRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::MetadataType**](MetadataType.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_bulk_destroy
> extras_notes_bulk_destroy(bulk_operation_request, format)
Destroy a list of note objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_bulk_partial_update
> Vec<crate::models::Note> extras_notes_bulk_partial_update(patched_bulk_writable_note_request, format)
Partial update a list of note objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_note_request** | [**Vec<crate::models::PatchedBulkWritableNoteRequest>**](PatchedBulkWritableNoteRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Note>**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_bulk_update
> Vec<crate::models::Note> extras_notes_bulk_update(bulk_writable_note_request, format)
Update a list of note objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_note_request** | [**Vec<crate::models::BulkWritableNoteRequest>**](BulkWritableNoteRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Note>**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_create
> crate::models::Note extras_notes_create(note_request, format)
Create one or more note objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**note_request** | [**NoteRequest**](NoteRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_destroy
> extras_notes_destroy(id, format)
Destroy a note object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this note. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_list
> crate::models::PaginatedNoteList extras_notes_list(assigned_object_id, assigned_object_id__n, assigned_object_type, assigned_object_type__n, assigned_object_type_id, assigned_object_type_id__n, format, id, id__n, limit, note, note__ic, note__ie, note__iew, note__ire, note__isw, note__n, note__nic, note__nie, note__niew, note__nire, note__nisw, note__nre, note__re, offset, q, sort, user, user__isnull, user__n, user_name, user_name__ic, user_name__ie, user_name__iew, user_name__ire, user_name__isw, user_name__n, user_name__nic, user_name__nie, user_name__niew, user_name__nire, user_name__nisw, user_name__nre, user_name__re, depth, exclude_m2m)
Retrieve a list of note objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**assigned_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**assigned_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**assigned_object_type** | Option<**String**> | | |
**assigned_object_type__n** | Option<**String**> | | |
**assigned_object_type_id** | Option<**i32**> | | |
**assigned_object_type_id__n** | Option<**i32**> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**note** | Option<[**Vec<String>**](String.md)> | | |
**note__ic** | Option<[**Vec<String>**](String.md)> | | |
**note__ie** | Option<[**Vec<String>**](String.md)> | | |
**note__iew** | Option<[**Vec<String>**](String.md)> | | |
**note__ire** | Option<[**Vec<String>**](String.md)> | | |
**note__isw** | Option<[**Vec<String>**](String.md)> | | |
**note__n** | Option<[**Vec<String>**](String.md)> | | |
**note__nic** | Option<[**Vec<String>**](String.md)> | | |
**note__nie** | Option<[**Vec<String>**](String.md)> | | |
**note__niew** | Option<[**Vec<String>**](String.md)> | | |
**note__nire** | Option<[**Vec<String>**](String.md)> | | |
**note__nisw** | Option<[**Vec<String>**](String.md)> | | |
**note__nre** | Option<[**Vec<String>**](String.md)> | | |
**note__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**user** | Option<[**Vec<String>**](String.md)> | | |
**user__isnull** | Option<**bool**> | User (username or ID) is null | |
**user__n** | Option<[**Vec<String>**](String.md)> | | |
**user_name** | Option<[**Vec<String>**](String.md)> | | |
**user_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**user_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**user_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**user_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**user_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**user_name__n** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**user_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**user_name__re** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_partial_update
> crate::models::Note extras_notes_partial_update(id, format, patched_note_request)
Partial update a note object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this note. | [required] |
**format** | Option<**String**> | | |
**patched_note_request** | Option<[**PatchedNoteRequest**](PatchedNoteRequest.md)> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_retrieve
> crate::models::Note extras_notes_retrieve(id, format, depth, exclude_m2m)
Retrieve a note object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this note. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_notes_update
> crate::models::Note extras_notes_update(id, note_request, format)
Update a note object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this note. | [required] |
**note_request** | [**NoteRequest**](NoteRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_changes_list
> crate::models::PaginatedObjectChangeList extras_object_changes_list(action, action__ic, action__ie, action__iew, action__ire, action__isw, action__n, action__nic, action__nie, action__niew, action__nire, action__nisw, action__nre, action__re, changed_object_id, changed_object_id__n, changed_object_type, changed_object_type__isnull, changed_object_type__n, changed_object_type_id, changed_object_type_id__isnull, changed_object_type_id__n, format, id, id__n, limit, object_repr, object_repr__ic, object_repr__ie, object_repr__iew, object_repr__ire, object_repr__isw, object_repr__n, object_repr__nic, object_repr__nie, object_repr__niew, object_repr__nire, object_repr__nisw, object_repr__nre, object_repr__re, offset, q, request_id, request_id__n, sort, time, time__gt, time__gte, time__lt, time__lte, time__n, user, user__isnull, user__n, user_id, user_id__isnull, user_id__n, user_name, user_name__ic, user_name__ie, user_name__iew, user_name__ire, user_name__isw, user_name__n, user_name__nic, user_name__nie, user_name__niew, user_name__nire, user_name__nisw, user_name__nre, user_name__re, depth, exclude_m2m)
Retrieve a list of recent changes.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**action** | Option<[**Vec<String>**](String.md)> | | |
**action__ic** | Option<[**Vec<String>**](String.md)> | | |
**action__ie** | Option<[**Vec<String>**](String.md)> | | |
**action__iew** | Option<[**Vec<String>**](String.md)> | | |
**action__ire** | Option<[**Vec<String>**](String.md)> | | |
**action__isw** | Option<[**Vec<String>**](String.md)> | | |
**action__n** | Option<[**Vec<String>**](String.md)> | | |
**action__nic** | Option<[**Vec<String>**](String.md)> | | |
**action__nie** | Option<[**Vec<String>**](String.md)> | | |
**action__niew** | Option<[**Vec<String>**](String.md)> | | |
**action__nire** | Option<[**Vec<String>**](String.md)> | | |
**action__nisw** | Option<[**Vec<String>**](String.md)> | | |
**action__nre** | Option<[**Vec<String>**](String.md)> | | |
**action__re** | Option<[**Vec<String>**](String.md)> | | |
**changed_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**changed_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**changed_object_type** | Option<**String**> | | |
**changed_object_type__isnull** | Option<**bool**> | | |
**changed_object_type__n** | Option<**String**> | | |
**changed_object_type_id** | Option<**i32**> | | |
**changed_object_type_id__isnull** | Option<**bool**> | | |
**changed_object_type_id__n** | Option<**i32**> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**object_repr** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__ic** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__ie** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__iew** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__ire** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__isw** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__n** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__nic** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__nie** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__niew** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__nire** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__nisw** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__nre** | Option<[**Vec<String>**](String.md)> | | |
**object_repr__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**request_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**request_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**time** | Option<[**Vec<String>**](String.md)> | | |
**time__gt** | Option<[**Vec<String>**](String.md)> | | |
**time__gte** | Option<[**Vec<String>**](String.md)> | | |
**time__lt** | Option<[**Vec<String>**](String.md)> | | |
**time__lte** | Option<[**Vec<String>**](String.md)> | | |
**time__n** | Option<[**Vec<String>**](String.md)> | | |
**user** | Option<[**Vec<String>**](String.md)> | | |
**user__isnull** | Option<**bool**> | User name (ID or username) is null | |
**user__n** | Option<[**Vec<String>**](String.md)> | | |
**user_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | User (ID) - Deprecated (use user filter) | |
**user_id__isnull** | Option<**bool**> | User (ID) - Deprecated (use user filter) is null | |
**user_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude User (ID) - Deprecated (use user filter) | |
**user_name** | Option<[**Vec<String>**](String.md)> | | |
**user_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**user_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**user_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**user_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**user_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**user_name__n** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**user_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**user_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**user_name__re** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedObjectChangeList**](PaginatedObjectChangeList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_changes_retrieve
> crate::models::ObjectChange extras_object_changes_retrieve(id, format, depth, exclude_m2m)
Retrieve a list of recent changes.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this object change. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ObjectChange**](ObjectChange.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_bulk_destroy
> extras_object_metadata_bulk_destroy(bulk_operation_request, format)
Destroy a list of object metadata objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_bulk_partial_update
> Vec<crate::models::ObjectMetadata> extras_object_metadata_bulk_partial_update(patched_bulk_writable_object_metadata_request, format)
Partial update a list of object metadata objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_object_metadata_request** | [**Vec<crate::models::PatchedBulkWritableObjectMetadataRequest>**](PatchedBulkWritableObjectMetadataRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ObjectMetadata>**](ObjectMetadata.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_bulk_update
> Vec<crate::models::ObjectMetadata> extras_object_metadata_bulk_update(bulk_writable_object_metadata_request, format)
Update a list of object metadata objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_object_metadata_request** | [**Vec<crate::models::BulkWritableObjectMetadataRequest>**](BulkWritableObjectMetadataRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::ObjectMetadata>**](ObjectMetadata.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_create
> crate::models::ObjectMetadata extras_object_metadata_create(object_metadata_request, format)
Create one or more object metadata objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**object_metadata_request** | [**ObjectMetadataRequest**](ObjectMetadataRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ObjectMetadata**](ObjectMetadata.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_destroy
> extras_object_metadata_destroy(id, format)
Destroy a object metadata object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this object metadata. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_list
> crate::models::PaginatedObjectMetadataList extras_object_metadata_list(assigned_object_id, assigned_object_id__n, assigned_object_type, assigned_object_type__isnull, assigned_object_type__n, contact, contact__isnull, contact__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, metadata_type, metadata_type__n, offset, q, scoped_fields, sort, team, team__isnull, team__n, value, depth, exclude_m2m)
Retrieve a list of object metadata objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**assigned_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**assigned_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**assigned_object_type** | Option<[**Vec<i32>**](i32.md)> | | |
**assigned_object_type__isnull** | Option<**bool**> | | |
**assigned_object_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**contact** | Option<[**Vec<String>**](String.md)> | | |
**contact__isnull** | Option<**bool**> | Contact (name or ID) is null | |
**contact__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**metadata_type** | Option<[**Vec<String>**](String.md)> | | |
**metadata_type__n** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**scoped_fields** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**team** | Option<[**Vec<String>**](String.md)> | | |
**team__isnull** | Option<**bool**> | Team (name or ID) is null | |
**team__n** | Option<[**Vec<String>**](String.md)> | | |
**value** | Option<[**serde_json::Value**](.md)> | Relevant data value to an object field or a set of object fields | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedObjectMetadataList**](PaginatedObjectMetadataList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_partial_update
> crate::models::ObjectMetadata extras_object_metadata_partial_update(id, format, patched_object_metadata_request)
Partial update a object metadata object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this object metadata. | [required] |
**format** | Option<**String**> | | |
**patched_object_metadata_request** | Option<[**PatchedObjectMetadataRequest**](PatchedObjectMetadataRequest.md)> | | |
### Return type
[**crate::models::ObjectMetadata**](ObjectMetadata.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_retrieve
> crate::models::ObjectMetadata extras_object_metadata_retrieve(id, format, depth, exclude_m2m)
Retrieve a object metadata object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this object metadata. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ObjectMetadata**](ObjectMetadata.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_object_metadata_update
> crate::models::ObjectMetadata extras_object_metadata_update(id, object_metadata_request, format)
Update a object metadata object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this object metadata. | [required] |
**object_metadata_request** | [**ObjectMetadataRequest**](ObjectMetadataRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ObjectMetadata**](ObjectMetadata.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_bulk_destroy
> extras_relationship_associations_bulk_destroy(bulk_operation_request, format)
Destroy a list of relationship association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_bulk_partial_update
> Vec<crate::models::RelationshipAssociation> extras_relationship_associations_bulk_partial_update(patched_bulk_writable_relationship_association_request, format)
Partial update a list of relationship association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_relationship_association_request** | [**Vec<crate::models::PatchedBulkWritableRelationshipAssociationRequest>**](PatchedBulkWritableRelationshipAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::RelationshipAssociation>**](RelationshipAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_bulk_update
> Vec<crate::models::RelationshipAssociation> extras_relationship_associations_bulk_update(bulk_writable_relationship_association_request, format)
Update a list of relationship association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_relationship_association_request** | [**Vec<crate::models::BulkWritableRelationshipAssociationRequest>**](BulkWritableRelationshipAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::RelationshipAssociation>**](RelationshipAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_create
> crate::models::RelationshipAssociation extras_relationship_associations_create(relationship_association_request, format)
Create one or more relationship association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**relationship_association_request** | [**RelationshipAssociationRequest**](RelationshipAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::RelationshipAssociation**](RelationshipAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_destroy
> extras_relationship_associations_destroy(id, format)
Destroy a relationship association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship association. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_list
> crate::models::PaginatedRelationshipAssociationList extras_relationship_associations_list(destination_id, destination_id__n, destination_type, destination_type__n, format, id, id__n, limit, offset, peer_id, q, relationship, relationship__n, sort, source_id, source_id__n, source_type, source_type__n, depth, exclude_m2m)
Retrieve a list of relationship association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**destination_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**destination_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**destination_type** | Option<[**Vec<i32>**](i32.md)> | | |
**destination_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**peer_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**q** | Option<**String**> | Search | |
**relationship** | Option<[**Vec<String>**](String.md)> | Relationship (key) | |
**relationship__n** | Option<[**Vec<String>**](String.md)> | Exclude Relationship (key) | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**source_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**source_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**source_type** | Option<[**Vec<i32>**](i32.md)> | | |
**source_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedRelationshipAssociationList**](PaginatedRelationshipAssociationList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_partial_update
> crate::models::RelationshipAssociation extras_relationship_associations_partial_update(id, format, patched_relationship_association_request)
Partial update a relationship association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship association. | [required] |
**format** | Option<**String**> | | |
**patched_relationship_association_request** | Option<[**PatchedRelationshipAssociationRequest**](PatchedRelationshipAssociationRequest.md)> | | |
### Return type
[**crate::models::RelationshipAssociation**](RelationshipAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_retrieve
> crate::models::RelationshipAssociation extras_relationship_associations_retrieve(id, format, depth, exclude_m2m)
Retrieve a relationship association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship association. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::RelationshipAssociation**](RelationshipAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationship_associations_update
> crate::models::RelationshipAssociation extras_relationship_associations_update(id, relationship_association_request, format)
Update a relationship association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship association. | [required] |
**relationship_association_request** | [**RelationshipAssociationRequest**](RelationshipAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::RelationshipAssociation**](RelationshipAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_bulk_destroy
> extras_relationships_bulk_destroy(bulk_operation_request, format)
Destroy a list of relationship objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_bulk_partial_update
> Vec<crate::models::Relationship> extras_relationships_bulk_partial_update(patched_bulk_writable_relationship_request, format)
Partial update a list of relationship objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_relationship_request** | [**Vec<crate::models::PatchedBulkWritableRelationshipRequest>**](PatchedBulkWritableRelationshipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Relationship>**](Relationship.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_bulk_update
> Vec<crate::models::Relationship> extras_relationships_bulk_update(bulk_writable_relationship_request, format)
Update a list of relationship objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_relationship_request** | [**Vec<crate::models::BulkWritableRelationshipRequest>**](BulkWritableRelationshipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Relationship>**](Relationship.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_create
> crate::models::Relationship extras_relationships_create(relationship_request, format)
Create one or more relationship objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**relationship_request** | [**RelationshipRequest**](RelationshipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Relationship**](Relationship.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_destroy
> extras_relationships_destroy(id, format)
Destroy a relationship object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_list
> crate::models::PaginatedRelationshipList extras_relationships_list(contacts, contacts__isnull, contacts__n, destination_type, destination_type__n, dynamic_groups, dynamic_groups__n, format, id, id__n, key, key__ic, key__ie, key__iew, key__ire, key__isw, key__n, key__nic, key__nie, key__niew, key__nire, key__nisw, key__nre, key__re, label, label__ic, label__ie, label__iew, label__ire, label__isw, label__n, label__nic, label__nie, label__niew, label__nire, label__nisw, label__nre, label__re, limit, offset, q, sort, source_type, source_type__n, teams, teams__isnull, teams__n, r#type, type__ic, type__ie, type__iew, type__ire, type__isw, type__n, type__nic, type__nie, type__niew, type__nire, type__nisw, type__nre, type__re, depth, exclude_m2m)
Retrieve a list of relationship objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**destination_type** | Option<[**Vec<i32>**](i32.md)> | | |
**destination_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**key** | Option<[**Vec<String>**](String.md)> | | |
**key__ic** | Option<[**Vec<String>**](String.md)> | | |
**key__ie** | Option<[**Vec<String>**](String.md)> | | |
**key__iew** | Option<[**Vec<String>**](String.md)> | | |
**key__ire** | Option<[**Vec<String>**](String.md)> | | |
**key__isw** | Option<[**Vec<String>**](String.md)> | | |
**key__n** | Option<[**Vec<String>**](String.md)> | | |
**key__nic** | Option<[**Vec<String>**](String.md)> | | |
**key__nie** | Option<[**Vec<String>**](String.md)> | | |
**key__niew** | Option<[**Vec<String>**](String.md)> | | |
**key__nire** | Option<[**Vec<String>**](String.md)> | | |
**key__nisw** | Option<[**Vec<String>**](String.md)> | | |
**key__nre** | Option<[**Vec<String>**](String.md)> | | |
**key__re** | Option<[**Vec<String>**](String.md)> | | |
**label** | Option<[**Vec<String>**](String.md)> | | |
**label__ic** | Option<[**Vec<String>**](String.md)> | | |
**label__ie** | Option<[**Vec<String>**](String.md)> | | |
**label__iew** | Option<[**Vec<String>**](String.md)> | | |
**label__ire** | Option<[**Vec<String>**](String.md)> | | |
**label__isw** | Option<[**Vec<String>**](String.md)> | | |
**label__n** | Option<[**Vec<String>**](String.md)> | | |
**label__nic** | Option<[**Vec<String>**](String.md)> | | |
**label__nie** | Option<[**Vec<String>**](String.md)> | | |
**label__niew** | Option<[**Vec<String>**](String.md)> | | |
**label__nire** | Option<[**Vec<String>**](String.md)> | | |
**label__nisw** | Option<[**Vec<String>**](String.md)> | | |
**label__nre** | Option<[**Vec<String>**](String.md)> | | |
**label__re** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**source_type** | Option<[**Vec<i32>**](i32.md)> | | |
**source_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**r#type** | Option<[**Vec<String>**](String.md)> | Cardinality of this relationship | |
**type__ic** | Option<[**Vec<String>**](String.md)> | | |
**type__ie** | Option<[**Vec<String>**](String.md)> | | |
**type__iew** | Option<[**Vec<String>**](String.md)> | | |
**type__ire** | Option<[**Vec<String>**](String.md)> | | |
**type__isw** | Option<[**Vec<String>**](String.md)> | | |
**type__n** | Option<[**Vec<String>**](String.md)> | | |
**type__nic** | Option<[**Vec<String>**](String.md)> | | |
**type__nie** | Option<[**Vec<String>**](String.md)> | | |
**type__niew** | Option<[**Vec<String>**](String.md)> | | |
**type__nire** | Option<[**Vec<String>**](String.md)> | | |
**type__nisw** | Option<[**Vec<String>**](String.md)> | | |
**type__nre** | Option<[**Vec<String>**](String.md)> | | |
**type__re** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedRelationshipList**](PaginatedRelationshipList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_notes_create
> crate::models::Note extras_relationships_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_notes_list
> crate::models::PaginatedNoteList extras_relationships_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_partial_update
> crate::models::Relationship extras_relationships_partial_update(id, format, patched_relationship_request)
Partial update a relationship object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship. | [required] |
**format** | Option<**String**> | | |
**patched_relationship_request** | Option<[**PatchedRelationshipRequest**](PatchedRelationshipRequest.md)> | | |
### Return type
[**crate::models::Relationship**](Relationship.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_retrieve
> crate::models::Relationship extras_relationships_retrieve(id, format, depth, exclude_m2m)
Retrieve a relationship object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Relationship**](Relationship.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_relationships_update
> crate::models::Relationship extras_relationships_update(id, relationship_request, format)
Update a relationship object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this relationship. | [required] |
**relationship_request** | [**RelationshipRequest**](RelationshipRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Relationship**](Relationship.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_bulk_destroy
> extras_roles_bulk_destroy(bulk_operation_request, format)
Destroy a list of role objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_bulk_partial_update
> Vec<crate::models::Role> extras_roles_bulk_partial_update(patched_bulk_writable_role_request, format)
Partial update a list of role objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_role_request** | [**Vec<crate::models::PatchedBulkWritableRoleRequest>**](PatchedBulkWritableRoleRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Role>**](Role.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_bulk_update
> Vec<crate::models::Role> extras_roles_bulk_update(bulk_writable_role_request, format)
Update a list of role objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_role_request** | [**Vec<crate::models::BulkWritableRoleRequest>**](BulkWritableRoleRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Role>**](Role.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_create
> crate::models::Role extras_roles_create(role_request, format)
Create one or more role objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**role_request** | [**RoleRequest**](RoleRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Role**](Role.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_destroy
> extras_roles_destroy(id, format)
Destroy a role object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this role. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_list
> crate::models::PaginatedRoleList extras_roles_list(color, color__ic, color__ie, color__iew, color__ire, color__isw, color__n, color__nic, color__nie, color__niew, color__nire, color__nisw, color__nre, color__re, contacts, contacts__isnull, contacts__n, content_types, content_types__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, weight, weight__gt, weight__gte, weight__isnull, weight__lt, weight__lte, weight__n, depth, exclude_m2m)
Retrieve a list of role objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**color** | Option<[**Vec<String>**](String.md)> | | |
**color__ic** | Option<[**Vec<String>**](String.md)> | | |
**color__ie** | Option<[**Vec<String>**](String.md)> | | |
**color__iew** | Option<[**Vec<String>**](String.md)> | | |
**color__ire** | Option<[**Vec<String>**](String.md)> | | |
**color__isw** | Option<[**Vec<String>**](String.md)> | | |
**color__n** | Option<[**Vec<String>**](String.md)> | | |
**color__nic** | Option<[**Vec<String>**](String.md)> | | |
**color__nie** | Option<[**Vec<String>**](String.md)> | | |
**color__niew** | Option<[**Vec<String>**](String.md)> | | |
**color__nire** | Option<[**Vec<String>**](String.md)> | | |
**color__nisw** | Option<[**Vec<String>**](String.md)> | | |
**color__nre** | Option<[**Vec<String>**](String.md)> | | |
**color__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**weight** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__isnull** | Option<**bool**> | | |
**weight__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**weight__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedRoleList**](PaginatedRoleList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_notes_create
> crate::models::Note extras_roles_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this role. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_notes_list
> crate::models::PaginatedNoteList extras_roles_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this role. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_partial_update
> crate::models::Role extras_roles_partial_update(id, format, patched_role_request)
Partial update a role object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this role. | [required] |
**format** | Option<**String**> | | |
**patched_role_request** | Option<[**PatchedRoleRequest**](PatchedRoleRequest.md)> | | |
### Return type
[**crate::models::Role**](Role.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_retrieve
> crate::models::Role extras_roles_retrieve(id, format, depth, exclude_m2m)
Retrieve a role object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this role. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Role**](Role.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_roles_update
> crate::models::Role extras_roles_update(id, role_request, format)
Update a role object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this role. | [required] |
**role_request** | [**RoleRequest**](RoleRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Role**](Role.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_bulk_destroy
> extras_saved_views_bulk_destroy(bulk_operation_request, format)
Destroy a list of saved view objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_bulk_partial_update
> Vec<crate::models::SavedView> extras_saved_views_bulk_partial_update(patched_bulk_writable_saved_view_request, format)
Partial update a list of saved view objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_saved_view_request** | [**Vec<crate::models::PatchedBulkWritableSavedViewRequest>**](PatchedBulkWritableSavedViewRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::SavedView>**](SavedView.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_bulk_update
> Vec<crate::models::SavedView> extras_saved_views_bulk_update(bulk_writable_saved_view_request, format)
Update a list of saved view objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_saved_view_request** | [**Vec<crate::models::BulkWritableSavedViewRequest>**](BulkWritableSavedViewRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::SavedView>**](SavedView.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_create
> crate::models::SavedView extras_saved_views_create(saved_view_request, format)
Create one or more saved view objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**saved_view_request** | [**SavedViewRequest**](SavedViewRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::SavedView**](SavedView.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_destroy
> extras_saved_views_destroy(id, format)
Destroy a saved view object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this saved view. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_list
> crate::models::PaginatedSavedViewList extras_saved_views_list(format, id, id__n, is_global_default, is_shared, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, owner, owner__n, q, sort, view, view__ic, view__ie, view__iew, view__ire, view__isw, view__n, view__nic, view__nie, view__niew, view__nire, view__nisw, view__nre, view__re, depth, exclude_m2m)
Retrieve a list of saved view objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**is_global_default** | Option<**bool**> | | |
**is_shared** | Option<**bool**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**owner** | Option<[**Vec<String>**](String.md)> | | |
**owner__n** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**view** | Option<[**Vec<String>**](String.md)> | | |
**view__ic** | Option<[**Vec<String>**](String.md)> | | |
**view__ie** | Option<[**Vec<String>**](String.md)> | | |
**view__iew** | Option<[**Vec<String>**](String.md)> | | |
**view__ire** | Option<[**Vec<String>**](String.md)> | | |
**view__isw** | Option<[**Vec<String>**](String.md)> | | |
**view__n** | Option<[**Vec<String>**](String.md)> | | |
**view__nic** | Option<[**Vec<String>**](String.md)> | | |
**view__nie** | Option<[**Vec<String>**](String.md)> | | |
**view__niew** | Option<[**Vec<String>**](String.md)> | | |
**view__nire** | Option<[**Vec<String>**](String.md)> | | |
**view__nisw** | Option<[**Vec<String>**](String.md)> | | |
**view__nre** | Option<[**Vec<String>**](String.md)> | | |
**view__re** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedSavedViewList**](PaginatedSavedViewList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_partial_update
> crate::models::SavedView extras_saved_views_partial_update(id, format, patched_saved_view_request)
Partial update a saved view object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this saved view. | [required] |
**format** | Option<**String**> | | |
**patched_saved_view_request** | Option<[**PatchedSavedViewRequest**](PatchedSavedViewRequest.md)> | | |
### Return type
[**crate::models::SavedView**](SavedView.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_retrieve
> crate::models::SavedView extras_saved_views_retrieve(id, format, depth, exclude_m2m)
Retrieve a saved view object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this saved view. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::SavedView**](SavedView.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_saved_views_update
> crate::models::SavedView extras_saved_views_update(id, saved_view_request, format)
Update a saved view object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this saved view. | [required] |
**saved_view_request** | [**SavedViewRequest**](SavedViewRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::SavedView**](SavedView.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_approve_create
> crate::models::ScheduledJob extras_scheduled_jobs_approve_create(id, force, format)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this scheduled job. | [required] |
**force** | Option<**bool**> | force execution even if start time has passed | |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ScheduledJob**](ScheduledJob.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_bulk_destroy
> extras_scheduled_jobs_bulk_destroy(bulk_operation_request, format)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_deny_create
> crate::models::ScheduledJob extras_scheduled_jobs_deny_create(id, format)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this scheduled job. | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::ScheduledJob**](ScheduledJob.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_destroy
> extras_scheduled_jobs_destroy(id, format)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this scheduled job. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_dry_run_create
> crate::models::JobResult extras_scheduled_jobs_dry_run_create(id, format)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this scheduled job. | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::JobResult**](JobResult.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_list
> crate::models::PaginatedScheduledJobList extras_scheduled_jobs_list(format, id, id__n, job_model, job_model__isnull, job_model__n, job_model_id, job_model_id__isnull, job_model_id__n, last_run_at, last_run_at__gt, last_run_at__gte, last_run_at__isnull, last_run_at__lt, last_run_at__lte, last_run_at__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, start_time, start_time__gt, start_time__gte, start_time__lt, start_time__lte, start_time__n, time_zone, time_zone__ic, time_zone__ie, time_zone__iew, time_zone__ire, time_zone__isw, time_zone__n, time_zone__nic, time_zone__nie, time_zone__niew, time_zone__nire, time_zone__nisw, time_zone__nre, time_zone__re, total_run_count, total_run_count__gt, total_run_count__gte, total_run_count__lt, total_run_count__lte, total_run_count__n, depth, exclude_m2m)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**job_model** | Option<[**Vec<String>**](String.md)> | | |
**job_model__isnull** | Option<**bool**> | Job (name or ID) is null | |
**job_model__n** | Option<[**Vec<String>**](String.md)> | | |
**job_model_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Job (ID) - Deprecated (use job_model filter) | |
**job_model_id__isnull** | Option<**bool**> | Job (ID) - Deprecated (use job_model filter) is null | |
**job_model_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Job (ID) - Deprecated (use job_model filter) | |
**last_run_at** | Option<[**Vec<String>**](String.md)> | | |
**last_run_at__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_run_at__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_run_at__isnull** | Option<**bool**> | | |
**last_run_at__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_run_at__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_run_at__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**start_time** | Option<[**Vec<String>**](String.md)> | | |
**start_time__gt** | Option<[**Vec<String>**](String.md)> | | |
**start_time__gte** | Option<[**Vec<String>**](String.md)> | | |
**start_time__lt** | Option<[**Vec<String>**](String.md)> | | |
**start_time__lte** | Option<[**Vec<String>**](String.md)> | | |
**start_time__n** | Option<[**Vec<String>**](String.md)> | | |
**time_zone** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__ic** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__ie** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__iew** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__ire** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__isw** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__n** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__nic** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__nie** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__niew** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__nire** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__nisw** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__nre** | Option<[**Vec<String>**](String.md)> | Time zone | |
**time_zone__re** | Option<[**Vec<String>**](String.md)> | Time zone | |
**total_run_count** | Option<[**Vec<i32>**](i32.md)> | | |
**total_run_count__gt** | Option<[**Vec<i32>**](i32.md)> | | |
**total_run_count__gte** | Option<[**Vec<i32>**](i32.md)> | | |
**total_run_count__lt** | Option<[**Vec<i32>**](i32.md)> | | |
**total_run_count__lte** | Option<[**Vec<i32>**](i32.md)> | | |
**total_run_count__n** | Option<[**Vec<i32>**](i32.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedScheduledJobList**](PaginatedScheduledJobList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_scheduled_jobs_retrieve
> crate::models::ScheduledJob extras_scheduled_jobs_retrieve(id, format, depth, exclude_m2m)
Retrieve a list of scheduled jobs
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this scheduled job. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ScheduledJob**](ScheduledJob.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_bulk_destroy
> extras_secrets_bulk_destroy(bulk_operation_request, format)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_bulk_partial_update
> Vec<crate::models::Secret> extras_secrets_bulk_partial_update(patched_bulk_writable_secret_request, format)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_secret_request** | [**Vec<crate::models::PatchedBulkWritableSecretRequest>**](PatchedBulkWritableSecretRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Secret>**](Secret.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_bulk_update
> Vec<crate::models::Secret> extras_secrets_bulk_update(bulk_writable_secret_request, format)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_secret_request** | [**Vec<crate::models::BulkWritableSecretRequest>**](BulkWritableSecretRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Secret>**](Secret.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_check_retrieve
> crate::models::ExtrasSecretsCheckRetrieve200Response extras_secrets_check_retrieve(id, format, depth, exclude_m2m)
Check that a secret's value is accessible.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::ExtrasSecretsCheckRetrieve200Response**](extras_secrets_check_retrieve_200_response.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_create
> crate::models::Secret extras_secrets_create(secret_request, format)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**secret_request** | [**SecretRequest**](SecretRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Secret**](Secret.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_destroy
> extras_secrets_destroy(id, format)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_bulk_destroy
> extras_secrets_groups_associations_bulk_destroy(bulk_operation_request, format)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_bulk_partial_update
> Vec<crate::models::SecretsGroupAssociation> extras_secrets_groups_associations_bulk_partial_update(patched_bulk_writable_secrets_group_association_request, format)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_secrets_group_association_request** | [**Vec<crate::models::PatchedBulkWritableSecretsGroupAssociationRequest>**](PatchedBulkWritableSecretsGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::SecretsGroupAssociation>**](SecretsGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_bulk_update
> Vec<crate::models::SecretsGroupAssociation> extras_secrets_groups_associations_bulk_update(bulk_writable_secrets_group_association_request, format)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_secrets_group_association_request** | [**Vec<crate::models::BulkWritableSecretsGroupAssociationRequest>**](BulkWritableSecretsGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::SecretsGroupAssociation>**](SecretsGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_create
> crate::models::SecretsGroupAssociation extras_secrets_groups_associations_create(secrets_group_association_request, format)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**secrets_group_association_request** | [**SecretsGroupAssociationRequest**](SecretsGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::SecretsGroupAssociation**](SecretsGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_destroy
> extras_secrets_groups_associations_destroy(id, format)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group association. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_list
> crate::models::PaginatedSecretsGroupAssociationList extras_secrets_groups_associations_list(access_type, access_type__ic, access_type__ie, access_type__iew, access_type__ire, access_type__isw, access_type__n, access_type__nic, access_type__nie, access_type__niew, access_type__nire, access_type__nisw, access_type__nre, access_type__re, format, id, id__n, limit, offset, q, secret, secret__n, secret_id, secret_id__n, secret_type, secret_type__ic, secret_type__ie, secret_type__iew, secret_type__ire, secret_type__isw, secret_type__n, secret_type__nic, secret_type__nie, secret_type__niew, secret_type__nire, secret_type__nisw, secret_type__nre, secret_type__re, secrets_group, secrets_group__n, sort, depth, exclude_m2m)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**access_type** | Option<[**Vec<String>**](String.md)> | | |
**access_type__ic** | Option<[**Vec<String>**](String.md)> | | |
**access_type__ie** | Option<[**Vec<String>**](String.md)> | | |
**access_type__iew** | Option<[**Vec<String>**](String.md)> | | |
**access_type__ire** | Option<[**Vec<String>**](String.md)> | | |
**access_type__isw** | Option<[**Vec<String>**](String.md)> | | |
**access_type__n** | Option<[**Vec<String>**](String.md)> | | |
**access_type__nic** | Option<[**Vec<String>**](String.md)> | | |
**access_type__nie** | Option<[**Vec<String>**](String.md)> | | |
**access_type__niew** | Option<[**Vec<String>**](String.md)> | | |
**access_type__nire** | Option<[**Vec<String>**](String.md)> | | |
**access_type__nisw** | Option<[**Vec<String>**](String.md)> | | |
**access_type__nre** | Option<[**Vec<String>**](String.md)> | | |
**access_type__re** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**secret** | Option<[**Vec<String>**](String.md)> | | |
**secret__n** | Option<[**Vec<String>**](String.md)> | | |
**secret_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Secret (ID) - Deprecated (use secret filter) | |
**secret_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Secret (ID) - Deprecated (use secret filter) | |
**secret_type** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__ic** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__ie** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__iew** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__ire** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__isw** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__n** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__nic** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__nie** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__niew** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__nire** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__nisw** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__nre** | Option<[**Vec<String>**](String.md)> | | |
**secret_type__re** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group** | Option<[**Vec<String>**](String.md)> | | |
**secrets_group__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedSecretsGroupAssociationList**](PaginatedSecretsGroupAssociationList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_partial_update
> crate::models::SecretsGroupAssociation extras_secrets_groups_associations_partial_update(id, format, patched_secrets_group_association_request)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group association. | [required] |
**format** | Option<**String**> | | |
**patched_secrets_group_association_request** | Option<[**PatchedSecretsGroupAssociationRequest**](PatchedSecretsGroupAssociationRequest.md)> | | |
### Return type
[**crate::models::SecretsGroupAssociation**](SecretsGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_retrieve
> crate::models::SecretsGroupAssociation extras_secrets_groups_associations_retrieve(id, format, depth, exclude_m2m)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group association. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::SecretsGroupAssociation**](SecretsGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_associations_update
> crate::models::SecretsGroupAssociation extras_secrets_groups_associations_update(id, secrets_group_association_request, format)
Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group association. | [required] |
**secrets_group_association_request** | [**SecretsGroupAssociationRequest**](SecretsGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::SecretsGroupAssociation**](SecretsGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_bulk_destroy
> extras_secrets_groups_bulk_destroy(bulk_operation_request, format)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_bulk_partial_update
> Vec<crate::models::SecretsGroup> extras_secrets_groups_bulk_partial_update(patched_bulk_writable_secrets_group_request, format)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_secrets_group_request** | [**Vec<crate::models::PatchedBulkWritableSecretsGroupRequest>**](PatchedBulkWritableSecretsGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::SecretsGroup>**](SecretsGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_bulk_update
> Vec<crate::models::SecretsGroup> extras_secrets_groups_bulk_update(bulk_writable_secrets_group_request, format)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_secrets_group_request** | [**Vec<crate::models::BulkWritableSecretsGroupRequest>**](BulkWritableSecretsGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::SecretsGroup>**](SecretsGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_create
> crate::models::SecretsGroup extras_secrets_groups_create(secrets_group_request, format)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**secrets_group_request** | [**SecretsGroupRequest**](SecretsGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::SecretsGroup**](SecretsGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_destroy
> extras_secrets_groups_destroy(id, format)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_list
> crate::models::PaginatedSecretsGroupList extras_secrets_groups_list(contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, secrets, secrets__n, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**secrets** | Option<[**Vec<String>**](String.md)> | | |
**secrets__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedSecretsGroupList**](PaginatedSecretsGroupList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_notes_create
> crate::models::Note extras_secrets_groups_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_notes_list
> crate::models::PaginatedNoteList extras_secrets_groups_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_partial_update
> crate::models::SecretsGroup extras_secrets_groups_partial_update(id, format, patched_secrets_group_request)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group. | [required] |
**format** | Option<**String**> | | |
**patched_secrets_group_request** | Option<[**PatchedSecretsGroupRequest**](PatchedSecretsGroupRequest.md)> | | |
### Return type
[**crate::models::SecretsGroup**](SecretsGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_retrieve
> crate::models::SecretsGroup extras_secrets_groups_retrieve(id, format, depth, exclude_m2m)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::SecretsGroup**](SecretsGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_groups_update
> crate::models::SecretsGroup extras_secrets_groups_update(id, secrets_group_request, format)
Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secrets group. | [required] |
**secrets_group_request** | [**SecretsGroupRequest**](SecretsGroupRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::SecretsGroup**](SecretsGroup.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_list
> crate::models::PaginatedSecretList extras_secrets_list(contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, provider, provider__ic, provider__ie, provider__iew, provider__ire, provider__isw, provider__n, provider__nic, provider__nie, provider__niew, provider__nire, provider__nisw, provider__nre, provider__re, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, depth, exclude_m2m)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**provider** | Option<[**Vec<String>**](String.md)> | | |
**provider__ic** | Option<[**Vec<String>**](String.md)> | | |
**provider__ie** | Option<[**Vec<String>**](String.md)> | | |
**provider__iew** | Option<[**Vec<String>**](String.md)> | | |
**provider__ire** | Option<[**Vec<String>**](String.md)> | | |
**provider__isw** | Option<[**Vec<String>**](String.md)> | | |
**provider__n** | Option<[**Vec<String>**](String.md)> | | |
**provider__nic** | Option<[**Vec<String>**](String.md)> | | |
**provider__nie** | Option<[**Vec<String>**](String.md)> | | |
**provider__niew** | Option<[**Vec<String>**](String.md)> | | |
**provider__nire** | Option<[**Vec<String>**](String.md)> | | |
**provider__nisw** | Option<[**Vec<String>**](String.md)> | | |
**provider__nre** | Option<[**Vec<String>**](String.md)> | | |
**provider__re** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedSecretList**](PaginatedSecretList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_notes_create
> crate::models::Note extras_secrets_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_notes_list
> crate::models::PaginatedNoteList extras_secrets_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_partial_update
> crate::models::Secret extras_secrets_partial_update(id, format, patched_secret_request)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**format** | Option<**String**> | | |
**patched_secret_request** | Option<[**PatchedSecretRequest**](PatchedSecretRequest.md)> | | |
### Return type
[**crate::models::Secret**](Secret.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_retrieve
> crate::models::Secret extras_secrets_retrieve(id, format, depth, exclude_m2m)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Secret**](Secret.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_secrets_update
> crate::models::Secret extras_secrets_update(id, secret_request, format)
Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this secret. | [required] |
**secret_request** | [**SecretRequest**](SecretRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Secret**](Secret.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_bulk_destroy
> extras_static_group_associations_bulk_destroy(bulk_operation_request, format)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_bulk_partial_update
> Vec<crate::models::StaticGroupAssociation> extras_static_group_associations_bulk_partial_update(patched_bulk_writable_static_group_association_request, format)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_static_group_association_request** | [**Vec<crate::models::PatchedBulkWritableStaticGroupAssociationRequest>**](PatchedBulkWritableStaticGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::StaticGroupAssociation>**](StaticGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_bulk_update
> Vec<crate::models::StaticGroupAssociation> extras_static_group_associations_bulk_update(bulk_writable_static_group_association_request, format)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_static_group_association_request** | [**Vec<crate::models::BulkWritableStaticGroupAssociationRequest>**](BulkWritableStaticGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::StaticGroupAssociation>**](StaticGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_create
> crate::models::StaticGroupAssociation extras_static_group_associations_create(static_group_association_request, format)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**static_group_association_request** | [**StaticGroupAssociationRequest**](StaticGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::StaticGroupAssociation**](StaticGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_destroy
> extras_static_group_associations_destroy(id, format)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this static group association. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_list
> crate::models::PaginatedStaticGroupAssociationList extras_static_group_associations_list(associated_object_id, associated_object_id__n, associated_object_type, associated_object_type__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_group, dynamic_group__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, offset, q, sort, depth, exclude_m2m)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**associated_object_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**associated_object_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**associated_object_type** | Option<[**Vec<i32>**](i32.md)> | | |
**associated_object_type__n** | Option<[**Vec<i32>**](i32.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_group** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_group__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedStaticGroupAssociationList**](PaginatedStaticGroupAssociationList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_notes_create
> crate::models::Note extras_static_group_associations_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this static group association. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_notes_list
> crate::models::PaginatedNoteList extras_static_group_associations_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this static group association. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_partial_update
> crate::models::StaticGroupAssociation extras_static_group_associations_partial_update(id, format, patched_static_group_association_request)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this static group association. | [required] |
**format** | Option<**String**> | | |
**patched_static_group_association_request** | Option<[**PatchedStaticGroupAssociationRequest**](PatchedStaticGroupAssociationRequest.md)> | | |
### Return type
[**crate::models::StaticGroupAssociation**](StaticGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_retrieve
> crate::models::StaticGroupAssociation extras_static_group_associations_retrieve(id, format, depth, exclude_m2m)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this static group association. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::StaticGroupAssociation**](StaticGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_static_group_associations_update
> crate::models::StaticGroupAssociation extras_static_group_associations_update(id, static_group_association_request, format)
Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this static group association. | [required] |
**static_group_association_request** | [**StaticGroupAssociationRequest**](StaticGroupAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::StaticGroupAssociation**](StaticGroupAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_bulk_destroy
> extras_statuses_bulk_destroy(bulk_operation_request, format)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_bulk_partial_update
> Vec<crate::models::Status> extras_statuses_bulk_partial_update(patched_bulk_writable_status_request, format)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_status_request** | [**Vec<crate::models::PatchedBulkWritableStatusRequest>**](PatchedBulkWritableStatusRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Status>**](Status.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_bulk_update
> Vec<crate::models::Status> extras_statuses_bulk_update(bulk_writable_status_request, format)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_status_request** | [**Vec<crate::models::BulkWritableStatusRequest>**](BulkWritableStatusRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Status>**](Status.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_create
> crate::models::Status extras_statuses_create(status_request, format)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**status_request** | [**StatusRequest**](StatusRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Status**](Status.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_destroy
> extras_statuses_destroy(id, format)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this status. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_list
> crate::models::PaginatedStatusList extras_statuses_list(color, color__ic, color__ie, color__iew, color__ire, color__isw, color__n, color__nic, color__nie, color__niew, color__nire, color__nisw, color__nre, color__re, contacts, contacts__isnull, contacts__n, content_types, content_types__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**color** | Option<[**Vec<String>**](String.md)> | | |
**color__ic** | Option<[**Vec<String>**](String.md)> | | |
**color__ie** | Option<[**Vec<String>**](String.md)> | | |
**color__iew** | Option<[**Vec<String>**](String.md)> | | |
**color__ire** | Option<[**Vec<String>**](String.md)> | | |
**color__isw** | Option<[**Vec<String>**](String.md)> | | |
**color__n** | Option<[**Vec<String>**](String.md)> | | |
**color__nic** | Option<[**Vec<String>**](String.md)> | | |
**color__nie** | Option<[**Vec<String>**](String.md)> | | |
**color__niew** | Option<[**Vec<String>**](String.md)> | | |
**color__nire** | Option<[**Vec<String>**](String.md)> | | |
**color__nisw** | Option<[**Vec<String>**](String.md)> | | |
**color__nre** | Option<[**Vec<String>**](String.md)> | | |
**color__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedStatusList**](PaginatedStatusList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_notes_create
> crate::models::Note extras_statuses_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this status. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_notes_list
> crate::models::PaginatedNoteList extras_statuses_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this status. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_partial_update
> crate::models::Status extras_statuses_partial_update(id, format, patched_status_request)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this status. | [required] |
**format** | Option<**String**> | | |
**patched_status_request** | Option<[**PatchedStatusRequest**](PatchedStatusRequest.md)> | | |
### Return type
[**crate::models::Status**](Status.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_retrieve
> crate::models::Status extras_statuses_retrieve(id, format, depth, exclude_m2m)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this status. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Status**](Status.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_statuses_update
> crate::models::Status extras_statuses_update(id, status_request, format)
View and manage custom status choices for objects with a `status` field.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this status. | [required] |
**status_request** | [**StatusRequest**](StatusRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Status**](Status.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_bulk_destroy
> extras_tags_bulk_destroy(bulk_operation_request, format)
Destroy a list of tag objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_bulk_partial_update
> Vec<crate::models::Tag> extras_tags_bulk_partial_update(patched_bulk_writable_tag_request, format)
Partial update a list of tag objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_tag_request** | [**Vec<crate::models::PatchedBulkWritableTagRequest>**](PatchedBulkWritableTagRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Tag>**](Tag.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_bulk_update
> Vec<crate::models::Tag> extras_tags_bulk_update(bulk_writable_tag_request, format)
Update a list of tag objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_tag_request** | [**Vec<crate::models::BulkWritableTagRequest>**](BulkWritableTagRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Tag>**](Tag.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_create
> crate::models::Tag extras_tags_create(tag_request, format)
Create one or more tag objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tag_request** | [**TagRequest**](TagRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Tag**](Tag.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_destroy
> extras_tags_destroy(id, format)
Destroy a tag object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this tag. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_list
> crate::models::PaginatedTagList extras_tags_list(color, color__ic, color__ie, color__iew, color__ire, color__isw, color__n, color__nic, color__nie, color__niew, color__nire, color__nisw, color__nre, color__re, contacts, contacts__isnull, contacts__n, content_types, content_types__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)
Retrieve a list of tag objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**color** | Option<[**Vec<String>**](String.md)> | | |
**color__ic** | Option<[**Vec<String>**](String.md)> | | |
**color__ie** | Option<[**Vec<String>**](String.md)> | | |
**color__iew** | Option<[**Vec<String>**](String.md)> | | |
**color__ire** | Option<[**Vec<String>**](String.md)> | | |
**color__isw** | Option<[**Vec<String>**](String.md)> | | |
**color__n** | Option<[**Vec<String>**](String.md)> | | |
**color__nic** | Option<[**Vec<String>**](String.md)> | | |
**color__nie** | Option<[**Vec<String>**](String.md)> | | |
**color__niew** | Option<[**Vec<String>**](String.md)> | | |
**color__nire** | Option<[**Vec<String>**](String.md)> | | |
**color__nisw** | Option<[**Vec<String>**](String.md)> | | |
**color__nre** | Option<[**Vec<String>**](String.md)> | | |
**color__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedTagList**](PaginatedTagList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_notes_create
> crate::models::Note extras_tags_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this tag. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_notes_list
> crate::models::PaginatedNoteList extras_tags_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this tag. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_partial_update
> crate::models::Tag extras_tags_partial_update(id, format, patched_tag_request)
Partial update a tag object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this tag. | [required] |
**format** | Option<**String**> | | |
**patched_tag_request** | Option<[**PatchedTagRequest**](PatchedTagRequest.md)> | | |
### Return type
[**crate::models::Tag**](Tag.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_retrieve
> crate::models::Tag extras_tags_retrieve(id, format, depth, exclude_m2m)
Retrieve a tag object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this tag. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Tag**](Tag.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_tags_update
> crate::models::Tag extras_tags_update(id, tag_request, format)
Update a tag object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this tag. | [required] |
**tag_request** | [**TagRequest**](TagRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Tag**](Tag.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_bulk_destroy
> extras_teams_bulk_destroy(bulk_operation_request, format)
Destroy a list of team objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_bulk_partial_update
> Vec<crate::models::Team> extras_teams_bulk_partial_update(patched_bulk_writable_team_request, format)
Partial update a list of team objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_team_request** | [**Vec<crate::models::PatchedBulkWritableTeamRequest>**](PatchedBulkWritableTeamRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Team>**](Team.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_bulk_update
> Vec<crate::models::Team> extras_teams_bulk_update(bulk_writable_team_request, format)
Update a list of team objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_team_request** | [**Vec<crate::models::BulkWritableTeamRequest>**](BulkWritableTeamRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Team>**](Team.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_create
> crate::models::Team extras_teams_create(team_request, format)
Create one or more team objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**team_request** | [**TeamRequest**](TeamRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Team**](Team.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_destroy
> extras_teams_destroy(id, format)
Destroy a team object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this team. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_list
> crate::models::PaginatedTeamList extras_teams_list(address, address__ic, address__ie, address__iew, address__ire, address__isw, address__n, address__nic, address__nie, address__niew, address__nire, address__nisw, address__nre, address__re, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, contacts, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, email, email__ic, email__ie, email__iew, email__ire, email__isw, email__n, email__nic, email__nie, email__niew, email__nire, email__nisw, email__nre, email__re, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, phone, phone__ic, phone__ie, phone__iew, phone__ire, phone__isw, phone__n, phone__nic, phone__nie, phone__niew, phone__nire, phone__nisw, phone__nre, phone__re, q, similar_to_location_data, sort, tags, tags__isnull, tags__n, depth, exclude_m2m)
Retrieve a list of team objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**address** | Option<[**Vec<String>**](String.md)> | | |
**address__ic** | Option<[**Vec<String>**](String.md)> | | |
**address__ie** | Option<[**Vec<String>**](String.md)> | | |
**address__iew** | Option<[**Vec<String>**](String.md)> | | |
**address__ire** | Option<[**Vec<String>**](String.md)> | | |
**address__isw** | Option<[**Vec<String>**](String.md)> | | |
**address__n** | Option<[**Vec<String>**](String.md)> | | |
**address__nic** | Option<[**Vec<String>**](String.md)> | | |
**address__nie** | Option<[**Vec<String>**](String.md)> | | |
**address__niew** | Option<[**Vec<String>**](String.md)> | | |
**address__nire** | Option<[**Vec<String>**](String.md)> | | |
**address__nisw** | Option<[**Vec<String>**](String.md)> | | |
**address__nre** | Option<[**Vec<String>**](String.md)> | | |
**address__re** | Option<[**Vec<String>**](String.md)> | | |
**comments** | Option<[**Vec<String>**](String.md)> | | |
**comments__ic** | Option<[**Vec<String>**](String.md)> | | |
**comments__ie** | Option<[**Vec<String>**](String.md)> | | |
**comments__iew** | Option<[**Vec<String>**](String.md)> | | |
**comments__ire** | Option<[**Vec<String>**](String.md)> | | |
**comments__isw** | Option<[**Vec<String>**](String.md)> | | |
**comments__n** | Option<[**Vec<String>**](String.md)> | | |
**comments__nic** | Option<[**Vec<String>**](String.md)> | | |
**comments__nie** | Option<[**Vec<String>**](String.md)> | | |
**comments__niew** | Option<[**Vec<String>**](String.md)> | | |
**comments__nire** | Option<[**Vec<String>**](String.md)> | | |
**comments__nisw** | Option<[**Vec<String>**](String.md)> | | |
**comments__nre** | Option<[**Vec<String>**](String.md)> | | |
**comments__re** | Option<[**Vec<String>**](String.md)> | | |
**contacts** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**contacts__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**created** | Option<[**Vec<String>**](String.md)> | | |
**created__gt** | Option<[**Vec<String>**](String.md)> | | |
**created__gte** | Option<[**Vec<String>**](String.md)> | | |
**created__isnull** | Option<**bool**> | | |
**created__lt** | Option<[**Vec<String>**](String.md)> | | |
**created__lte** | Option<[**Vec<String>**](String.md)> | | |
**created__n** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**email** | Option<[**Vec<String>**](String.md)> | | |
**email__ic** | Option<[**Vec<String>**](String.md)> | | |
**email__ie** | Option<[**Vec<String>**](String.md)> | | |
**email__iew** | Option<[**Vec<String>**](String.md)> | | |
**email__ire** | Option<[**Vec<String>**](String.md)> | | |
**email__isw** | Option<[**Vec<String>**](String.md)> | | |
**email__n** | Option<[**Vec<String>**](String.md)> | | |
**email__nic** | Option<[**Vec<String>**](String.md)> | | |
**email__nie** | Option<[**Vec<String>**](String.md)> | | |
**email__niew** | Option<[**Vec<String>**](String.md)> | | |
**email__nire** | Option<[**Vec<String>**](String.md)> | | |
**email__nisw** | Option<[**Vec<String>**](String.md)> | | |
**email__nre** | Option<[**Vec<String>**](String.md)> | | |
**email__re** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__isnull** | Option<**bool**> | | |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> | | |
**last_updated__n** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**phone** | Option<[**Vec<String>**](String.md)> | | |
**phone__ic** | Option<[**Vec<String>**](String.md)> | | |
**phone__ie** | Option<[**Vec<String>**](String.md)> | | |
**phone__iew** | Option<[**Vec<String>**](String.md)> | | |
**phone__ire** | Option<[**Vec<String>**](String.md)> | | |
**phone__isw** | Option<[**Vec<String>**](String.md)> | | |
**phone__n** | Option<[**Vec<String>**](String.md)> | | |
**phone__nic** | Option<[**Vec<String>**](String.md)> | | |
**phone__nie** | Option<[**Vec<String>**](String.md)> | | |
**phone__niew** | Option<[**Vec<String>**](String.md)> | | |
**phone__nire** | Option<[**Vec<String>**](String.md)> | | |
**phone__nisw** | Option<[**Vec<String>**](String.md)> | | |
**phone__nre** | Option<[**Vec<String>**](String.md)> | | |
**phone__re** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**similar_to_location_data** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**tags** | Option<[**Vec<String>**](String.md)> | | |
**tags__isnull** | Option<**bool**> | | |
**tags__n** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedTeamList**](PaginatedTeamList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_notes_create
> crate::models::Note extras_teams_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this team. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_notes_list
> crate::models::PaginatedNoteList extras_teams_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this team. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_partial_update
> crate::models::Team extras_teams_partial_update(id, format, patched_team_request)
Partial update a team object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this team. | [required] |
**format** | Option<**String**> | | |
**patched_team_request** | Option<[**PatchedTeamRequest**](PatchedTeamRequest.md)> | | |
### Return type
[**crate::models::Team**](Team.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_retrieve
> crate::models::Team extras_teams_retrieve(id, format, depth, exclude_m2m)
Retrieve a team object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this team. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Team**](Team.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_teams_update
> crate::models::Team extras_teams_update(id, team_request, format)
Update a team object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this team. | [required] |
**team_request** | [**TeamRequest**](TeamRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Team**](Team.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_bulk_destroy
> extras_user_saved_view_associations_bulk_destroy(bulk_operation_request, format)
Destroy a list of user saved view association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_bulk_partial_update
> Vec<crate::models::UserSavedViewAssociation> extras_user_saved_view_associations_bulk_partial_update(patched_bulk_writable_user_saved_view_association_request, format)
Partial update a list of user saved view association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_user_saved_view_association_request** | [**Vec<crate::models::PatchedBulkWritableUserSavedViewAssociationRequest>**](PatchedBulkWritableUserSavedViewAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::UserSavedViewAssociation>**](UserSavedViewAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_bulk_update
> Vec<crate::models::UserSavedViewAssociation> extras_user_saved_view_associations_bulk_update(bulk_writable_user_saved_view_association_request, format)
Update a list of user saved view association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_user_saved_view_association_request** | [**Vec<crate::models::BulkWritableUserSavedViewAssociationRequest>**](BulkWritableUserSavedViewAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::UserSavedViewAssociation>**](UserSavedViewAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_create
> crate::models::UserSavedViewAssociation extras_user_saved_view_associations_create(user_saved_view_association_request, format)
Create one or more user saved view association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_saved_view_association_request** | [**UserSavedViewAssociationRequest**](UserSavedViewAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::UserSavedViewAssociation**](UserSavedViewAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_destroy
> extras_user_saved_view_associations_destroy(id, format)
Destroy a user saved view association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this user saved view association. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_list
> crate::models::PaginatedUserSavedViewAssociationList extras_user_saved_view_associations_list(created, format, id, id__n, last_updated, limit, offset, saved_view, saved_view__n, sort, user, user__n, view_name, view_name__ic, view_name__ie, view_name__iew, view_name__ire, view_name__isw, view_name__n, view_name__nic, view_name__nie, view_name__niew, view_name__nire, view_name__nisw, view_name__nre, view_name__re, depth, exclude_m2m)
Retrieve a list of user saved view association objects.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**created** | Option<[**Vec<String>**](String.md)> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**last_updated** | Option<[**Vec<String>**](String.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**saved_view** | Option<[**Vec<String>**](String.md)> | | |
**saved_view__n** | Option<[**Vec<String>**](String.md)> | | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**user** | Option<[**Vec<String>**](String.md)> | | |
**user__n** | Option<[**Vec<String>**](String.md)> | | |
**view_name** | Option<[**Vec<String>**](String.md)> | | |
**view_name__ic** | Option<[**Vec<String>**](String.md)> | | |
**view_name__ie** | Option<[**Vec<String>**](String.md)> | | |
**view_name__iew** | Option<[**Vec<String>**](String.md)> | | |
**view_name__ire** | Option<[**Vec<String>**](String.md)> | | |
**view_name__isw** | Option<[**Vec<String>**](String.md)> | | |
**view_name__n** | Option<[**Vec<String>**](String.md)> | | |
**view_name__nic** | Option<[**Vec<String>**](String.md)> | | |
**view_name__nie** | Option<[**Vec<String>**](String.md)> | | |
**view_name__niew** | Option<[**Vec<String>**](String.md)> | | |
**view_name__nire** | Option<[**Vec<String>**](String.md)> | | |
**view_name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**view_name__nre** | Option<[**Vec<String>**](String.md)> | | |
**view_name__re** | Option<[**Vec<String>**](String.md)> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedUserSavedViewAssociationList**](PaginatedUserSavedViewAssociationList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_partial_update
> crate::models::UserSavedViewAssociation extras_user_saved_view_associations_partial_update(id, format, patched_user_saved_view_association_request)
Partial update a user saved view association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this user saved view association. | [required] |
**format** | Option<**String**> | | |
**patched_user_saved_view_association_request** | Option<[**PatchedUserSavedViewAssociationRequest**](PatchedUserSavedViewAssociationRequest.md)> | | |
### Return type
[**crate::models::UserSavedViewAssociation**](UserSavedViewAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_retrieve
> crate::models::UserSavedViewAssociation extras_user_saved_view_associations_retrieve(id, format, depth, exclude_m2m)
Retrieve a user saved view association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this user saved view association. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::UserSavedViewAssociation**](UserSavedViewAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_user_saved_view_associations_update
> crate::models::UserSavedViewAssociation extras_user_saved_view_associations_update(id, user_saved_view_association_request, format)
Update a user saved view association object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this user saved view association. | [required] |
**user_saved_view_association_request** | [**UserSavedViewAssociationRequest**](UserSavedViewAssociationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::UserSavedViewAssociation**](UserSavedViewAssociation.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_bulk_destroy
> extras_webhooks_bulk_destroy(bulk_operation_request, format)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_bulk_partial_update
> Vec<crate::models::Webhook> extras_webhooks_bulk_partial_update(patched_bulk_writable_webhook_request, format)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_webhook_request** | [**Vec<crate::models::PatchedBulkWritableWebhookRequest>**](PatchedBulkWritableWebhookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Webhook>**](Webhook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_bulk_update
> Vec<crate::models::Webhook> extras_webhooks_bulk_update(bulk_writable_webhook_request, format)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_webhook_request** | [**Vec<crate::models::BulkWritableWebhookRequest>**](BulkWritableWebhookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**Vec<crate::models::Webhook>**](Webhook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_create
> crate::models::Webhook extras_webhooks_create(webhook_request, format)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**webhook_request** | [**WebhookRequest**](WebhookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Webhook**](Webhook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_destroy
> extras_webhooks_destroy(id, format)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this webhook. | [required] |
**format** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_list
> crate::models::PaginatedWebhookList extras_webhooks_list(contacts, contacts__isnull, contacts__n, content_types, content_types__n, dynamic_groups, dynamic_groups__n, enabled, format, id, id__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, payload_url, payload_url__ic, payload_url__ie, payload_url__iew, payload_url__ire, payload_url__isw, payload_url__n, payload_url__nic, payload_url__nie, payload_url__niew, payload_url__nire, payload_url__nisw, payload_url__nre, payload_url__re, q, sort, teams, teams__isnull, teams__n, type_create, type_delete, type_update, depth, exclude_m2m)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> | | |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null | |
**contacts__n** | Option<[**Vec<String>**](String.md)> | | |
**content_types** | Option<[**Vec<i32>**](i32.md)> | | |
**content_types__n** | Option<[**Vec<i32>**](i32.md)> | | |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> | | |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> | | |
**enabled** | Option<**bool**> | | |
**format** | Option<**String**> | | |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. | |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**name** | Option<[**Vec<String>**](String.md)> | | |
**name__ic** | Option<[**Vec<String>**](String.md)> | | |
**name__ie** | Option<[**Vec<String>**](String.md)> | | |
**name__iew** | Option<[**Vec<String>**](String.md)> | | |
**name__ire** | Option<[**Vec<String>**](String.md)> | | |
**name__isw** | Option<[**Vec<String>**](String.md)> | | |
**name__n** | Option<[**Vec<String>**](String.md)> | | |
**name__nic** | Option<[**Vec<String>**](String.md)> | | |
**name__nie** | Option<[**Vec<String>**](String.md)> | | |
**name__niew** | Option<[**Vec<String>**](String.md)> | | |
**name__nire** | Option<[**Vec<String>**](String.md)> | | |
**name__nisw** | Option<[**Vec<String>**](String.md)> | | |
**name__nre** | Option<[**Vec<String>**](String.md)> | | |
**name__re** | Option<[**Vec<String>**](String.md)> | | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**payload_url** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__ic** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__ie** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__iew** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__ire** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__isw** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__n** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__nic** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__nie** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__niew** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__nire** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__nisw** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__nre** | Option<[**Vec<String>**](String.md)> | | |
**payload_url__re** | Option<[**Vec<String>**](String.md)> | | |
**q** | Option<**String**> | Search | |
**sort** | Option<**String**> | Which field to use when ordering the results. | |
**teams** | Option<[**Vec<String>**](String.md)> | | |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null | |
**teams__n** | Option<[**Vec<String>**](String.md)> | | |
**type_create** | Option<**bool**> | | |
**type_delete** | Option<**bool**> | | |
**type_update** | Option<**bool**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedWebhookList**](PaginatedWebhookList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_notes_create
> crate::models::Note extras_webhooks_notes_create(id, note_input_request, format)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this webhook. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Note**](Note.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_notes_list
> crate::models::PaginatedNoteList extras_webhooks_notes_list(id, format, limit, offset, depth, exclude_m2m)
API methods for returning or creating notes on an object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this webhook. | [required] |
**format** | Option<**String**> | | |
**limit** | Option<**i32**> | Number of results to return per page. | |
**offset** | Option<**i32**> | The initial index from which to return the results. | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_partial_update
> crate::models::Webhook extras_webhooks_partial_update(id, format, patched_webhook_request)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this webhook. | [required] |
**format** | Option<**String**> | | |
**patched_webhook_request** | Option<[**PatchedWebhookRequest**](PatchedWebhookRequest.md)> | | |
### Return type
[**crate::models::Webhook**](Webhook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_retrieve
> crate::models::Webhook extras_webhooks_retrieve(id, format, depth, exclude_m2m)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this webhook. | [required] |
**format** | Option<**String**> | | |
**depth** | Option<**i32**> | Serializer Depth | |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response | |[default to false]
### Return type
[**crate::models::Webhook**](Webhook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## extras_webhooks_update
> crate::models::Webhook extras_webhooks_update(id, webhook_request, format)
Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this webhook. | [required] |
**webhook_request** | [**WebhookRequest**](WebhookRequest.md) | | [required] |
**format** | Option<**String**> | | |
### Return type
[**crate::models::Webhook**](Webhook.md)
### Authorization
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)