{ "opencollection": "1.0.0", "info": { "name": "NetBox REST authentication-check tenancy API", "version": "4.6.5 (4.6)" }, "items": [ { "info": { "name": "tenancy", "type": "folder" }, "items": [ { "info": { "name": "tenancy_contact_assignments_list", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contact-assignments/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact_id", "value": "", "type": "query", "description": "Contact (ID)" }, { "name": "contact_id__n", "value": "", "type": "query", "description": "Contact (ID)" }, { "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": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "group", "value": "", "type": "query" }, { "name": "group__n", "value": "", "type": "query" }, { "name": "group_id", "value": "", "type": "query" }, { "name": "group_id__n", "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": "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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "priority", "value": "", "type": "query", "description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive" }, { "name": "priority__empty", "value": "", "type": "query" }, { "name": "priority__ic", "value": "", "type": "query" }, { "name": "priority__ie", "value": "", "type": "query" }, { "name": "priority__iew", "value": "", "type": "query" }, { "name": "priority__iregex", "value": "", "type": "query" }, { "name": "priority__isw", "value": "", "type": "query" }, { "name": "priority__n", "value": "", "type": "query", "description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive" }, { "name": "priority__nic", "value": "", "type": "query" }, { "name": "priority__nie", "value": "", "type": "query" }, { "name": "priority__niew", "value": "", "type": "query" }, { "name": "priority__nisw", "value": "", "type": "query" }, { "name": "priority__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "role", "value": "", "type": "query", "description": "Contact role (slug)" }, { "name": "role__n", "value": "", "type": "query", "description": "Contact role (slug)" }, { "name": "role_id", "value": "", "type": "query", "description": "Contact role (ID)" }, { "name": "role_id__n", "value": "", "type": "query", "description": "Contact role (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "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 contact assignment objects." }, { "info": { "name": "tenancy_contact_assignments_create", "type": "http" }, "http": { "method": "POST", "url": "/api/tenancy/contact-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of contact assignment objects." }, { "info": { "name": "tenancy_contact_assignments_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contact-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of contact assignment objects." }, { "info": { "name": "tenancy_contact_assignments_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contact-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of contact assignment objects." }, { "info": { "name": "tenancy_contact_assignments_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contact-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of contact assignment objects." }, { "info": { "name": "tenancy_contact_assignments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contact-assignments/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact assignment." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a contact assignment object." }, { "info": { "name": "tenancy_contact_assignments_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contact-assignments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact assignment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a contact assignment object." }, { "info": { "name": "tenancy_contact_assignments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contact-assignments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact assignment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a contact assignment object." }, { "info": { "name": "tenancy_contact_assignments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contact-assignments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact assignment." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a contact assignment object." }, { "info": { "name": "tenancy_contact_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contact-groups/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact_id", "value": "", "type": "query", "description": "Contact (ID)" }, { "name": "contact_id__n", "value": "", "type": "query", "description": "Contact (ID)" }, { "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": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "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": "parent", "value": "", "type": "query", "description": "Parent contact group (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Parent contact group (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Parent contact group (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent contact group (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": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "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 contact group objects." }, { "info": { "name": "tenancy_contact_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/tenancy/contact-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of contact group objects." }, { "info": { "name": "tenancy_contact_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contact-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of contact group objects." }, { "info": { "name": "tenancy_contact_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contact-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of contact group objects." }, { "info": { "name": "tenancy_contact_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contact-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of contact group objects." }, { "info": { "name": "tenancy_contact_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contact-groups/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact group." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a contact group object." }, { "info": { "name": "tenancy_contact_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contact-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a contact group object." }, { "info": { "name": "tenancy_contact_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contact-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a contact group object." }, { "info": { "name": "tenancy_contact_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contact-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a contact group object." }, { "info": { "name": "tenancy_contact_roles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contact-roles/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "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": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "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": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "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 contact role objects." }, { "info": { "name": "tenancy_contact_roles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/tenancy/contact-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of contact role objects." }, { "info": { "name": "tenancy_contact_roles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contact-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of contact role objects." }, { "info": { "name": "tenancy_contact_roles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contact-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of contact role objects." }, { "info": { "name": "tenancy_contact_roles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contact-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of contact role objects." }, { "info": { "name": "tenancy_contact_roles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contact-roles/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact role." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a contact role object." }, { "info": { "name": "tenancy_contact_roles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contact-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a contact role object." }, { "info": { "name": "tenancy_contact_roles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contact-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a contact role object." }, { "info": { "name": "tenancy_contact_roles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contact-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact role." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a contact role object." }, { "info": { "name": "tenancy_contacts_list", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contacts/", "params": [ { "name": "address", "value": "", "type": "query" }, { "name": "address__empty", "value": "", "type": "query" }, { "name": "address__ic", "value": "", "type": "query" }, { "name": "address__ie", "value": "", "type": "query" }, { "name": "address__iew", "value": "", "type": "query" }, { "name": "address__iregex", "value": "", "type": "query" }, { "name": "address__isw", "value": "", "type": "query" }, { "name": "address__n", "value": "", "type": "query" }, { "name": "address__nic", "value": "", "type": "query" }, { "name": "address__nie", "value": "", "type": "query" }, { "name": "address__niew", "value": "", "type": "query" }, { "name": "address__nisw", "value": "", "type": "query" }, { "name": "address__regex", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "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": "email", "value": "", "type": "query" }, { "name": "email__empty", "value": "", "type": "query" }, { "name": "email__ic", "value": "", "type": "query" }, { "name": "email__ie", "value": "", "type": "query" }, { "name": "email__iew", "value": "", "type": "query" }, { "name": "email__iregex", "value": "", "type": "query" }, { "name": "email__isw", "value": "", "type": "query" }, { "name": "email__n", "value": "", "type": "query" }, { "name": "email__nic", "value": "", "type": "query" }, { "name": "email__nie", "value": "", "type": "query" }, { "name": "email__niew", "value": "", "type": "query" }, { "name": "email__nisw", "value": "", "type": "query" }, { "name": "email__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "group", "value": "", "type": "query" }, { "name": "group__n", "value": "", "type": "query" }, { "name": "group_id", "value": "", "type": "query" }, { "name": "group_id__n", "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", "value": "", "type": "query" }, { "name": "link__empty", "value": "", "type": "query" }, { "name": "link__ic", "value": "", "type": "query" }, { "name": "link__ie", "value": "", "type": "query" }, { "name": "link__iew", "value": "", "type": "query" }, { "name": "link__iregex", "value": "", "type": "query" }, { "name": "link__isw", "value": "", "type": "query" }, { "name": "link__n", "value": "", "type": "query" }, { "name": "link__nic", "value": "", "type": "query" }, { "name": "link__nie", "value": "", "type": "query" }, { "name": "link__niew", "value": "", "type": "query" }, { "name": "link__nisw", "value": "", "type": "query" }, { "name": "link__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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "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": "phone", "value": "", "type": "query" }, { "name": "phone__empty", "value": "", "type": "query" }, { "name": "phone__ic", "value": "", "type": "query" }, { "name": "phone__ie", "value": "", "type": "query" }, { "name": "phone__iew", "value": "", "type": "query" }, { "name": "phone__iregex", "value": "", "type": "query" }, { "name": "phone__isw", "value": "", "type": "query" }, { "name": "phone__n", "value": "", "type": "query" }, { "name": "phone__nic", "value": "", "type": "query" }, { "name": "phone__nie", "value": "", "type": "query" }, { "name": "phone__niew", "value": "", "type": "query" }, { "name": "phone__nisw", "value": "", "type": "query" }, { "name": "phone__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "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": "title", "value": "", "type": "query" }, { "name": "title__empty", "value": "", "type": "query" }, { "name": "title__ic", "value": "", "type": "query" }, { "name": "title__ie", "value": "", "type": "query" }, { "name": "title__iew", "value": "", "type": "query" }, { "name": "title__iregex", "value": "", "type": "query" }, { "name": "title__isw", "value": "", "type": "query" }, { "name": "title__n", "value": "", "type": "query" }, { "name": "title__nic", "value": "", "type": "query" }, { "name": "title__nie", "value": "", "type": "query" }, { "name": "title__niew", "value": "", "type": "query" }, { "name": "title__nisw", "value": "", "type": "query" }, { "name": "title__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of contact objects." }, { "info": { "name": "tenancy_contacts_create", "type": "http" }, "http": { "method": "POST", "url": "/api/tenancy/contacts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of contact objects." }, { "info": { "name": "tenancy_contacts_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contacts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of contact objects." }, { "info": { "name": "tenancy_contacts_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contacts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of contact objects." }, { "info": { "name": "tenancy_contacts_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contacts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of contact objects." }, { "info": { "name": "tenancy_contacts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/contacts/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a contact object." }, { "info": { "name": "tenancy_contacts_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/contacts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a contact object." }, { "info": { "name": "tenancy_contacts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/contacts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a contact object." }, { "info": { "name": "tenancy_contacts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/contacts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this contact." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a contact object." }, { "info": { "name": "tenancy_tenant_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/tenant-groups/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "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": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "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": "parent", "value": "", "type": "query", "description": "Parent tenant group (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Parent tenant group (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Parent tenant group (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent tenant group (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": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "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 tenant group objects." }, { "info": { "name": "tenancy_tenant_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/tenancy/tenant-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of tenant group objects." }, { "info": { "name": "tenancy_tenant_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/tenant-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of tenant group objects." }, { "info": { "name": "tenancy_tenant_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/tenant-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of tenant group objects." }, { "info": { "name": "tenancy_tenant_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/tenant-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of tenant group objects." }, { "info": { "name": "tenancy_tenant_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/tenant-groups/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant group." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a tenant group object." }, { "info": { "name": "tenancy_tenant_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/tenant-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a tenant group object." }, { "info": { "name": "tenancy_tenant_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/tenant-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a tenant group object." }, { "info": { "name": "tenancy_tenant_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/tenant-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a tenant group object." }, { "info": { "name": "tenancy_tenants_list", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/tenants/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact", "value": "", "type": "query", "description": "Contact" }, { "name": "contact__n", "value": "", "type": "query", "description": "Contact" }, { "name": "contact_group", "value": "", "type": "query" }, { "name": "contact_group__n", "value": "", "type": "query" }, { "name": "contact_role", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contact_role__n", "value": "", "type": "query", "description": "Contact Role" }, { "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": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "group", "value": "", "type": "query" }, { "name": "group__n", "value": "", "type": "query" }, { "name": "group_id", "value": "", "type": "query" }, { "name": "group_id__n", "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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "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": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "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 tenant objects." }, { "info": { "name": "tenancy_tenants_create", "type": "http" }, "http": { "method": "POST", "url": "/api/tenancy/tenants/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of tenant objects." }, { "info": { "name": "tenancy_tenants_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/tenants/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of tenant objects." }, { "info": { "name": "tenancy_tenants_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/tenants/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of tenant objects." }, { "info": { "name": "tenancy_tenants_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/tenants/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of tenant objects." }, { "info": { "name": "tenancy_tenants_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/tenancy/tenants/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a tenant object." }, { "info": { "name": "tenancy_tenants_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/tenancy/tenants/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a tenant object." }, { "info": { "name": "tenancy_tenants_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/tenancy/tenants/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a tenant object." }, { "info": { "name": "tenancy_tenants_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/tenancy/tenants/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this tenant." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a tenant object." } ] } ], "bundled": true }