{ "opencollection": "1.0.0", "info": { "name": "NetBox REST authentication-check extras API", "version": "4.5.9 (4.5)" }, "items": [ { "info": { "name": "extras", "type": "folder" }, "items": [ { "info": { "name": "extras_bookmarks_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/bookmarks/", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "object_id", "value": "", "type": "query" }, { "name": "object_id__empty", "value": "", "type": "query" }, { "name": "object_id__gt", "value": "", "type": "query" }, { "name": "object_id__gte", "value": "", "type": "query" }, { "name": "object_id__lt", "value": "", "type": "query" }, { "name": "object_id__lte", "value": "", "type": "query" }, { "name": "object_id__n", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__empty", "value": "", "type": "query" }, { "name": "object_type_id__gt", "value": "", "type": "query" }, { "name": "object_type_id__gte", "value": "", "type": "query" }, { "name": "object_type_id__lt", "value": "", "type": "query" }, { "name": "object_type_id__lte", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "user", "value": "", "type": "query", "description": "User (name)" }, { "name": "user__n", "value": "", "type": "query", "description": "User (name)" }, { "name": "user_id", "value": "", "type": "query", "description": "User (ID)" }, { "name": "user_id__n", "value": "", "type": "query", "description": "User (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of bookmark objects." }, { "info": { "name": "extras_bookmarks_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/bookmarks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of bookmark objects." }, { "info": { "name": "extras_bookmarks_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/bookmarks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of bookmark objects." }, { "info": { "name": "extras_bookmarks_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/bookmarks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of bookmark objects." }, { "info": { "name": "extras_bookmarks_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/bookmarks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of bookmark objects." }, { "info": { "name": "extras_bookmarks_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/bookmarks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this bookmark." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a bookmark object." }, { "info": { "name": "extras_bookmarks_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/bookmarks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this bookmark." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a bookmark object." }, { "info": { "name": "extras_bookmarks_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/bookmarks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this bookmark." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a bookmark object." }, { "info": { "name": "extras_bookmarks_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/bookmarks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this bookmark." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a bookmark object." }, { "info": { "name": "extras_config_context_profiles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/config-context-profiles/", "params": [ { "name": "auto_sync_enabled", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "data_file_id", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_file_id__n", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_source_id", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_source_id__n", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_synced", "value": "", "type": "query" }, { "name": "data_synced__empty", "value": "", "type": "query" }, { "name": "data_synced__gt", "value": "", "type": "query" }, { "name": "data_synced__gte", "value": "", "type": "query" }, { "name": "data_synced__lt", "value": "", "type": "query" }, { "name": "data_synced__lte", "value": "", "type": "query" }, { "name": "data_synced__n", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of config context profile objects." }, { "info": { "name": "extras_config_context_profiles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-context-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of config context profile objects." }, { "info": { "name": "extras_config_context_profiles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/config-context-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of config context profile objects." }, { "info": { "name": "extras_config_context_profiles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/config-context-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of config context profile objects." }, { "info": { "name": "extras_config_context_profiles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/config-context-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of config context profile objects." }, { "info": { "name": "extras_config_context_profiles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/config-context-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context profile." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a config context profile object." }, { "info": { "name": "extras_config_context_profiles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/config-context-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context profile." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a config context profile object." }, { "info": { "name": "extras_config_context_profiles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/config-context-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context profile." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a config context profile object." }, { "info": { "name": "extras_config_context_profiles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/config-context-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context profile." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a config context profile object." }, { "info": { "name": "extras_config_context_profiles_sync_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-context-profiles/:id/sync/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context profile." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any)." }, { "info": { "name": "extras_config_contexts_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/config-contexts/", "params": [ { "name": "auto_sync_enabled", "value": "", "type": "query" }, { "name": "cluster_group", "value": "", "type": "query", "description": "Cluster group (slug)" }, { "name": "cluster_group__n", "value": "", "type": "query", "description": "Cluster group (slug)" }, { "name": "cluster_group_id", "value": "", "type": "query", "description": "Cluster group" }, { "name": "cluster_group_id__n", "value": "", "type": "query", "description": "Cluster group" }, { "name": "cluster_id", "value": "", "type": "query", "description": "Cluster" }, { "name": "cluster_id__n", "value": "", "type": "query", "description": "Cluster" }, { "name": "cluster_type", "value": "", "type": "query", "description": "Cluster type (slug)" }, { "name": "cluster_type__n", "value": "", "type": "query", "description": "Cluster type (slug)" }, { "name": "cluster_type_id", "value": "", "type": "query", "description": "Cluster type" }, { "name": "cluster_type_id__n", "value": "", "type": "query", "description": "Cluster type" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "data_file_id", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_file_id__n", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_source_id", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_source_id__n", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_synced", "value": "", "type": "query" }, { "name": "data_synced__empty", "value": "", "type": "query" }, { "name": "data_synced__gt", "value": "", "type": "query" }, { "name": "data_synced__gte", "value": "", "type": "query" }, { "name": "data_synced__lt", "value": "", "type": "query" }, { "name": "data_synced__lte", "value": "", "type": "query" }, { "name": "data_synced__n", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "device_role", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Role" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Role" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "location", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "platform", "value": "", "type": "query", "description": "Platform (slug)" }, { "name": "platform__n", "value": "", "type": "query", "description": "Platform (slug)" }, { "name": "platform_id", "value": "", "type": "query", "description": "Platform" }, { "name": "platform_id__n", "value": "", "type": "query", "description": "Platform" }, { "name": "profile", "value": "", "type": "query", "description": "Profile (name)" }, { "name": "profile__n", "value": "", "type": "query", "description": "Profile (name)" }, { "name": "profile_id", "value": "", "type": "query", "description": "Profile (ID)" }, { "name": "profile_id__n", "value": "", "type": "query", "description": "Profile (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "region", "value": "", "type": "query", "description": "Region (slug)" }, { "name": "region__n", "value": "", "type": "query", "description": "Region (slug)" }, { "name": "region_id", "value": "", "type": "query", "description": "Region" }, { "name": "region_id__n", "value": "", "type": "query", "description": "Region" }, { "name": "site", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site_group", "value": "", "type": "query", "description": "Site group (slug)" }, { "name": "site_group__n", "value": "", "type": "query", "description": "Site group (slug)" }, { "name": "site_group_id", "value": "", "type": "query", "description": "Site group" }, { "name": "site_group_id__n", "value": "", "type": "query", "description": "Site group" }, { "name": "site_id", "value": "", "type": "query", "description": "Site" }, { "name": "site_id__n", "value": "", "type": "query", "description": "Site" }, { "name": "tag", "value": "", "type": "query", "description": "Tag (slug)" }, { "name": "tag__n", "value": "", "type": "query", "description": "Tag (slug)" }, { "name": "tag_id", "value": "", "type": "query", "description": "Tag" }, { "name": "tag_id__n", "value": "", "type": "query", "description": "Tag" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query", "description": "Tenant group (slug)" }, { "name": "tenant_group__n", "value": "", "type": "query", "description": "Tenant group (slug)" }, { "name": "tenant_group_id", "value": "", "type": "query", "description": "Tenant group" }, { "name": "tenant_group_id__n", "value": "", "type": "query", "description": "Tenant group" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of config context objects." }, { "info": { "name": "extras_config_contexts_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of config context objects." }, { "info": { "name": "extras_config_contexts_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/config-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of config context objects." }, { "info": { "name": "extras_config_contexts_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/config-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of config context objects." }, { "info": { "name": "extras_config_contexts_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/config-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of config context objects." }, { "info": { "name": "extras_config_contexts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/config-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a config context object." }, { "info": { "name": "extras_config_contexts_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/config-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a config context object." }, { "info": { "name": "extras_config_contexts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/config-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a config context object." }, { "info": { "name": "extras_config_contexts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/config-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a config context object." }, { "info": { "name": "extras_config_contexts_sync_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-contexts/:id/sync/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config context." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any)." }, { "info": { "name": "extras_config_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/config-templates/", "params": [ { "name": "as_attachment", "value": "", "type": "query" }, { "name": "auto_sync_enabled", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "data_file_id", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_file_id__n", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_source_id", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_source_id__n", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_synced", "value": "", "type": "query" }, { "name": "data_synced__empty", "value": "", "type": "query" }, { "name": "data_synced__gt", "value": "", "type": "query" }, { "name": "data_synced__gte", "value": "", "type": "query" }, { "name": "data_synced__lt", "value": "", "type": "query" }, { "name": "data_synced__lte", "value": "", "type": "query" }, { "name": "data_synced__n", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "file_extension", "value": "", "type": "query" }, { "name": "file_extension__empty", "value": "", "type": "query" }, { "name": "file_extension__ic", "value": "", "type": "query" }, { "name": "file_extension__ie", "value": "", "type": "query" }, { "name": "file_extension__iew", "value": "", "type": "query" }, { "name": "file_extension__iregex", "value": "", "type": "query" }, { "name": "file_extension__isw", "value": "", "type": "query" }, { "name": "file_extension__n", "value": "", "type": "query" }, { "name": "file_extension__nic", "value": "", "type": "query" }, { "name": "file_extension__nie", "value": "", "type": "query" }, { "name": "file_extension__niew", "value": "", "type": "query" }, { "name": "file_extension__nisw", "value": "", "type": "query" }, { "name": "file_extension__regex", "value": "", "type": "query" }, { "name": "file_name", "value": "", "type": "query" }, { "name": "file_name__empty", "value": "", "type": "query" }, { "name": "file_name__ic", "value": "", "type": "query" }, { "name": "file_name__ie", "value": "", "type": "query" }, { "name": "file_name__iew", "value": "", "type": "query" }, { "name": "file_name__iregex", "value": "", "type": "query" }, { "name": "file_name__isw", "value": "", "type": "query" }, { "name": "file_name__n", "value": "", "type": "query" }, { "name": "file_name__nic", "value": "", "type": "query" }, { "name": "file_name__nie", "value": "", "type": "query" }, { "name": "file_name__niew", "value": "", "type": "query" }, { "name": "file_name__nisw", "value": "", "type": "query" }, { "name": "file_name__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "mime_type", "value": "", "type": "query" }, { "name": "mime_type__empty", "value": "", "type": "query" }, { "name": "mime_type__ic", "value": "", "type": "query" }, { "name": "mime_type__ie", "value": "", "type": "query" }, { "name": "mime_type__iew", "value": "", "type": "query" }, { "name": "mime_type__iregex", "value": "", "type": "query" }, { "name": "mime_type__isw", "value": "", "type": "query" }, { "name": "mime_type__n", "value": "", "type": "query" }, { "name": "mime_type__nic", "value": "", "type": "query" }, { "name": "mime_type__nie", "value": "", "type": "query" }, { "name": "mime_type__niew", "value": "", "type": "query" }, { "name": "mime_type__nisw", "value": "", "type": "query" }, { "name": "mime_type__regex", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of config template objects." }, { "info": { "name": "extras_config_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of config template objects." }, { "info": { "name": "extras_config_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/config-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of config template objects." }, { "info": { "name": "extras_config_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/config-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of config template objects." }, { "info": { "name": "extras_config_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/config-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of config template objects." }, { "info": { "name": "extras_config_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/config-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a config template object." }, { "info": { "name": "extras_config_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/config-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a config template object." }, { "info": { "name": "extras_config_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/config-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a config template object." }, { "info": { "name": "extras_config_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/config-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a config template object." }, { "info": { "name": "extras_config_templates_render_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-templates/:id/render/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Render a ConfigTemplate using the context data provided (if any). If the client requests \"text/plain\" data,\nreturn the raw rendered content, rather than serialized JSON." }, { "info": { "name": "extras_config_templates_sync_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/config-templates/:id/sync/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this config template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any)." }, { "info": { "name": "extras_custom_field_choice_sets_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-field-choice-sets/", "params": [ { "name": "base_choices", "value": "", "type": "query", "description": "Base set of predefined choices (optional)\n\n* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)" }, { "name": "base_choices__empty", "value": "", "type": "query" }, { "name": "base_choices__ic", "value": "", "type": "query" }, { "name": "base_choices__ie", "value": "", "type": "query" }, { "name": "base_choices__iew", "value": "", "type": "query" }, { "name": "base_choices__iregex", "value": "", "type": "query" }, { "name": "base_choices__isw", "value": "", "type": "query" }, { "name": "base_choices__n", "value": "", "type": "query", "description": "Base set of predefined choices (optional)\n\n* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)" }, { "name": "base_choices__nic", "value": "", "type": "query" }, { "name": "base_choices__nie", "value": "", "type": "query" }, { "name": "base_choices__niew", "value": "", "type": "query" }, { "name": "base_choices__nisw", "value": "", "type": "query" }, { "name": "base_choices__regex", "value": "", "type": "query" }, { "name": "choice", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "order_alphabetically", "value": "", "type": "query" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of custom field choice set objects." }, { "info": { "name": "extras_custom_field_choice_sets_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/custom-field-choice-sets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of custom field choice set objects." }, { "info": { "name": "extras_custom_field_choice_sets_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/custom-field-choice-sets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of custom field choice set objects." }, { "info": { "name": "extras_custom_field_choice_sets_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/custom-field-choice-sets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of custom field choice set objects." }, { "info": { "name": "extras_custom_field_choice_sets_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/custom-field-choice-sets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of custom field choice set objects." }, { "info": { "name": "extras_custom_field_choice_sets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-field-choice-sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field choice set." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a custom field choice set object." }, { "info": { "name": "extras_custom_field_choice_sets_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/custom-field-choice-sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field choice set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a custom field choice set object." }, { "info": { "name": "extras_custom_field_choice_sets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/custom-field-choice-sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field choice set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a custom field choice set object." }, { "info": { "name": "extras_custom_field_choice_sets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/custom-field-choice-sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field choice set." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a custom field choice set object." }, { "info": { "name": "extras_custom_field_choice_sets_choices_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-field-choice-sets/:id/choices/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field choice set." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Provides an endpoint to iterate through each choice in a set." }, { "info": { "name": "extras_custom_fields_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-fields/", "params": [ { "name": "choice_set", "value": "", "type": "query" }, { "name": "choice_set__n", "value": "", "type": "query" }, { "name": "choice_set_id", "value": "", "type": "query" }, { "name": "choice_set_id__n", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "filter_logic", "value": "", "type": "query", "description": "Loose matches any instance of a given string; exact matches the entire field.\n\n* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact" }, { "name": "filter_logic__empty", "value": "", "type": "query" }, { "name": "filter_logic__ic", "value": "", "type": "query" }, { "name": "filter_logic__ie", "value": "", "type": "query" }, { "name": "filter_logic__iew", "value": "", "type": "query" }, { "name": "filter_logic__iregex", "value": "", "type": "query" }, { "name": "filter_logic__isw", "value": "", "type": "query" }, { "name": "filter_logic__n", "value": "", "type": "query", "description": "Loose matches any instance of a given string; exact matches the entire field.\n\n* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact" }, { "name": "filter_logic__nic", "value": "", "type": "query" }, { "name": "filter_logic__nie", "value": "", "type": "query" }, { "name": "filter_logic__niew", "value": "", "type": "query" }, { "name": "filter_logic__nisw", "value": "", "type": "query" }, { "name": "filter_logic__regex", "value": "", "type": "query" }, { "name": "group_name", "value": "", "type": "query" }, { "name": "group_name__empty", "value": "", "type": "query" }, { "name": "group_name__ic", "value": "", "type": "query" }, { "name": "group_name__ie", "value": "", "type": "query" }, { "name": "group_name__iew", "value": "", "type": "query" }, { "name": "group_name__iregex", "value": "", "type": "query" }, { "name": "group_name__isw", "value": "", "type": "query" }, { "name": "group_name__n", "value": "", "type": "query" }, { "name": "group_name__nic", "value": "", "type": "query" }, { "name": "group_name__nie", "value": "", "type": "query" }, { "name": "group_name__niew", "value": "", "type": "query" }, { "name": "group_name__nisw", "value": "", "type": "query" }, { "name": "group_name__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "is_cloneable", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__ic", "value": "", "type": "query" }, { "name": "object_type__ie", "value": "", "type": "query" }, { "name": "object_type__iew", "value": "", "type": "query" }, { "name": "object_type__iregex", "value": "", "type": "query" }, { "name": "object_type__isw", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type__nic", "value": "", "type": "query" }, { "name": "object_type__nie", "value": "", "type": "query" }, { "name": "object_type__niew", "value": "", "type": "query" }, { "name": "object_type__nisw", "value": "", "type": "query" }, { "name": "object_type__regex", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "related_object_type", "value": "", "type": "query" }, { "name": "related_object_type__n", "value": "", "type": "query" }, { "name": "related_object_type_id", "value": "", "type": "query" }, { "name": "related_object_type_id__n", "value": "", "type": "query" }, { "name": "required", "value": "", "type": "query" }, { "name": "search_weight", "value": "", "type": "query" }, { "name": "search_weight__empty", "value": "", "type": "query" }, { "name": "search_weight__gt", "value": "", "type": "query" }, { "name": "search_weight__gte", "value": "", "type": "query" }, { "name": "search_weight__lt", "value": "", "type": "query" }, { "name": "search_weight__lte", "value": "", "type": "query" }, { "name": "search_weight__n", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__ie", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__iew", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__iregex", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__isw", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__n", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__nic", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__nie", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__niew", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__nisw", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "type__regex", "value": "", "type": "query", "description": "The type of data this custom field holds" }, { "name": "ui_editable", "value": "", "type": "query", "description": "Specifies whether the custom field value can be edited in the UI\n\n* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden" }, { "name": "ui_editable__empty", "value": "", "type": "query" }, { "name": "ui_editable__ic", "value": "", "type": "query" }, { "name": "ui_editable__ie", "value": "", "type": "query" }, { "name": "ui_editable__iew", "value": "", "type": "query" }, { "name": "ui_editable__iregex", "value": "", "type": "query" }, { "name": "ui_editable__isw", "value": "", "type": "query" }, { "name": "ui_editable__n", "value": "", "type": "query", "description": "Specifies whether the custom field value can be edited in the UI\n\n* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden" }, { "name": "ui_editable__nic", "value": "", "type": "query" }, { "name": "ui_editable__nie", "value": "", "type": "query" }, { "name": "ui_editable__niew", "value": "", "type": "query" }, { "name": "ui_editable__nisw", "value": "", "type": "query" }, { "name": "ui_editable__regex", "value": "", "type": "query" }, { "name": "ui_visible", "value": "", "type": "query", "description": "Specifies whether the custom field is displayed in the UI\n\n* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden" }, { "name": "ui_visible__empty", "value": "", "type": "query" }, { "name": "ui_visible__ic", "value": "", "type": "query" }, { "name": "ui_visible__ie", "value": "", "type": "query" }, { "name": "ui_visible__iew", "value": "", "type": "query" }, { "name": "ui_visible__iregex", "value": "", "type": "query" }, { "name": "ui_visible__isw", "value": "", "type": "query" }, { "name": "ui_visible__n", "value": "", "type": "query", "description": "Specifies whether the custom field is displayed in the UI\n\n* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden" }, { "name": "ui_visible__nic", "value": "", "type": "query" }, { "name": "ui_visible__nie", "value": "", "type": "query" }, { "name": "ui_visible__niew", "value": "", "type": "query" }, { "name": "ui_visible__nisw", "value": "", "type": "query" }, { "name": "ui_visible__regex", "value": "", "type": "query" }, { "name": "unique", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "validation_maximum", "value": "", "type": "query" }, { "name": "validation_maximum__empty", "value": "", "type": "query" }, { "name": "validation_maximum__gt", "value": "", "type": "query" }, { "name": "validation_maximum__gte", "value": "", "type": "query" }, { "name": "validation_maximum__lt", "value": "", "type": "query" }, { "name": "validation_maximum__lte", "value": "", "type": "query" }, { "name": "validation_maximum__n", "value": "", "type": "query" }, { "name": "validation_minimum", "value": "", "type": "query" }, { "name": "validation_minimum__empty", "value": "", "type": "query" }, { "name": "validation_minimum__gt", "value": "", "type": "query" }, { "name": "validation_minimum__gte", "value": "", "type": "query" }, { "name": "validation_minimum__lt", "value": "", "type": "query" }, { "name": "validation_minimum__lte", "value": "", "type": "query" }, { "name": "validation_minimum__n", "value": "", "type": "query" }, { "name": "validation_regex", "value": "", "type": "query" }, { "name": "validation_regex__empty", "value": "", "type": "query" }, { "name": "validation_regex__ic", "value": "", "type": "query" }, { "name": "validation_regex__ie", "value": "", "type": "query" }, { "name": "validation_regex__iew", "value": "", "type": "query" }, { "name": "validation_regex__iregex", "value": "", "type": "query" }, { "name": "validation_regex__isw", "value": "", "type": "query" }, { "name": "validation_regex__n", "value": "", "type": "query" }, { "name": "validation_regex__nic", "value": "", "type": "query" }, { "name": "validation_regex__nie", "value": "", "type": "query" }, { "name": "validation_regex__niew", "value": "", "type": "query" }, { "name": "validation_regex__nisw", "value": "", "type": "query" }, { "name": "validation_regex__regex", "value": "", "type": "query" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of custom field objects." }, { "info": { "name": "extras_custom_fields_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/custom-fields/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of custom field objects." }, { "info": { "name": "extras_custom_fields_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/custom-fields/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of custom field objects." }, { "info": { "name": "extras_custom_fields_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/custom-fields/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of custom field objects." }, { "info": { "name": "extras_custom_fields_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/custom-fields/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of custom field objects." }, { "info": { "name": "extras_custom_fields_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-fields/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a custom field object." }, { "info": { "name": "extras_custom_fields_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/custom-fields/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a custom field object." }, { "info": { "name": "extras_custom_fields_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/custom-fields/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a custom field object." }, { "info": { "name": "extras_custom_fields_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/custom-fields/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom field." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a custom field object." }, { "info": { "name": "extras_custom_links_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-links/", "params": [ { "name": "button_class", "value": "", "type": "query", "description": "The class of the first link in a group will be used for the dropdown button\n\n* `default` - Default\n* `blue` - Blue\n* `indigo` - Indigo\n* `purple` - Purple\n* `pink` - Pink\n* `red` - Red\n* `orange` - Orange\n* `yellow` - Yellow\n* `green` - Green\n* `teal` - Teal\n* `cyan` - Cyan\n* `gray` - Gray\n* `black` - Black\n* `white` - White\n* `ghost-dark` - Link" }, { "name": "button_class__empty", "value": "", "type": "query" }, { "name": "button_class__ic", "value": "", "type": "query" }, { "name": "button_class__ie", "value": "", "type": "query" }, { "name": "button_class__iew", "value": "", "type": "query" }, { "name": "button_class__iregex", "value": "", "type": "query" }, { "name": "button_class__isw", "value": "", "type": "query" }, { "name": "button_class__n", "value": "", "type": "query", "description": "The class of the first link in a group will be used for the dropdown button\n\n* `default` - Default\n* `blue` - Blue\n* `indigo` - Indigo\n* `purple` - Purple\n* `pink` - Pink\n* `red` - Red\n* `orange` - Orange\n* `yellow` - Yellow\n* `green` - Green\n* `teal` - Teal\n* `cyan` - Cyan\n* `gray` - Gray\n* `black` - Black\n* `white` - White\n* `ghost-dark` - Link" }, { "name": "button_class__nic", "value": "", "type": "query" }, { "name": "button_class__nie", "value": "", "type": "query" }, { "name": "button_class__niew", "value": "", "type": "query" }, { "name": "button_class__nisw", "value": "", "type": "query" }, { "name": "button_class__regex", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "group_name", "value": "", "type": "query" }, { "name": "group_name__empty", "value": "", "type": "query" }, { "name": "group_name__ic", "value": "", "type": "query" }, { "name": "group_name__ie", "value": "", "type": "query" }, { "name": "group_name__iew", "value": "", "type": "query" }, { "name": "group_name__iregex", "value": "", "type": "query" }, { "name": "group_name__isw", "value": "", "type": "query" }, { "name": "group_name__n", "value": "", "type": "query" }, { "name": "group_name__nic", "value": "", "type": "query" }, { "name": "group_name__nie", "value": "", "type": "query" }, { "name": "group_name__niew", "value": "", "type": "query" }, { "name": "group_name__nisw", "value": "", "type": "query" }, { "name": "group_name__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "link_text", "value": "", "type": "query" }, { "name": "link_text__ic", "value": "", "type": "query" }, { "name": "link_text__ie", "value": "", "type": "query" }, { "name": "link_text__iew", "value": "", "type": "query" }, { "name": "link_text__iregex", "value": "", "type": "query" }, { "name": "link_text__isw", "value": "", "type": "query" }, { "name": "link_text__n", "value": "", "type": "query" }, { "name": "link_text__nic", "value": "", "type": "query" }, { "name": "link_text__nie", "value": "", "type": "query" }, { "name": "link_text__niew", "value": "", "type": "query" }, { "name": "link_text__nisw", "value": "", "type": "query" }, { "name": "link_text__regex", "value": "", "type": "query" }, { "name": "link_url", "value": "", "type": "query" }, { "name": "link_url__ic", "value": "", "type": "query" }, { "name": "link_url__ie", "value": "", "type": "query" }, { "name": "link_url__iew", "value": "", "type": "query" }, { "name": "link_url__iregex", "value": "", "type": "query" }, { "name": "link_url__isw", "value": "", "type": "query" }, { "name": "link_url__n", "value": "", "type": "query" }, { "name": "link_url__nic", "value": "", "type": "query" }, { "name": "link_url__nie", "value": "", "type": "query" }, { "name": "link_url__niew", "value": "", "type": "query" }, { "name": "link_url__nisw", "value": "", "type": "query" }, { "name": "link_url__regex", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "new_window", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__ic", "value": "", "type": "query" }, { "name": "object_type__ie", "value": "", "type": "query" }, { "name": "object_type__iew", "value": "", "type": "query" }, { "name": "object_type__iregex", "value": "", "type": "query" }, { "name": "object_type__isw", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type__nic", "value": "", "type": "query" }, { "name": "object_type__nie", "value": "", "type": "query" }, { "name": "object_type__niew", "value": "", "type": "query" }, { "name": "object_type__nisw", "value": "", "type": "query" }, { "name": "object_type__regex", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of custom link objects." }, { "info": { "name": "extras_custom_links_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/custom-links/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of custom link objects." }, { "info": { "name": "extras_custom_links_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/custom-links/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of custom link objects." }, { "info": { "name": "extras_custom_links_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/custom-links/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of custom link objects." }, { "info": { "name": "extras_custom_links_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/custom-links/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of custom link objects." }, { "info": { "name": "extras_custom_links_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/custom-links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom link." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a custom link object." }, { "info": { "name": "extras_custom_links_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/custom-links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom link." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a custom link object." }, { "info": { "name": "extras_custom_links_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/custom-links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom link." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a custom link object." }, { "info": { "name": "extras_custom_links_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/custom-links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this custom link." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a custom link object." }, { "info": { "name": "extras_dashboard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/dashboard/", "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of dashboard objects." }, { "info": { "name": "extras_dashboard_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/dashboard/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of dashboard objects." }, { "info": { "name": "extras_dashboard_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/dashboard/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of dashboard objects." }, { "info": { "name": "extras_dashboard_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/dashboard/", "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of dashboard objects." }, { "info": { "name": "extras_event_rules_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/event-rules/", "params": [ { "name": "action_object_id", "value": "", "type": "query" }, { "name": "action_object_id__empty", "value": "", "type": "query" }, { "name": "action_object_id__gt", "value": "", "type": "query" }, { "name": "action_object_id__gte", "value": "", "type": "query" }, { "name": "action_object_id__lt", "value": "", "type": "query" }, { "name": "action_object_id__lte", "value": "", "type": "query" }, { "name": "action_object_id__n", "value": "", "type": "query" }, { "name": "action_object_type", "value": "", "type": "query" }, { "name": "action_object_type__n", "value": "", "type": "query" }, { "name": "action_type", "value": "", "type": "query" }, { "name": "action_type__empty", "value": "", "type": "query" }, { "name": "action_type__ic", "value": "", "type": "query" }, { "name": "action_type__ie", "value": "", "type": "query" }, { "name": "action_type__iew", "value": "", "type": "query" }, { "name": "action_type__iregex", "value": "", "type": "query" }, { "name": "action_type__isw", "value": "", "type": "query" }, { "name": "action_type__n", "value": "", "type": "query" }, { "name": "action_type__nic", "value": "", "type": "query" }, { "name": "action_type__nie", "value": "", "type": "query" }, { "name": "action_type__niew", "value": "", "type": "query" }, { "name": "action_type__nisw", "value": "", "type": "query" }, { "name": "action_type__regex", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "event_type", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__ic", "value": "", "type": "query" }, { "name": "object_type__ie", "value": "", "type": "query" }, { "name": "object_type__iew", "value": "", "type": "query" }, { "name": "object_type__iregex", "value": "", "type": "query" }, { "name": "object_type__isw", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type__nic", "value": "", "type": "query" }, { "name": "object_type__nie", "value": "", "type": "query" }, { "name": "object_type__niew", "value": "", "type": "query" }, { "name": "object_type__nisw", "value": "", "type": "query" }, { "name": "object_type__regex", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of event rule objects." }, { "info": { "name": "extras_event_rules_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/event-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of event rule objects." }, { "info": { "name": "extras_event_rules_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/event-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of event rule objects." }, { "info": { "name": "extras_event_rules_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/event-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of event rule objects." }, { "info": { "name": "extras_event_rules_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/event-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of event rule objects." }, { "info": { "name": "extras_event_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/event-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this event rule." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a event rule object." }, { "info": { "name": "extras_event_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/event-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this event rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a event rule object." }, { "info": { "name": "extras_event_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/event-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this event rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a event rule object." }, { "info": { "name": "extras_event_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/event-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this event rule." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a event rule object." }, { "info": { "name": "extras_export_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/export-templates/", "params": [ { "name": "as_attachment", "value": "", "type": "query" }, { "name": "auto_sync_enabled", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "data_file_id", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_file_id__n", "value": "", "type": "query", "description": "Data file (ID)" }, { "name": "data_source_id", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_source_id__n", "value": "", "type": "query", "description": "Data source (ID)" }, { "name": "data_synced", "value": "", "type": "query" }, { "name": "data_synced__empty", "value": "", "type": "query" }, { "name": "data_synced__gt", "value": "", "type": "query" }, { "name": "data_synced__gte", "value": "", "type": "query" }, { "name": "data_synced__lt", "value": "", "type": "query" }, { "name": "data_synced__lte", "value": "", "type": "query" }, { "name": "data_synced__n", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "file_extension", "value": "", "type": "query" }, { "name": "file_extension__empty", "value": "", "type": "query" }, { "name": "file_extension__ic", "value": "", "type": "query" }, { "name": "file_extension__ie", "value": "", "type": "query" }, { "name": "file_extension__iew", "value": "", "type": "query" }, { "name": "file_extension__iregex", "value": "", "type": "query" }, { "name": "file_extension__isw", "value": "", "type": "query" }, { "name": "file_extension__n", "value": "", "type": "query" }, { "name": "file_extension__nic", "value": "", "type": "query" }, { "name": "file_extension__nie", "value": "", "type": "query" }, { "name": "file_extension__niew", "value": "", "type": "query" }, { "name": "file_extension__nisw", "value": "", "type": "query" }, { "name": "file_extension__regex", "value": "", "type": "query" }, { "name": "file_name", "value": "", "type": "query" }, { "name": "file_name__empty", "value": "", "type": "query" }, { "name": "file_name__ic", "value": "", "type": "query" }, { "name": "file_name__ie", "value": "", "type": "query" }, { "name": "file_name__iew", "value": "", "type": "query" }, { "name": "file_name__iregex", "value": "", "type": "query" }, { "name": "file_name__isw", "value": "", "type": "query" }, { "name": "file_name__n", "value": "", "type": "query" }, { "name": "file_name__nic", "value": "", "type": "query" }, { "name": "file_name__nie", "value": "", "type": "query" }, { "name": "file_name__niew", "value": "", "type": "query" }, { "name": "file_name__nisw", "value": "", "type": "query" }, { "name": "file_name__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "mime_type", "value": "", "type": "query" }, { "name": "mime_type__empty", "value": "", "type": "query" }, { "name": "mime_type__ic", "value": "", "type": "query" }, { "name": "mime_type__ie", "value": "", "type": "query" }, { "name": "mime_type__iew", "value": "", "type": "query" }, { "name": "mime_type__iregex", "value": "", "type": "query" }, { "name": "mime_type__isw", "value": "", "type": "query" }, { "name": "mime_type__n", "value": "", "type": "query" }, { "name": "mime_type__nic", "value": "", "type": "query" }, { "name": "mime_type__nie", "value": "", "type": "query" }, { "name": "mime_type__niew", "value": "", "type": "query" }, { "name": "mime_type__nisw", "value": "", "type": "query" }, { "name": "mime_type__regex", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__ic", "value": "", "type": "query" }, { "name": "object_type__ie", "value": "", "type": "query" }, { "name": "object_type__iew", "value": "", "type": "query" }, { "name": "object_type__iregex", "value": "", "type": "query" }, { "name": "object_type__isw", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type__nic", "value": "", "type": "query" }, { "name": "object_type__nie", "value": "", "type": "query" }, { "name": "object_type__niew", "value": "", "type": "query" }, { "name": "object_type__nisw", "value": "", "type": "query" }, { "name": "object_type__regex", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of export template objects." }, { "info": { "name": "extras_export_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/export-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of export template objects." }, { "info": { "name": "extras_export_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/export-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of export template objects." }, { "info": { "name": "extras_export_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/export-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of export template objects." }, { "info": { "name": "extras_export_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/export-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of export template objects." }, { "info": { "name": "extras_export_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/export-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this export template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a export template object." }, { "info": { "name": "extras_export_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/export-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this export template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a export template object." }, { "info": { "name": "extras_export_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/export-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this export template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a export template object." }, { "info": { "name": "extras_export_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/export-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this export template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a export template object." }, { "info": { "name": "extras_export_templates_sync_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/export-templates/:id/sync/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this export template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any)." }, { "info": { "name": "extras_image_attachments_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/image-attachments/", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "image_height", "value": "", "type": "query" }, { "name": "image_height__empty", "value": "", "type": "query" }, { "name": "image_height__gt", "value": "", "type": "query" }, { "name": "image_height__gte", "value": "", "type": "query" }, { "name": "image_height__lt", "value": "", "type": "query" }, { "name": "image_height__lte", "value": "", "type": "query" }, { "name": "image_height__n", "value": "", "type": "query" }, { "name": "image_width", "value": "", "type": "query" }, { "name": "image_width__empty", "value": "", "type": "query" }, { "name": "image_width__gt", "value": "", "type": "query" }, { "name": "image_width__gte", "value": "", "type": "query" }, { "name": "image_width__lt", "value": "", "type": "query" }, { "name": "image_width__lte", "value": "", "type": "query" }, { "name": "image_width__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_id", "value": "", "type": "query" }, { "name": "object_id__empty", "value": "", "type": "query" }, { "name": "object_id__gt", "value": "", "type": "query" }, { "name": "object_id__gte", "value": "", "type": "query" }, { "name": "object_id__lt", "value": "", "type": "query" }, { "name": "object_id__lte", "value": "", "type": "query" }, { "name": "object_id__n", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of image attachment objects." }, { "info": { "name": "extras_image_attachments_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/image-attachments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of image attachment objects." }, { "info": { "name": "extras_image_attachments_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/image-attachments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of image attachment objects." }, { "info": { "name": "extras_image_attachments_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/image-attachments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of image attachment objects." }, { "info": { "name": "extras_image_attachments_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/image-attachments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of image attachment objects." }, { "info": { "name": "extras_image_attachments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/image-attachments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this image attachment." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a image attachment object." }, { "info": { "name": "extras_image_attachments_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/image-attachments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this image attachment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a image attachment object." }, { "info": { "name": "extras_image_attachments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/image-attachments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this image attachment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a image attachment object." }, { "info": { "name": "extras_image_attachments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/image-attachments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this image attachment." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a image attachment object." }, { "info": { "name": "extras_journal_entries_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/journal-entries/", "params": [ { "name": "assigned_object_id", "value": "", "type": "query" }, { "name": "assigned_object_id__empty", "value": "", "type": "query" }, { "name": "assigned_object_id__gt", "value": "", "type": "query" }, { "name": "assigned_object_id__gte", "value": "", "type": "query" }, { "name": "assigned_object_id__lt", "value": "", "type": "query" }, { "name": "assigned_object_id__lte", "value": "", "type": "query" }, { "name": "assigned_object_id__n", "value": "", "type": "query" }, { "name": "assigned_object_type", "value": "", "type": "query" }, { "name": "assigned_object_type__n", "value": "", "type": "query" }, { "name": "assigned_object_type_id", "value": "", "type": "query" }, { "name": "assigned_object_type_id__n", "value": "", "type": "query" }, { "name": "created_after", "value": "", "type": "query" }, { "name": "created_before", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query", "description": "User (name)" }, { "name": "created_by__n", "value": "", "type": "query", "description": "User (name)" }, { "name": "created_by_id", "value": "", "type": "query", "description": "User (ID)" }, { "name": "created_by_id__n", "value": "", "type": "query", "description": "User (ID)" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "kind", "value": "", "type": "query" }, { "name": "kind__empty", "value": "", "type": "query" }, { "name": "kind__ic", "value": "", "type": "query" }, { "name": "kind__ie", "value": "", "type": "query" }, { "name": "kind__iew", "value": "", "type": "query" }, { "name": "kind__iregex", "value": "", "type": "query" }, { "name": "kind__isw", "value": "", "type": "query" }, { "name": "kind__n", "value": "", "type": "query" }, { "name": "kind__nic", "value": "", "type": "query" }, { "name": "kind__nie", "value": "", "type": "query" }, { "name": "kind__niew", "value": "", "type": "query" }, { "name": "kind__nisw", "value": "", "type": "query" }, { "name": "kind__regex", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of journal entry objects." }, { "info": { "name": "extras_journal_entries_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/journal-entries/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of journal entry objects." }, { "info": { "name": "extras_journal_entries_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/journal-entries/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of journal entry objects." }, { "info": { "name": "extras_journal_entries_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/journal-entries/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of journal entry objects." }, { "info": { "name": "extras_journal_entries_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/journal-entries/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of journal entry objects." }, { "info": { "name": "extras_journal_entries_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/journal-entries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this journal entry." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a journal entry object." }, { "info": { "name": "extras_journal_entries_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/journal-entries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this journal entry." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a journal entry object." }, { "info": { "name": "extras_journal_entries_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/journal-entries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this journal entry." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a journal entry object." }, { "info": { "name": "extras_journal_entries_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/journal-entries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this journal entry." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a journal entry object." }, { "info": { "name": "extras_notification_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/notification-groups/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of notification group objects." }, { "info": { "name": "extras_notification_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/notification-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of notification group objects." }, { "info": { "name": "extras_notification_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/notification-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of notification group objects." }, { "info": { "name": "extras_notification_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/notification-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of notification group objects." }, { "info": { "name": "extras_notification_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/notification-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of notification group objects." }, { "info": { "name": "extras_notification_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/notification-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a notification group object." }, { "info": { "name": "extras_notification_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/notification-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a notification group object." }, { "info": { "name": "extras_notification_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/notification-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a notification group object." }, { "info": { "name": "extras_notification_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/notification-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a notification group object." }, { "info": { "name": "extras_notifications_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/notifications/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of notification objects." }, { "info": { "name": "extras_notifications_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/notifications/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of notification objects." }, { "info": { "name": "extras_notifications_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/notifications/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of notification objects." }, { "info": { "name": "extras_notifications_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/notifications/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of notification objects." }, { "info": { "name": "extras_notifications_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/notifications/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of notification objects." }, { "info": { "name": "extras_notifications_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/notifications/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a notification object." }, { "info": { "name": "extras_notifications_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/notifications/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a notification object." }, { "info": { "name": "extras_notifications_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/notifications/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a notification object." }, { "info": { "name": "extras_notifications_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/notifications/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this notification." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a notification object." }, { "info": { "name": "extras_saved_filters_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/saved-filters/", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__ic", "value": "", "type": "query" }, { "name": "object_type__ie", "value": "", "type": "query" }, { "name": "object_type__iew", "value": "", "type": "query" }, { "name": "object_type__iregex", "value": "", "type": "query" }, { "name": "object_type__isw", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type__nic", "value": "", "type": "query" }, { "name": "object_type__nie", "value": "", "type": "query" }, { "name": "object_type__niew", "value": "", "type": "query" }, { "name": "object_type__nisw", "value": "", "type": "query" }, { "name": "object_type__regex", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "shared", "value": "", "type": "query" }, { "name": "slug", "value": "", "type": "query" }, { "name": "slug__empty", "value": "", "type": "query" }, { "name": "slug__ic", "value": "", "type": "query" }, { "name": "slug__ie", "value": "", "type": "query" }, { "name": "slug__iew", "value": "", "type": "query" }, { "name": "slug__iregex", "value": "", "type": "query" }, { "name": "slug__isw", "value": "", "type": "query" }, { "name": "slug__n", "value": "", "type": "query" }, { "name": "slug__nic", "value": "", "type": "query" }, { "name": "slug__nie", "value": "", "type": "query" }, { "name": "slug__niew", "value": "", "type": "query" }, { "name": "slug__nisw", "value": "", "type": "query" }, { "name": "slug__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "usable", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query", "description": "User (name)" }, { "name": "user__n", "value": "", "type": "query", "description": "User (name)" }, { "name": "user_id", "value": "", "type": "query", "description": "User (ID)" }, { "name": "user_id__n", "value": "", "type": "query", "description": "User (ID)" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of saved filter objects." }, { "info": { "name": "extras_saved_filters_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/saved-filters/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of saved filter objects." }, { "info": { "name": "extras_saved_filters_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/saved-filters/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of saved filter objects." }, { "info": { "name": "extras_saved_filters_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/saved-filters/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of saved filter objects." }, { "info": { "name": "extras_saved_filters_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/saved-filters/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of saved filter objects." }, { "info": { "name": "extras_saved_filters_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/saved-filters/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this saved filter." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a saved filter object." }, { "info": { "name": "extras_saved_filters_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/saved-filters/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this saved filter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a saved filter object." }, { "info": { "name": "extras_saved_filters_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/saved-filters/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this saved filter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a saved filter object." }, { "info": { "name": "extras_saved_filters_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/saved-filters/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this saved filter." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a saved filter object." }, { "info": { "name": "extras_scripts_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/scripts/", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "is_executable", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "module_id", "value": "", "type": "query", "description": "Script module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Script module (ID)" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "q", "value": "", "type": "query", "description": "Search" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of script objects." }, { "info": { "name": "extras_scripts_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/scripts/", "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of script objects." }, { "info": { "name": "extras_scripts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/scripts/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a script object." }, { "info": { "name": "extras_scripts_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/scripts/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a script object." }, { "info": { "name": "extras_scripts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/scripts/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a script object." }, { "info": { "name": "extras_scripts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/scripts/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a script object." }, { "info": { "name": "extras_scripts_upload_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/scripts/upload/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of script module objects." }, { "info": { "name": "extras_subscriptions_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/subscriptions/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of subscription objects." }, { "info": { "name": "extras_subscriptions_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/subscriptions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of subscription objects." }, { "info": { "name": "extras_subscriptions_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/subscriptions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of subscription objects." }, { "info": { "name": "extras_subscriptions_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/subscriptions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of subscription objects." }, { "info": { "name": "extras_subscriptions_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/subscriptions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of subscription objects." }, { "info": { "name": "extras_subscriptions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a subscription object." }, { "info": { "name": "extras_subscriptions_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a subscription object." }, { "info": { "name": "extras_subscriptions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a subscription object." }, { "info": { "name": "extras_subscriptions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a subscription object." }, { "info": { "name": "extras_table_configs_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/table-configs/", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "shared", "value": "", "type": "query" }, { "name": "table", "value": "", "type": "query" }, { "name": "table__empty", "value": "", "type": "query" }, { "name": "table__ic", "value": "", "type": "query" }, { "name": "table__ie", "value": "", "type": "query" }, { "name": "table__iew", "value": "", "type": "query" }, { "name": "table__iregex", "value": "", "type": "query" }, { "name": "table__isw", "value": "", "type": "query" }, { "name": "table__n", "value": "", "type": "query" }, { "name": "table__nic", "value": "", "type": "query" }, { "name": "table__nie", "value": "", "type": "query" }, { "name": "table__niew", "value": "", "type": "query" }, { "name": "table__nisw", "value": "", "type": "query" }, { "name": "table__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "usable", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query", "description": "User (name)" }, { "name": "user__n", "value": "", "type": "query", "description": "User (name)" }, { "name": "user_id", "value": "", "type": "query", "description": "User (ID)" }, { "name": "user_id__n", "value": "", "type": "query", "description": "User (ID)" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of table config objects." }, { "info": { "name": "extras_table_configs_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/table-configs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of table config objects." }, { "info": { "name": "extras_table_configs_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/table-configs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of table config objects." }, { "info": { "name": "extras_table_configs_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/table-configs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of table config objects." }, { "info": { "name": "extras_table_configs_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/table-configs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of table config objects." }, { "info": { "name": "extras_table_configs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/table-configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this table config." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a table config object." }, { "info": { "name": "extras_table_configs_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/table-configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this table config." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a table config object." }, { "info": { "name": "extras_table_configs_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/table-configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this table config." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a table config object." }, { "info": { "name": "extras_table_configs_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/table-configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this table config." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a table config object." }, { "info": { "name": "extras_tagged_objects_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/tagged-objects/", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "object_id", "value": "", "type": "query" }, { "name": "object_id__empty", "value": "", "type": "query" }, { "name": "object_id__gt", "value": "", "type": "query" }, { "name": "object_id__gte", "value": "", "type": "query" }, { "name": "object_id__lt", "value": "", "type": "query" }, { "name": "object_id__lte", "value": "", "type": "query" }, { "name": "object_id__n", "value": "", "type": "query" }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_type__n", "value": "", "type": "query" }, { "name": "object_type_id", "value": "", "type": "query" }, { "name": "object_type_id__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of tagged item objects." }, { "info": { "name": "extras_tagged_objects_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/tagged-objects/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tagged item." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a tagged item object." }, { "info": { "name": "extras_tags_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/tags/", "params": [ { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "value": "", "type": "query" }, { "name": "content_type", "value": "", "type": "query" }, { "name": "content_type_id", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "for_object_type_id", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "object_types", "value": "", "type": "query" }, { "name": "object_types__n", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "slug", "value": "", "type": "query" }, { "name": "slug__empty", "value": "", "type": "query" }, { "name": "slug__ic", "value": "", "type": "query" }, { "name": "slug__ie", "value": "", "type": "query" }, { "name": "slug__iew", "value": "", "type": "query" }, { "name": "slug__iregex", "value": "", "type": "query" }, { "name": "slug__isw", "value": "", "type": "query" }, { "name": "slug__n", "value": "", "type": "query" }, { "name": "slug__nic", "value": "", "type": "query" }, { "name": "slug__nie", "value": "", "type": "query" }, { "name": "slug__niew", "value": "", "type": "query" }, { "name": "slug__nisw", "value": "", "type": "query" }, { "name": "slug__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of tag objects." }, { "info": { "name": "extras_tags_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/tags/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of tag objects." }, { "info": { "name": "extras_tags_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/tags/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of tag objects." }, { "info": { "name": "extras_tags_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/tags/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of tag objects." }, { "info": { "name": "extras_tags_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/tags/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of tag objects." }, { "info": { "name": "extras_tags_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/tags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tag." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a tag object." }, { "info": { "name": "extras_tags_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/tags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tag." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a tag object." }, { "info": { "name": "extras_tags_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/tags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tag." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a tag object." }, { "info": { "name": "extras_tags_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/tags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tag." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a tag object." }, { "info": { "name": "extras_webhooks_list", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/webhooks/", "params": [ { "name": "ca_file_path", "value": "", "type": "query" }, { "name": "ca_file_path__empty", "value": "", "type": "query" }, { "name": "ca_file_path__ic", "value": "", "type": "query" }, { "name": "ca_file_path__ie", "value": "", "type": "query" }, { "name": "ca_file_path__iew", "value": "", "type": "query" }, { "name": "ca_file_path__iregex", "value": "", "type": "query" }, { "name": "ca_file_path__isw", "value": "", "type": "query" }, { "name": "ca_file_path__n", "value": "", "type": "query" }, { "name": "ca_file_path__nic", "value": "", "type": "query" }, { "name": "ca_file_path__nie", "value": "", "type": "query" }, { "name": "ca_file_path__niew", "value": "", "type": "query" }, { "name": "ca_file_path__nisw", "value": "", "type": "query" }, { "name": "ca_file_path__regex", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "http_content_type", "value": "", "type": "query" }, { "name": "http_content_type__empty", "value": "", "type": "query" }, { "name": "http_content_type__ic", "value": "", "type": "query" }, { "name": "http_content_type__ie", "value": "", "type": "query" }, { "name": "http_content_type__iew", "value": "", "type": "query" }, { "name": "http_content_type__iregex", "value": "", "type": "query" }, { "name": "http_content_type__isw", "value": "", "type": "query" }, { "name": "http_content_type__n", "value": "", "type": "query" }, { "name": "http_content_type__nic", "value": "", "type": "query" }, { "name": "http_content_type__nie", "value": "", "type": "query" }, { "name": "http_content_type__niew", "value": "", "type": "query" }, { "name": "http_content_type__nisw", "value": "", "type": "query" }, { "name": "http_content_type__regex", "value": "", "type": "query" }, { "name": "http_method", "value": "", "type": "query" }, { "name": "http_method__empty", "value": "", "type": "query" }, { "name": "http_method__ic", "value": "", "type": "query" }, { "name": "http_method__ie", "value": "", "type": "query" }, { "name": "http_method__iew", "value": "", "type": "query" }, { "name": "http_method__iregex", "value": "", "type": "query" }, { "name": "http_method__isw", "value": "", "type": "query" }, { "name": "http_method__n", "value": "", "type": "query" }, { "name": "http_method__nic", "value": "", "type": "query" }, { "name": "http_method__nie", "value": "", "type": "query" }, { "name": "http_method__niew", "value": "", "type": "query" }, { "name": "http_method__nisw", "value": "", "type": "query" }, { "name": "http_method__regex", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "payload_url", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "secret", "value": "", "type": "query" }, { "name": "secret__empty", "value": "", "type": "query" }, { "name": "secret__ic", "value": "", "type": "query" }, { "name": "secret__ie", "value": "", "type": "query" }, { "name": "secret__iew", "value": "", "type": "query" }, { "name": "secret__iregex", "value": "", "type": "query" }, { "name": "secret__isw", "value": "", "type": "query" }, { "name": "secret__n", "value": "", "type": "query" }, { "name": "secret__nic", "value": "", "type": "query" }, { "name": "secret__nie", "value": "", "type": "query" }, { "name": "secret__niew", "value": "", "type": "query" }, { "name": "secret__nisw", "value": "", "type": "query" }, { "name": "secret__regex", "value": "", "type": "query" }, { "name": "ssl_verification", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of webhook objects." }, { "info": { "name": "extras_webhooks_create", "type": "http" }, "http": { "method": "POST", "url": "/api/extras/webhooks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of webhook objects." }, { "info": { "name": "extras_webhooks_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/webhooks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of webhook objects." }, { "info": { "name": "extras_webhooks_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/webhooks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of webhook objects." }, { "info": { "name": "extras_webhooks_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/webhooks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of webhook objects." }, { "info": { "name": "extras_webhooks_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/extras/webhooks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this webhook." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a webhook object." }, { "info": { "name": "extras_webhooks_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/extras/webhooks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this webhook." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a webhook object." }, { "info": { "name": "extras_webhooks_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/extras/webhooks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this webhook." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a webhook object." }, { "info": { "name": "extras_webhooks_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/extras/webhooks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this webhook." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a webhook object." } ] } ], "bundled": true }